XSdiskline

class sherpa.astro.xspec.XSdiskline(name='diskline')

Bases: sherpa.astro.xspec.XSAdditiveModel

The XSPEC diskline model: accretion disk line emission, relativistic.

The model is described at [1].

Note

Deprecated in Sherpa 4.10.0

The RinM and RoutM parameters have been renamed Rin_M and Rout_M respectively to match the XSPEC definition. The names RinM and RoutM can still be used to access the parameters, but they will be removed in a future release.

LineE

The line energy in keV.

Betor10

The power law dependence of emissivity: see [1] for more details.

Rin_M

The inner radius, in units of GM^2/c.

Rout_M

The outer radius, in units of GM^2/c.

Incl

The inclination, in degrees.

norm

The model normalization in photon/cm^2/s.

References

[1]	(1, 2) https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/XSmodelDiskline.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()