XSkyconv¶
- class sherpa.astro.xspec.XSkyconv(name='xskyconv')[source] [edit on github]¶
Bases:
sherpa.astro.xspec.XSConvolutionKernel
The XSPEC kyconv convolution model: convolution using a relativistic line from axisymmetric accretion disk
The model is described at 1.
New in version 4.12.2.
- a¶
a/M, the black-hole angular momentum in (GM/c).
- theta_o¶
The observer inclination in degrees (0 is pole on).
- rin¶
The inner radius, in GM/c^2.
- ms¶
Flag: 0 means integrate from rin, 1 means integrate the emission from above the marginally-stable orbit only.
- rout¶
The outer radius, in GM/c^2.
- alpha¶
The accretion disk emissivity scales as r^-alpha for r < rb.
- beta¶
The accretion disk emissivity scales as r^-beta for r > rb.
- rb¶
The boundary radius between inner and outer emissivity laws, in units of GM/c^2.
- zshift¶
The overall Doppler shift.
- limb¶
Flag: 0 means isotropic emission, 1 means Laor’s limb darkening (1 + 0.26 mu), 2 means Haardt’s limb brightening (log(1 + 1 / mu)).
- ne_loc¶
The number of grid points in local energy (energy resolution of local flux, the grid is equidistant in logarithmic scale).
- normal¶
Flag: 0 means normalize total flux to unity, > 0 means normalize to unity at the energy given by the parameter value, and < 0 means unnormalized.
Notes
Unlike XSPEC, the convolution model is applied directly to the model, or models, rather than using the multiplication symbol.
This model is only available when used with XSPEC 12.10.1 or later.
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
(pars, rhs, *args, **kwargs)Evaluate the convolved 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.
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(pars, rhs, *args, **kwargs) [edit on github]¶
Evaluate the convolved model.
Note that this method is not cached by sherpa.models.modelCacher1d (may change in the future).
- Parameters
pars (sequence of numbers) – The parameters of the convolved model. The first npars parameters (where npars is the lenth of the objecs pars attribute) are applied to the convolution model, and the remaining are passed to the rhs model.
rhs (sherpa.models.model.ArithmeticModel) – The model that is being convolved.
*args – The model grid. There should be two arrays (the low and high edges of the bin) to make sure the wrapped model is evaluated correctly.
**kwargs – At present all additional keyword arguments are dropped.
- 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