set_xsxset

Context: modeling

Synopsis

Set a X-Spec model setting.

Syntax

set_xsxset(name: str, value: str)

No return value.

Description

Set variables used by X-Spec models. It is equivalent to the X-Spec `xset` command [1] , but only for setting the model database settings. See `set_xsabund` , `set_xscosmo` , and `set_xsxsect` for the other settings.

Examples

Example 1

>>> set_xsxset('NEIVERS', '2.0')

Example 2

>>> set_xsxset('NEIAPECROOT', '/data/spectral/modelData/APEC_nei_v11')

Example 3

>>> set_xsxset('POW_EMIN', '0.5')
>>> set_xsxset('POW_EMAX', '2.0')

PARAMETERS

The parameters for this function are:

Parameter	Type information	Definition
name	str	The name of the setting. It is converted to upper case before being used. There is no check that the name is valid.
value	str	The new value of the setting. It must be given as a string. If it is the empty string then the name is removed from the model settings.

Notes

The available settings are listed at [1] . Not all the X-Spec model types are supported by Sherpa - for instance X-Spec "mixing models" - so changing some of these settings will make no difference. The X-Spec chatter setting can be increased with `set_xschatter` if it is not clear if a setting is being used.

The model settings are stored so that they can be included in the output of `save_all` .

Setting the name argument to "INITIALIZE" will clear the settings, but this is deprecated and the `clear_xsxset` routine must be used instead.

References

[1] Note that this may refer to a newer version than the compiled version used by Sherpa; use get_xsversion to check.

XSPEC version

CIAO 4.18 comes with support for version 12.14.0k of the XSPEC models. This can be checked with the following:

% python -c 'from sherpa.astro import xspec;
print(xspec.get_xsversion())'
12.14.0k

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.