Last modified: December 2018

URL: http://cxc.harvard.edu/sherpa/ahelp/xsvoigt.html
AHELP for CIAO 4.11 Sherpa v1

xsvoigt

Context: models

Synopsis

The XSPEC voigt model: Voigt line profile.

Syntax

xsvoigt

The xsvoigt model is an additive model component.

Description

The model is described at [1] .


Example

>>> create_model_component("xsvoigt", "mdl")
>>> print(mdl)

Create a component of the xsvoigt model and display its default parameters. The output is:

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.LineE    thawed          6.5            0        1e+06        keV
   mdl.Sigma    thawed         0.01            0           10        keV
   mdl.Gamma    thawed         0.01            0           10        keV
   mdl.norm     thawed            1            0        1e+24           

ATTRIBUTES

The attributes for this object are:

LineE

The line energy, in keV.

Sigma

The gaussian line width, in keV.

Gamma

The lorentzian FWHM line width, in keV.

norm

The flux in the line, in units of photon/cm^2/s.

References

XSPEC version

CIAO 4.11 comes with support for version 12.10.0e of the XSPEC models. This can be checked with the following:

% python -c 'from sherpa.astro import xspec;
print(xspec.get_xsversion())'
12.10.0e

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

models
xslorentz