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 and HRcyl parameters have been renamed to tau_y and HovR_cyl respectively to match the XSPEC definition. The names tauy and HRcyl 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.

GMax

The maximum Lorentz factor gamma: see [1] for more details.

kTbb

The temperature of the soft photons, in keV.

tau_y

The vertical optical depth of the corona: see [1] for more details.

geom

The geometry to use; see [1] for more details.

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.

Betor10

The reflection emissivity law: see [1] for more details.

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

[1](1, 2, 3, 4, 5) https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/XSmodelCompps.html

Attributes Summary

thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars
version_enabled

Methods Summary

apply(outer, *otherargs, **otherkwargs)
calc(pars, xlo, *args, **kwargs)
get_center()
guess(dep, *args, **kwargs) Set an initial guess for the parameter values.
regrid(*arrays)
reset()
set_center(*args, **kwargs)
startup() Called before a model may be evaluated multiple times.
teardown() Called after a model may be evaluated multiple times.

Attributes Documentation

thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars
version_enabled = True

Methods Documentation

apply(outer, *otherargs, **otherkwargs) [edit on github]
calc(pars, xlo, *args, **kwargs) [edit on github]
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(*arrays) [edit on github]
reset() [edit on github]
set_center(*args, **kwargs) [edit on github]
startup() [edit on github]

Called before a model may be evaluated multiple times.

See also

teardown()

teardown() [edit on github]

Called after a model may be evaluated multiple times.

See also

setup()