XSgrbcomp¶
-
class
sherpa.astro.xspec.
XSgrbcomp
(name='grbcomp')[source] [edit on github]¶ Bases:
sherpa.astro.xspec.XSAdditiveModel
The XSPEC grbcomp model: Comptonization for GRB prompt emission.
The model is described at 1.
-
kTs
¶ Temperature of the seed blackbody spectrum in keV.
-
gamma
¶ If set to 3 the seed soft spectrum is a blackbody, otherwise it approximates a modified blackbody.
-
kTe
¶ Electron temperature of the subrelativistic outflow in keV.
-
tau
¶ Radial optical depth of the subrelativistic outflow.
-
beta
¶ Bulk outflow velocity of the thermal electrons.
-
fbflag
¶ If set to 0 then only the first-order bulk Comptonization term is considered, otherwise if set to 1 then the second-order term is computed (see 1 for more details).
-
log_A
¶ The geometrical covering factor which determines the relative weights of the seed and comptonized spectra to the total flux.
-
z
¶ Redshift.
-
a_boost
¶ The energy index of the Green’s function with which the formerly comptonization spectrum is convolved.
See also
Notes
This model is only available when used with XSPEC 12.10.0 or later.
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()
-