XScompmag

class sherpa.astro.xspec.XScompmag(name='compmag')[source] [edit on github]

Bases: sherpa.astro.xspec.XSAdditiveModel

The XSPEC compmag model: Thermal and bulk Comptonization for cylindrical accretion onto the polar cap of a magnetized neutron star.

The model is described at [1].

kTbb

The seed blackbody temperature, in keV.

kTe

The electron temperature of the accretion column, in keV.

tau

The vertical optical depth of the accretion column, with electron cross-section equal to 10^-3 of the Thomson cross-section.

eta

The index of the velocity profile when the accretion velocity increases towards the neutron star (valid when betaflag is 1).

beta0

The terminal velocity of the accreting matter at the neutron star surface (valid when betaflag is 1).

r0

The radius of the accretion column in units of the neutron star Schwarzschild radius.

A

The albedo at the surface of the neutron star.

betaflag

A flag for setting the velocity profile of the accretion column, described at [1]. It has values of 1 or 2 and can not be thawed.

norm

The normalization of the model: see [1] for an explanation of the units.

References

[1](1, 2, 3) https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/XSmodelCompmag.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(cache) 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(cache) [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()