set_xsabund

Context: modeling

Synopsis

Set the elemental abundances used by X-Spec models.

set_xsabund(abundance: str)

No return value.

Set the abundance table used in the X-Spec plasma emission and photoelectric absorption models. It is equivalent to the X-Spec abund command [1] .

>>> set_xsabund('lodd')
 Solar Abundance Vector set to lodd:  Lodders, K. ApJ 591, 1220 (2003)

>>> set_xsabund('abund.dat')
 Solar Abundance Vector set to file:  User defined abundance vector / no description specified

The parameter for this function is:

Parameter	Type information	Definition
abundance	str	A file name, format described below, or one of the pre-defined names listed in the Notes section below.

The pre-defined abundance tables are:

'aneb', from [2]
'angr', from [3]
'aspl', from [4]
'felc', from [5] (coronal)
'feld', from [6] , except for elements not listed which are given 'grsa' abundances
'grsa', from [7]
'lodd', from [8]
'lpgp', from [9] (photospheric)
'lpgs', from [9] (proto-solar)
'wilm', from [10] , except for elements not listed which are given zero abundance

The values for these tables are given at [1] .

Data files should be in ASCII format, containing a single numeric (floating-point) column of the abundance values, relative to Hydrogen.

The screen output of this function is controlled by the X-Spec chatter setting ( `set_xschatter` ).

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

[5] Feldman, U., Mandelbaum, P., Seely, J.L., Doschek, G.A., Gursky H. (1992, ApJSS, 81, 387)

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

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