get_xsabundances

sherpa.astro.xspec.get_xsabundances(table: str | None = None) → dict[str, float][source] [edit on github]

Return the abundance settings used by X-Spec.

Changed in version 4.17.1: The optional table argument was added.

Added in version 4.17.0.

Parameter

tableoptional

The table to use. Leave as None to use the selected abundance table.

returns:

abundances – The keys are the element names (e.g. ‘Fe’) and the values are the abundances.

rtype:

dict

See also

get_xsabund, set_xsabund, set_xsabundances

Examples

>>> get_xsabundances()
{'H': 1.0, 'He': ...}

>>> set_xsabud("angr")
>>> get_xsabundances()["Cu"]
1.619999956403717e-08
>>> get_xsabundances("felc")["Cu"]
0.0