cie, vcie, vvcie, bcie, bvcie, bbvcie: Emission spectrum from a plasma in Collisional-ionization equilibrium

An emission spectrum from a plasma in collisional-ionizization equilibrium. The switch parameter can be used to change the source of the atomic physics data. Most of the values for this switch are included for historical reasons. Only the AtomDB and SPEX options should be used for modern data. More information can be found about the AtomDB atomic database at http://atomdb.org/ and about SPEX at https://spex-xray.github.io/spex-help/index.html. The default AtomDB version number can be changed by modifying the ATOMDB_VERSION string in your Xspec.init file. At the moment the only SPEX version available is 3.07.

The behaviour of the cie model and all other models which use the underlying code can be changed using a number of options with the xset command.

APECROOT and SPEXROOT
  By default this model reads atomic physics continuum and line data from the files apec_v[version]_coco.fits and apec_v[version]_line.fits or spex_v[version]_coco.fits and spex_v[version]_line.fits in $HEADAS/../spectral/modelData. There are several options to specify different files. For instance, APECROOT can be set to a version number (eg 1.10, 1.2.0, 3.0.3). In this case the value of APECROOT will be used to replace the default version number in the name of the standard files and the resulting files will be assumed to be in the modelData directory. Alternatively, a filename root (eg apec_v1.2.0) can be given. This root will be used as a prefix for the _coco.fits and _line.fits files. Finally, if neither of these work then the model will assume that the APECROOT value gives the complete directory path (eg /foo/bar/apec_v1.2.0 will use the input files /foo/bar/apec_v1.2.0_coco.fits and /foo/bar/apec_v1.2.0_line.fits).
APECTHERMAL and SPEXTHERMAL
  Setting this option to yes thermally broadens lines. This runs significantly slower than the option without thermal broadening so should only be used when necessary.
APECVELOCITY and SPEXVELOCITY
  Setting this option to a number velocity-broadens lines using the given number as the line sigma in km/s. This is added in Gaussian quadrature with any thermal broadening in use.
APECMINFLUX and SPEXMINFLUX
  Setting this option to some flux will ensure that all lines below this flux are not broadened.
APECBROADPSEUDO and SPEXBROADPSEUDO
  Setting this option to yes changes the default behaviour not to broaden the pseudo-continuum (low-flux lines which are not individually stored in the AtomDB and SPEX output files) even if the stronger lines are being broadened.
APECNOLINES and SPEXNOLINES
  Setting this option to yes producesa continuum-only spectrum. This will turn off lines for all models using the AtomDB or SPEX files. Note that a line-free version of a single apec model is available as nlapec.
APEC_TRACE_ABUND and SPEX_TRACE_ABUND
  This option can be used to set the abundances of the trace elements (ie Li, Be, B, F, Na, P, Cl, K, Sc, Ti, V, Cr, Mn, Co, Cu, Zn) when vv variants of models are not being used. These trace element abundances can be set either to the abundance of one of the main elements (give a string argument such as Fe) or to a numerical value (relative to Solar).
APECLOGINTERP and SPEXLOGINTERP
  Setting this option to yes uses logarithmic interpolation between tabulated temperatures.
APECUSENEI
  Setting this option to yes routes the calculation of CEI spectra through the NEI code. This avoids potential problems when interpolating the CEI files on temperature because ion fractions can change quickly with temperature making interpolation less accurate than explicitly calculating the ion fractions for the required temperature (as performed by the NEI code). This option runs about six times slower. It is not currently available for the SPEX switch value.
APECMULTITHREAD and SPEXMULTITHREAD
  Setting this option to yes parallelizes over temperatures for the calculation of the lines in the spectrum. For the basic model, for which only two temperatures are calculated, this does not provide a speed advantage unless line broadening is selected. However, for models which combine multiple temperatures such as cooling flow or NEI models multithreading can provide a significant speed increase.
APECEEBREMSS and SPEXEEBREMSS
  Setting this option to yes includes calculation of the e-e bremsstrahlung.

For the cie model the parameters are:

par1 plasma temperature, keV
par2 Metal abundances (He fixed at that defined by the abund command). The elements included are C, N, O, Ne, Mg, Al, Si, S, Ar, Ca, Fe, Ni. Relative abundances are set by the abund command. The trace element abundances are from xset APEC_TRACE_ABUND, the default is 1.0.
par3 Redshift, z
par4 switch (0 = calculate using mekal, 1 = interpolate using mekal, 2 = use AtomDB data, 3 = use SPEX data)
norm ${10^{-14}\over{4\pi[D_A(1+z)]^2}}\int
n_en_HdV$, where $D_A$ is the angular diameter distance to the source (cm), $dV$ is the volume element (cm$^3$), and $n_e$ and $n_H$ are the electron and H densities (cm$^{-3}$), respectively

