Last modified: December 2024

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

xsbcie

Context: models

Synopsis

The XSPEC bcie model: Emission spectrum from a plasma in Collisional-ionization equilibrium.

Syntax

xsbcie

The xsbcie model is an additive model component.

Description

The model is described at [1] . Note that set_xsxset should be used to change the XSET settings.


Example

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

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

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.kT       thawed            1        0.008           64        keV
   mdl.Abundanc frozen            1            0            5           
   mdl.Redshift frozen            0       -0.999           10           
   mdl.Velocity frozen            0            0        10000       km/s
   mdl.switch   frozen            2            0            3           
   mdl.norm     thawed            1            0        1e+24           

PARAMETERS

The parameters for this function are:

Parameter Definition
kT The plasma temperature in keV.
Abundanc The metal abundances (He fixed at that defined by the set_xsabund command). The elements included are C, N, O, Ne, Mg, Al, Si, S, Ar, Ca, Fe, and Ni. Relative abundances are set by set_xsabund ). The trace element abundaces are controlled by the "APEC_TRACE_ABUND" setting and default to 1.0.
Redshift The redshift of the plasma.
Velocity The gaussian sigma for the velocity broadening (in km/s) which is only used when switch > 1.
switch If 0, the mekal code is run to evaluate the model; if 1 then interpolation of the mekal data is used; if 2 then interpolation of APEC data is used; if 3 then SPEX data. See [1] for more details. This parameter can not be thawed.
norm The normalization of the model. See [1] for more details.

References

Changes in CIAO

Added in CIAO 4.17

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.

See Also

models
xsbvcie, xsbvvcie, xscie