XSTBrel¶
-
class
sherpa.astro.xspec.
XSTBrel
(name='tbrel')[source] [edit on github]¶ Bases:
sherpa.astro.xspec.XSMultiplicativeModel
The XSPEC TBrel model: ISM grain absorption.
The model is described at 1.
-
nH
¶ The equivalent hydrogen column (in units of 10^22 atoms/cm^2).
-
He, C, N, O, Ne, Na, Mg, Al, Si, S, Cl, Ar, Ca, Cr, Fe, Co, Ni
The abundance of the element in solar units.
-
H2
¶ - The equivalent molecular hydrogen column (in units of
10^22 atoms/cm^2).
-
rho
¶ The grain density, in g/cm^3.
-
amin
¶ The minimum grain size, in micro-meters.
-
amax
¶ The maximum grain size, in micro-meters.
-
PL
¶ The power-law index of grain sizes.
-
H_dep, He_dep, C_dep, N_dep, O_dep, Ne_dep, Na_dep, Mg_dep, Al_dep,
-
Si_dep, S_dep, Cl_dep, Ar_dep, Ca_dep, Cr_dep, Fe_dep, Co_dep, Ni_dep
The grain depletion fraction of the element.
-
redshift
¶ The redshift of the absorber.
Notes
The set_xsabund function changes the relative abundances of the elements, in particular the “wilm” setting.
This model is only available when used with XSPEC 12.9.1 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()
-