For the vcie variant the parameters are as follows.

par1 plasma temperature, keV
par2-par14 Abundances for He, C, N, O, Ne, Mg,Al, Si, S, Ar, Ca, Fe, Ni wrt Solar (defined by the abund command). The trace element abundances are from xset APEC_TRACE_ABUND, the default is 1.0.
par15 redshift, z
par16 switch (0 = calculate using mekal, 1 = interpolate using mekal, 2 = use AtomDB data, 3 = use SPEX data)
norm ${10^{-14}\over{4\pi[D_A(1+z)]^2}}\int
n_en_HdV$, where $D_A$ is the angular diameter distance to the source (cm), $dV$ is the volume element (cm$^3$), and $n_e$ and $n_H$ are the electron and H densities (cm$^{-3}$), respectively

For the vvcie variant the parameters are as follows.

par1 plasma temperature, keV
par2-par31 Abundances for H, He, Li, Be, B, C, N, O, F, Ne, Na, Mg, Al, Si, P, S, Cl, Ar, K, Ca, Sc, Ti, V, Cr, Mn, Fe, Co, Ni, Cu, Zn wrt Solar (defined by the abund command)
Par32 redshift, z
par33 switch (0 = calculate using mekal, 1 = interpolate using mekal, 2 = use AtomDB data, 3 = use SPEX data)
norm ${10^{-14}\over{4\pi[D_A(1+z)]^2}}\int
n_en_HdV$, where $D_A$ is the angular diameter distance to the source (cm), $dV$ is the volume element (cm$^3$), and $n_e$ and $n_H$ are the electron and H densities (cm$^{-3}$), respectively

For the bcie variant the parameters are:

par1 plasma temperature, keV
par2 Metal abundances (He fixed at that defined by the abund command). The elements included are C, N, O, Ne, Mg, Al, Si, S, Ar, Ca, Fe, Ni. Relative abundances are set by the abund command. The trace element abundances are from xset APEC_TRACE_ABUND, the default is 1.0.
par3 Redshift, z
par4 gaussian sigma for velocity broadening (km/s) (switch=2 or 3 only)
par5 switch (0 = calculate using mekal, 1 = interpolate using mekal, 2 = use AtomDB data, 3 = use SPEX data)
norm ${10^{-14}\over{4\pi[D_A(1+z)]^2}}\int
n_en_HdV$, where $D_A$ is the angular diameter distance to the source (cm), $dV$ is the volume element (cm$^3$), and $n_e$ and $n_H$ are the electron and H densities (cm$^{-3}$), respectively

For the bvcie variant the parameters are as follows.

par1 plasma temperature, keV
par2-par14 Abundances for He, C, N, O, Ne, Mg,Al, Si, S, Ar, Ca, Fe, Ni wrt Solar (defined by the abund command). The trace element abundances are from xset APEC_TRACE_ABUND, the default is 1.0.
par15 redshift, z
par16 gaussian sigma for velocity broadening (km/s) (switch=2 or 3 only)
par17 switch (0 = calculate using mekal, 1 = interpolate using mekal, 2 = use AtomDB data, 3 = use SPEX data)
norm ${10^{-14}\over{4\pi[D_A(1+z)]^2}}\int
n_en_HdV$, where $D_A$ is the angular diameter distance to the source (cm), $dV$ is the volume element (cm$^3$), and $n_e$ and $n_H$ are the electron and H densities (cm$^{-3}$), respectively

For the bvvcie variant the parameters are as follows.

par1 plasma temperature, keV
par2-par31 Abundances for H, He, Li, Be, B, C, N, O, F, Ne, Na, Mg, Al, Si, P, S, Cl, Ar, K, Ca, Sc, Ti, V, Cr, Mn, Fe, Co, Ni, Cu, Zn wrt Solar (defined by the abund command)
Par32 redshift, z
par33 gaussian sigma for velocity broadening (km/s) (switch=2 or 3 only)
par34 switch (0 = calculate using mekal, 1 = interpolate using mekal, 2 = use AtomDB data, 3 = use SPEX data)
norm ${10^{-14}\over{4\pi[D_A(1+z)]^2}}\int
n_en_HdV$, where $D_A$ is the angular diameter distance to the source (cm), $dV$ is the volume element (cm$^3$), and $n_e$ and $n_H$ are the electron and H densities (cm$^{-3}$), respectively