XSkerrbb¶
-
class
sherpa.astro.xspec.
XSkerrbb
(name='kerrbb')[source] [edit on github]¶ Bases:
sherpa.astro.xspec.XSAdditiveModel
The XSPEC kerrbb model: multi-temperature blackbody model for thin accretion disk around a Kerr black hole.
The model is described at 1.
-
eta
¶ The ratio of the disk power produced by a torque at the disk inner boundary to the disk power arising from accretion. See 1 for more details.
-
a
¶ The specific angular momentum of the black hole in units of the black hole mass M (when G=c=1). It should be in the range [-1, 1).
-
i
¶ The disk inclination angle, in degrees. A face-on disk has i=0. It must be less than or equal to 85 degrees.
-
Mbh
¶ The mass of the black hole, in solar masses.
-
Dbh
¶ The distance from the observer to the black hole, in units of kpc.
-
rflag
¶ A flag to switch on or off the effect of self irradiation: when greater than zero the self irradition is included, otherwise it is not. This parameter can not be thawed.
-
lflag
¶ A flag to switch on or off the effect of limb darkening: when greater than zero the disk emission is assumed to be limb darkened, otherwise it is isotropic. This parameter can not be thawed.
-
norm
¶ The normalization of the model. It should be fixed to 1 if the inclination, mass, and distance are frozen.
See also
XSgrad
,XSzkerrbb
References
Attributes Summary
The hard maximum values for the thawed parameters.
The hard minimum values for the thawed parameters.
Access to the maximum limits for the thawed parameters
Access to the minimum limits for the thawed parameters
Access to the thawed parameters of the model
Methods Summary
apply
(outer, *otherargs, **otherkwargs)calc
(pars, xlo, *args, **kwargs)Evaluate the model on a grid.
guess
(dep, *args, **kwargs)Set an initial guess for the parameter values.
regrid
(*args, **kwargs)The class RegriddableModel1D allows the user to evaluate in the requested space then interpolate onto the data space.
reset
()Reset the parameter values.
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
-
ndim
= 1¶
-
thawedparhardmaxes
¶ The hard maximum values for the thawed parameters.
-
thawedparhardmins
¶ The hard minimum values for the thawed parameters.
-
thawedparmaxes
¶ Access to the maximum limits for the thawed parameters
-
thawedparmins
¶ Access to the minimum limits for the thawed parameters
-
thawedpars
¶ Access to the thawed parameters of the model
-
version_enabled
= True¶
Methods Documentation
-
apply
(outer, *otherargs, **otherkwargs) [edit on github]¶
-
calc
(pars, xlo, *args, **kwargs) [edit on github]¶ Evaluate the model on a grid.
- Parameters
p (sequence of numbers) – The parameter values to use. The order matches the
pars
field.*args – The model grid. The values can be scalar or arrays, and the number depends on the dimensionality of the model and whether it is being evaluated over an integrated grid or at a point (or points).
-
get_center
() [edit on github]¶
-
guess
(dep, *args, **kwargs) [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
(*args, **kwargs) [edit on github]¶ 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
() [edit on github]¶ Reset the parameter values.
-
set_center
(*args, **kwargs) [edit on github]¶
-
startup
(cache=False) [edit on github]¶ Called before a model may be evaluated multiple times.
- Parameters
cache (bool, optional) – Should a cache be used when evaluating the models.
See also
-
teardown
() [edit on github]¶ Called after a model may be evaluated multiple times.
See also
setup()
-