Synopsis
Return the X-Spec model setting.
Syntax
get_xsxset(name) name - str
Example
>>> set_xsxset("POW_EMIN", "0.5")
>>> get_xsxset("pow_emin")
'0.5'PARAMETERS
The parameter for this function is:
| Parameter | Definition |
|---|---|
| name | The name of the setting (converted to upper case before being sent to X-Spec). There is no check that the name is valid. |
Return value
The return value from this function is:
val -- Returns the value set by a previous call to `set_xsxset` or the empty string, if the value has not been previously set.
Notes
Due to the way X-Spec model settings work, `get_xsxset` will only return a value if it has previously been set with a call to `set_xsxset` . There is no way to retrive the default value of a setting.
XSPEC version
CIAO 4.16 comes with support for version 12.13.1e of the XSPEC models. This can be checked with the following:
% python -c 'from sherpa.astro import xspec; print(xspec.get_xsversion())' 12.13.1e
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- confidence
- set_conf_opt, set_covar_opt, set_proj_opt
- data
- get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_source_plot, set_areascal, set_arf, set_backscal, set_bkg, set_coord, set_counts, set_data, set_dep, set_exposure, set_grouping, set_quality, set_rmf, set_staterror, set_syserror
- filtering
- set_filter
- info
- list_model_ids, show_bkg_model, show_bkg_source
- methods
- set_iter_method, set_iter_method_opt, set_method, set_method_opt
- modeling
- add_model, add_user_pars, clean, create_model_component, delete_bkg_model, delete_model, delete_model_component, get_model, get_model_autoassign_func, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, get_xsabund, get_xscosmo, get_xsxsect, image_model, image_model_component, image_source, image_source_component, integrate, link, load_table_model, load_template_interpolator, load_template_model, load_user_model, normal_sample, reset, save_model, save_source, set_bkg_model, set_bkg_source, set_full_model, set_model, set_model_autoassign_func, set_par, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset, t_sample, uniform_sample
- plotting
- get_cdf_plot, get_pdf_plot, get_pvalue_plot, get_pvalue_results, plot_cdf, plot_model, plot_model_component, plot_pdf, plot_pvalue, plot_scatter, plot_source, plot_source_component, plot_trace
- psfs
- delete_psf, load_conv
- saving
- save_delchi, save_resid
- statistics
- set_prior, set_sampler, set_sampler_opt, set_stat
- utilities
- calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth, set_analysis, set_default_id
- visualization
- contour_model, contour_ratio, contour_resid, image_setregion