XSgnei

class sherpa.astro.xspec.XSgnei(name='gnei')

Bases: sherpa.astro.xspec.XSAdditiveModel

The XSPEC gnei model: collisional plasma, non-equilibrium, temperature evolution.

The model is described at [1]. The set_xsxset and get_xsxset functions are used to set and query the XSPEC XSET parameters, in particular the keyword “NEIVERS”.

Note

Deprecated in Sherpa 4.10.0

The kT_ave parameter has been renamed meanKT to match the XSPEC definition. The name kT_ave can still be used to access the parameter, but this name will be removed in a future release.

kT

The temperature of the plasma, in keV.

Abundanc

The metal abundance of the plasma, as defined by the set_xsabund function.

Tau

The ionization timescale in units of s/cm^3.

meankT

The ionization timescale averaged plasma temperature in keV.

redshift

The redshift of the plasma.

norm

The normalization of the model: see [1] for an explanation of the units.

See also

XSequil, XSnei, XSvgnei, XSvvgnei

References

[1]	(1, 2) https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/XSmodelGnei.html

Attributes Summary

thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars
version_enabled

Methods Summary

apply(outer, *otherargs, **otherkwargs)
calc(pars, xlo, *args, **kwargs)
get_center()
guess(dep, *args, **kwargs)	Set an initial guess for the parameter values.
regrid(*arrays, **kwargs)	The class RegriddableModel1D allows the user to evaluate in the requested space then interpolate onto the data space.
reset()
set_center(*args, **kwargs)
startup(cache)	Called before a model may be evaluated multiple times.
teardown()	Called after a model may be evaluated multiple times.

Attributes Documentation

thawedparhardmaxes

thawedparhardmins

thawedparmaxes

thawedparmins

thawedpars

version_enabled = True

Methods Documentation

apply(outer, *otherargs, **otherkwargs)

calc(pars, xlo, *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.

regrid(*arrays, **kwargs)

The class RegriddableModel1D allows the user to evaluate in the requested space then interpolate onto the data space. An optional argument ‘interp’ enables the user to change the interpolation method.

Examples

>>> import numpy as np
>>> from sherpa.models.basic import Box1D
>>> mybox = Box1D()
>>> request_space = np.arange(1, 10, 0.1)
>>> regrid_model = mybox.regrid(request_space, interp=linear_interp)

reset()

set_center(*args, **kwargs)

startup(cache)

Called before a model may be evaluated multiple times.

See also

teardown()

teardown()

Called after a model may be evaluated multiple times.

See also

setup()