XSbexriv
- class sherpa.astro.xspec.XSbexriv(name='bexriv')[source] [edit on github]
Bases:
XSAdditiveModel
The XSPEC bexriv model: reflected e-folded broken power law, ionized medium.
The model is described at [1].
- Gamma1
The power-law index of the first power-law component.
- breakE
The break energy, in keV.
- Gamma2
The power-law index of the second power-law component.
- foldE
The e-folding energy (Ec) in keV. If zero there is no cut off.
- rel_refl
The reflection scaling parameter (a value of 1 for an isotropic source above the disk).
- redshift
The redshift of the source.
- abund
The abundance of the elements heavier than He relative to their solar abundance, as set by the
set_xsabund
function.
- Fe_abund
The iron abundance relative to the solar abundance, as set by the
set_xsabund
function.
- cosIncl
The cosine of the inclination angle.
- T_disk
The disk temperature in K.
See also
Notes
The precision of the numerical integration can be changed by using the
set_xsxset
function to set the value of the BEXRIV_PRECISION keyword, which defines the fractional precision. The default is 0.01 (1%).References
Attributes Summary
The maximum size of the cache.
A one-dimensional model.
The hard maximum values for the thawed parameters.
The hard minimum values for the thawed parameters.
The maximum limits of the thawed parameters.
The minimum limits of the thawed parameters.
The thawed parameters of the model.
Methods Summary
apply
(outer, *otherargs, **otherkwargs)Clear the cache.
Display the cache status.
calc
(*args, **kwargs)Calculate the model given the parameters and grid.
freeze
()Freeze any thawed parameters of the model.
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.
thaw
()Thaw any frozen parameters of the model.
Attributes Documentation
- cache = 5
The maximum size of the cache.
- ndim = 1
A one-dimensional model.
- thawedparhardmaxes
The hard maximum values for the thawed parameters.
The minimum and maximum range of the parameters can be changed with thawedparmins and thawedparmaxes but only within the range given by thawedparhardmins to thawparhardmaxes.
See also
- thawedparhardmins
The hard minimum values for the thawed parameters.
The minimum and maximum range of the parameters can be changed with thawedparmins and thawedparmaxes but only within the range given by thawedparhardmins to thawparhardmaxes.
See also
- thawedparmaxes
The maximum limits of the thawed parameters.
Get or set the maximum limits of the thawed parameters of the model as a list of numbers. If there are no thawed parameters then [] is used. The ordering matches that of the pars attribute.
See also
thawedpars
,thawedarhardmaxes
,thawedparmins
- thawedparmins
The minimum limits of the thawed parameters.
Get or set the minimum limits of the thawed parameters of the model as a list of numbers. If there are no thawed parameters then [] is used. The ordering matches that of the pars attribute.
See also
thawedpars
,thawedarhardmins
,thawedparmaxes
- thawedpars
The thawed parameters of the model.
Get or set the thawed parameters of the model as a list of numbers. If there are no thawed parameters then [] is used. The ordering matches that of the pars attribute.
See also
- version_enabled = True
Methods Documentation
- apply(outer, *otherargs, **otherkwargs) [edit on github]
- cache_clear() [edit on github]
Clear the cache.
- cache_status() [edit on github]
Display the cache status.
Information on the cache - the number of “hits”, “misses”, and “requests” - is displayed at the INFO logging level.
Example
>>> pl.cache_status() powlaw1d.pl size: 5 hits: 633 misses: 240 check= 873
- calc(*args, **kwargs) [edit on github]
Calculate the model given the parameters and grid.
Notes
XSPEC models must always be evaluated with low and high bin edges. Although supported by the XSPEC model interface the ability to evaluate using an XSPEC-style grid (n+1 values for n bins which we pad with a 0), we do not allow this here since it complicates the handling of the regrid method.
Keyword arguments are ignored.
- freeze() [edit on github]
Freeze any thawed parameters of the model.
- get_center() [edit on github]
- guess(dep, *args, **kwargs)[source] [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.
Restores each parameter to the last value it was set to. This allows the parameters to be easily reset after a fit.
- 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
- thaw() [edit on github]
Thaw any frozen parameters of the model.
Those parameters that are marked as “always frozen” are skipped.