XScompPS¶
- class sherpa.astro.xspec.XScompPS(name='compps')[source] [edit on github]¶
Bases:
sherpa.astro.xspec.XSAdditiveModel
The XSPEC compPS model: Comptonization, Poutanen & Svenson.
The model is described at 1.
Note
Deprecated in Sherpa 4.10.0
The
tauy
andHRcyl
parameters have been renamed totau_y
andHovR_cyl
respectively to match the XSPEC definition. The namestauy
andHRcyl
can still be used to access the parameters, but they will be removed in a future release.- kTe¶
The electron temperature in keV.
- EleIndex¶
The electron power-law index.
- Gmin¶
The minimum Lorentz factor gamma.
- kTbb¶
The temperature of the soft photons, in keV.
- HovR_cyl¶
The value of H/R, when a cylinder geometry is used (abs(geom) = 2).
- cosIncl¶
The cosine of the inclination angle.
- cov_frac¶
The covering fraction of the cold clouds (only used when abs(geom) < 4).
- rel_refl¶
The amount of reflection (Omega / (2 pi))
- Fe_ab_re¶
The iron abundance, in units of solar.
- Me_ab¶
The abundance of heavy elements, in units of solar.
- xi¶
The disk ionization parameter.
- Tdisk¶
The disk temperature for reflection, in K.
- Rin¶
The inner radius of the disk in Schwarzschild units.
- Rout¶
The outer radius of the disk in Schwarzschild units.
- redshift¶
The redshift of the source.
- norm¶
The normalization of the model.
Notes
The precision of the numerical integration can be changed by using the
set_xsxset
function to set the value of the COMPPS_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.
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)Clear the cache.
Display the cache status.
calc
(*args, **kwargs)Calculate the model given the parameters and 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
- cache = 5¶
The maximum size of the cache.
- ndim = 1¶
A one-dimensional model.
- 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]¶
- 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.
- 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