Last modified: December 2019

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/load_xskyconv.html
AHELP for CIAO 4.12 Sherpa v1

load_xskyconv

Context: models

Synopsis

convolution using a relativistic line from axisymmetric accretion disk. XSpec convolution model *Experimental*.

Description

Convolution using as a kernel the relativistic line from an axisymmetic accretion disk. See Dovciak et al. (2004).

xskyconv Parameters

Number Name Description
1 a a/M; BH angular momentum (GM/c)
2 theta_o observer inclination (0 = pole on, degrees)
3 rin inner radius (GM/c^2)
4 ms 0 means integrate from rin, 1 means integrate emission from above the marginally stable orbit only
5 rout outer radius (GM/c^2)
6 alpha accretion disk emissivity scales as r^-alpha for r<rb
7 beta accretion disk emissivity scales as r^-beta for r>rb
8 rb boundary radius between inner and outer emissivity laws (GM/c^2)
9 zshift overall Doppler shift
10 limb 0 means isotropic emission, 1 means Laor's limb darkening (1+0.26\mu), 2 means Haardt's limb brightening (ln{1 + 1/\mu})
11 ne_loc number of grid points in local energy (energy resolution of local flux, the grid is equidistant in logarithmic scale)
12 normal 0 means normalize total flux to unity, +ve value means normalize to unity at the energy given by the parametervalue, -ve value means unnormalized.

Loading the X-Spec convolution models

Please see ahelp xsconvolve for information on how to load the model.

Notes

XSpec version

This information is taken from the XSpec User's Guide. Version 12.10.1n of the XSpec models is supplied with CIAO 4.12.


Example

sherpa> from sherpa_contrib.xspec.xsconvolve import load_xskyconv
sherpa> load_xskyconv("kdb")
sherpa> set_source(kdb(xspowerlaw.pl + xsgaussian.gs))
sherpa> kdb.theta_o = 45

The powerlaw and gaussian components are convolved by the kyconv model, whose inclination angle is set at 45 degrees.


About Contributed Software

This script is not an official part of the CIAO release but is made available as "contributed" software via the CIAO scripts page. Please see this page for installation instructions - such as how to ensure that the parameter file is available.


Bugs

For a list of known bugs and issues with the XSPEC models, please visit the XSPEC bugs page.

See Also

models
list_model_components, list_models, load_xscflux, load_xsclumin, load_xscpflux, load_xsgsmooth, load_xsireflect, load_xskdblur, load_xskdblur2, load_xskerrconv, load_xslsmooth, load_xspartcov, load_xsrdblur, load_xsreflect, load_xsrfxconv, load_xsrgsxsrc, load_xssimpl, load_xsvashift, load_xsvmshift, load_xsxilconv, load_xszashift, load_xszmshift, models, tablemodel, xs, xsconvolve