Last modified: December 2023

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

xstbpcf

Context: models

Synopsis

The XSPEC TBpcf model: ISM grain absorption.

Syntax

xstbpcf

The xstbpcf model is a multiplicative model component.

Description

The model is described at [1] .


Example

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

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

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.nH       thawed            1            0        1e+06      10^22
   mdl.pcf      thawed          0.5            0            1           
   mdl.redshift frozen            0           -1           10           

ATTRIBUTES

The attributes for this object are:

Attribute Definition
nH The equivalent hydrogen column (in units of 10^22 atoms/cm^2).
pcf Partial covering fraction of the absorber.
redshift The redshift of the absorber.

Notes

The `set_xsabund` function changes the relative abundances of the elements, in particular the "wilm" setting.

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
xstbabs, xstbfeo, xstbgas, xstbgrain, xstbrel, xstbvarabs, xsztbabs