XSkerrd

class sherpa.astro.xspec.XSkerrd(name='kerrd')

Bases: sherpa.astro.xspec.XSAdditiveModel

The XSPEC kerrd model: optically thick accretion disk around a Kerr black hole.

The model is described at [1].

Note

Deprecated in Sherpa 4.10.0

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

distance

The distance, in units of kpc.

TcoloTeff

The spectral hardening factor, Tcol/Teff. See [1] for more details.

M

The mass of the central object, in solar masses.

Mdot

The mass accretion rate in units of 10^18 g/s.

Incl

The disk inclination angle, in degrees. A face-on disk has Incl=0.

Rin

The inner radius, in units of GM/c^2. The last stable orbit is 1.235.

Rout

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

norm

The normalization of the model. It should be fixed to 1.

See also

XSlaor

References

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