The sherpa.astro.xspec module

Support for XSPEC models.

Sherpa supports versions 12.9.0 and 12.9.1 of XSPEC [1], and can be built against the model library or the full application. There is no guarantee of support for older or newer versions of XSPEC.

To be able to use most routines from this module, the HEADAS environment variable must be set. The get_xsversion function can be used to return the XSPEC version - including patch level - the module is using:

>>> from sherpa.astro import xspec
>>> xspec.get_xsversion()
'12.9.1p'

References

[1]	https://heasarc.gsfc.nasa.gov/docs/xanadu/xspec/index.html

Warning

Fix the functions which end up with a MagickMock docstring, such as sherpa.astro.xspec.get_xsversion().

This document describes the base classes for XSPEC models, and the utility routines - such as querying and retrieving the abundance table information. The models provided by XSPEC are described in The sherpa.astro.xspec module.

Classes

XSModel(name[, pars])	The base class for XSPEC models.
XSAdditiveModel(name[, pars])	The base class for XSPEC additive models.
XSMultiplicativeModel(name[, pars])	The base class for XSPEC multiplicative models.
XSTableModel(filename[, name, parnames, ...])	Interface to XSPEC table models.

Functions

get_xsabund	Need to override get_xsversion to return a “useful” string
get_xschatter	Need to override get_xsversion to return a “useful” string
get_xscosmo	Need to override get_xsversion to return a “useful” string
get_xspath_manager	Need to override get_xsversion to return a “useful” string
get_xspath_model	Need to override get_xsversion to return a “useful” string
get_xsstate()	Return the state of the XSPEC module.
get_xsversion
get_xsxsect	Need to override get_xsversion to return a “useful” string
get_xsxset(name)	Return the X-Spec model setting.
read_xstable_model(modelname, filename)	Create a XSPEC table model.
set_xsabund	Need to override get_xsversion to return a “useful” string
set_xschatter	Need to override get_xsversion to return a “useful” string
set_xscosmo	Need to override get_xsversion to return a “useful” string
set_xspath_manager(path)	Set the path to the files describing the XSPEC models.
set_xsstate(state)	Restore the state of the XSPEC module.
set_xsxsect	Need to override get_xsversion to return a “useful” string
set_xsxset(name, value)	Set a X-Spec model setting.

Class Inheritance Diagram