Last modified: December 2024

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/xsgabs.html
AHELP for CIAO 4.17 Sherpa

xsgabs

Context: models

Synopsis

The XSPEC gabs model: gaussian absorption line.

Syntax

xsgabs

The xsgabs model is a multiplicative model component.

Description

The model is described at [1] .

Deprecated in Sherpa 4.10.0

The tau parameter has been renamed strength to match the XSPEC definition. The name tau can still be used to access the parameter, but this name will be removed in a future release.


Example

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

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

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.LineE    thawed            1            0        1e+06        keV
   mdl.Sigma    thawed         0.01            0           20        keV
   mdl.Strength thawed            1            0        1e+06        keV

ATTRIBUTES

The attributes for this object are:

Attribute Definition
LineE The line energy, in keV.
Sigma The line width (sigma), in keV.
Strength The line depth, in keV. The optical depth at the line center is Strength / (sqrt(2 pi) * Sigma).

References

XSPEC version

CIAO 4.17 comes with support for version 12.14.0k of the XSPEC models. This can be checked with the following:

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

Bugs

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