set_xsxset

Synopsis

Set environment variables for XSPEC models

set_xsxset(var_name, var_value)
get_xsxset(var_name)

Description

The set_xsxset() command is associated with the XSPEC XSET command for defining XSPEC model environment variables. The required string arguments for set_xsxset() are a model environment variable name and an associated value to which it should be set. The get_xsxset() command returns the current value setting for the specified model variable.

The list of current variable name options, models to which they apply, and brief descriptions of each are given in the table found on the 'xset' help page in the XSPEC documentation.

XSpec version

This information is taken from the XSpec User's Guide. Version 12.7.1 of the XSpec models is supplied with CIAO 4.4.1.

Example 1

sherpa> set_xsxset("NEIVERS", "2.0")
sherpa> set_xsxset("NEIAPECROOT", "/home/user/apec")
sherpa> set_model(xsvnei.nn)
sherpa> get_xsxset("NEIAPECROOT")
'/home/user/apec'

Set the NEIVERS model variable to a value of 2.0, and switch the NEIAPECROOT variable from the default NEIAPEC file to a user input file. Return the current value set for the NEIAPECROOT variable to check that it was correctly set.

Example 2

sherpa> set_model(xsapec.a1)
sherpa> set_xsxset("APECROOT", "1.2.0")

Set the APECROOT model variable to 1.2.0 so that the XSpec Apec model components use this version of the AtomDB atomic database whenever they are evaluated, e.g. in fitting, error analysis, calculating statistics or plotting.

Bugs

For a list of known bugs and issues with the XSPEC models, please visit the XSPEC bugs page.

See Also

confidence

set_conf_opt, set_covar_opt, set_proj_opt

data

get_bkg_plot, set_areascal, set_arf, set_backscal, set_bkg, set_coord, set_counts, set_data, 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_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, image_model, image_model_component, image_source, image_source_component, integrate, integrate1d, link, load_table_model, load_template_model, load_user_model, normal_sample, reset, save_model, save_source, set_bkg_model, set_full_model, set_model_autoassign_func, set_par, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, t_sample, uniform_sample

plotting

get_lrt_plot, get_lrt_results, get_pvalue_plot, get_pvalue_results, plot_cdf, plot_lrt, 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, get_ratio, get_resid, image_setregion