XSTableModel

class sherpa.astro.xspec.XSTableModel(filename, name='xstbl', parnames=(), initvals=(), delta=(), mins=(), maxes=(), hardmins=(), hardmaxes=(), nint=0, addmodel=False, addredshift=False)

Bases: sherpa.astro.xspec.XSModel

Interface to XSPEC table models.

XSPEC supports loading in user-supplied data files for use as a table model [1]. This class provides a low-level way to access this functionality. A simpler interface is provided by read_xstable_model and sherpa.astro.ui.load_xstable_model.

Parameters:

• filename (str) – The name of the FITS file containing the data for the XSPEC table model; the format is described in [2].
• name (str) – The name to use for the instance of the table model.
• parnames (sequence) – The parameter names. This corresponds to the “NAME” column from the “PARAMETER” block of the input file. Any invalid characters in each name will be replaced by the ‘_’ character.
• initvals (sequence) – The initial values for each parameter. This corresponds to the “INITIAL” column from the “PARAMETER” block of the input file.
• delta (sequence) – The delta value for each parameter. This corresponds to the “DELTA” column from the “PARAMETER” block of the input file.
• maxes, hardmins, hardmaxes (mins,) – The valid range of each parameter. These correspond to the “BOTTOM”, “TOP”, “MINIMUM”, and “MAXIMUM” columns from the “PARAMETER” block of the input file.
• nint (int) – The first nint parameters are marked as thawed by default, the remaining default to frozen.
• addmodel (bool) – Is this an additive model (True) or multiplicative model (False)? It should be set to the value of the “ADDMODEL” keyword of the primary header of the input file.
• addredshift (bool) – If True then a redshift parameter is added to the parameters. It should be set to the value of the “REDSHIFT” keyword of the primary header of the input file.

References

[1]	https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/XSappendixLocal.html

[2]	http://heasarc.gsfc.nasa.gov/docs/heasarc/ofwg/docs/general/ogip_92_009/ogip_92_009.html

Attributes Summary

thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars
version_enabled

Methods Summary

apply(outer, \*otherargs, \*\*otherkwargs)
calc(pars, xlo, \*args, \*\*kwargs)
fold(\*args, \*\*kwargs)
get_center()
guess(dep, \*args, \*\*kwargs)	Set an initial guess for the parameter values.
reset()
set_center(\*args, \*\*kwargs)
startup()
teardown()

Attributes Documentation

thawedparhardmaxes

thawedparhardmins

thawedparmaxes

thawedparmins

thawedpars

version_enabled = True

Methods Documentation

apply(outer, *otherargs, **otherkwargs)

calc(pars, xlo, *args, **kwargs)

fold(*args, **kwargs)

get_center()

guess(dep, *args, **kwargs)

Set an initial guess for the parameter values.

Attempt to set the parameter values, and ranges, for the model to match the data values. This is intended as a rough guess, so it is expected that the model is only evaluated a small number of times, if at all.

reset()

set_center(*args, **kwargs)

startup()

teardown()