Last modified: December 2023

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

xszvarabs

Context: models

Synopsis

The XSPEC zvarabs model: photoelectric absorption.

Syntax

xszvarabs

The xszvarabs model is a multiplicative model component.

Description

The model is described at [1] .


Example

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

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

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.H        frozen            1            0        10000       sH22
   mdl.He       frozen            1            0        10000      sHe22
   mdl.C        frozen            1            0        10000       sC22
   mdl.N        frozen            1            0        10000       sN22
   mdl.O        frozen            1            0        10000       sO22
   mdl.Ne       frozen            1            0        10000      sNe22
   mdl.Na       frozen            1            0        10000      sNa22
   mdl.Mg       frozen            1            0        10000      sMg22
   mdl.Al       frozen            1            0        10000      sAl22
   mdl.Si       frozen            1            0        10000      sSi22
   mdl.S        frozen            1            0        10000       sS22
   mdl.Cl       frozen            1            0        10000      sCl22
   mdl.Ar       frozen            1            0        10000      sAr22
   mdl.Ca       frozen            1            0        10000      sCa22
   mdl.Cr       frozen            1            0        10000      sCr22
   mdl.Fe       frozen            1            0        10000      sFe22
   mdl.Co       frozen            1            0        10000      sCo22
   mdl.Ni       frozen            1            0        10000      sNi22
   mdl.redshift frozen            0       -0.999           10           

ATTRIBUTES

The attributes for this object are:

Attribute Definition
H, He, C, N, O, Ne, Na, Mg, Al, Si, S, Cl, Ar, Ca, Cr, Fe, Co, Ni See [1] for a description of the units.
redshift The redshift of the absorber

Notes

The `set_xsxsect` function changes the cross sections used by this model. The `set_xsabund` function changes the relative abundances of the elements.

References

XSPEC version

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

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

Bugs

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

See Also

models
xsvarabs