XSlorentz

class sherpa.astro.xspec.XSlorentz(name='lorentz')[source] [edit on github]

Bases: sherpa.astro.xspec.XSAdditiveModel

The XSPEC lorentz model: lorentz line profile.

The model is described at [1].

LineE

The line energy, in keV.

Width

The FWHM of the line, in keV.

norm

The flux in the line, in units of photon/cm^2/s.

See also

XSgaussian, XSvoigt

References

[1]https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/XSmodelLorentz.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)
reset()
set_center(*args, **kwargs)
startup() 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) [edit on github]
calc(pars, xlo, *args, **kwargs) [edit on github]
get_center() [edit on github]
guess(dep, *args, **kwargs)[source] [edit on github]

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) [edit on github]
reset() [edit on github]
set_center(*args, **kwargs) [edit on github]
startup() [edit on github]

Called before a model may be evaluated multiple times.

See also

teardown()

teardown() [edit on github]

Called after a model may be evaluated multiple times.

See also

setup()