6.3.6. Ascdump classes

Running an ascdump command to retrieve internal model parameters will return an object with the desired values. On this page, the structure of the object returned for a certain ascdump type is explained. Each section shows the variable names of the parameters such that the numbers can be accessed.

6.3.6.1. PLAS: Basic plasma properties

class pyspex.ascdump.Plas[source]

Output for the command ascdump plas.

Variables
  • t (float) – Electron temperature (keV).

  • elden (float) – Electron density/1E20 (/m**3).

  • hden (float) – Hydrogen density/1E20 (/m**3).

  • ed (float) – Electron/Hydrogen density.

  • pdion (float) – (Electron + Ion)/Hydrogen density.

  • denmas (float) – Mass density / (n_H * m_p).

  • cs (float) – Sound speed (km/s).

get(isect, icomp)[source]

Obtain the plasma parameters from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.2. ABUN: Elemental abundances

class pyspex.ascdump.Abun[source]

Output for the command ascdump abun.

Variables
  • nz (int) – Number of elements.

  • atom (numpy.ndarray) – Atomic number.

  • name (numpy.ndarray) – Element name.

  • relabn (numpy.ndarray) – Abundance in solar units.

  • absabn (numpy.ndarray) – Absolute abundance.

  • charge (numpy.ndarray) – Average charge.

get(isect, icomp)[source]

Obtain the abundance information from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.3. ICON: Ion concentrations

class pyspex.ascdump.Icon[source]

Ascdump output containing the ion concentrations.

Variables
  • nline (int) – Number of entries

  • atom (numpy.ndarray) – Atomic number.

  • ion (numpy.ndarray) – Ionisation stage.

  • name (numpy.ndarray) – Element name.

  • roman (numpy.ndarray) – Ionisation stage (Roman).

  • charge (numpy.ndarray) – Ion charge.

  • conrel (numpy.ndarray) – Relative ion concentration.

  • conabs (numpy.ndarray) – Absolute ion concentration.

get(isect, icomp)[source]

Obtain the ion concentrations from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.4. RATE: Total ionisation, recombination and charge transfer rates

class pyspex.ascdump.Rate[source]

Output for the command ascdump rate.

Variables
  • nline (int) – Number of entries.

  • atom (numpy.ndarray) – Atomic number.

  • ion (numpy.ndarray) – Ionisation stage.

  • name (numpy.ndarray) – Element name.

  • roman – Ionisation stage (Roman).

  • irate (numpy.ndarray) – Ionisation rate.

  • rrate (numpy.ndarray) – Recombination rate.

  • ceirate (numpy.ndarray) – Charge transfer ionisation rate.

  • cerrate (numpy.ndarray) – Charge transfer recombination rate.

get(isect, icomp)[source]

Obtain the rates from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.5. RION: Ionisation rates per atomic subshell

class pyspex.ascdump.Rion[source]

Ionisation rates per subshell.

Variables
  • nline (int) – Number of entries

  • atom (numpy.ndarray) – Atomic number

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • shell (numpy.ndarray) – Shell number

  • shname (numpy.ndarray) – Shell name

  • phion (numpy.ndarray) – Photon ionisation rate (/s/ion)

  • cpion (numpy.ndarray) – Compton ionisation rate (/s/ion)

  • elion (numpy.ndarray) – Electron ionisation rate (/s/ion)

  • phheat (numpy.ndarray) – Photon heating (keV/ion)

  • cpheat (numpy.ndarray) – Compton heating (keV/ion)

  • elcool (numpy.ndarray) – Electron cooling (kev/ion)

get(isect, icomp)[source]

Obtain the ionisation rates per subshell.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.6. POP: Occupation numbers and loss and gain rates

class pyspex.ascdump.Pop[source]

The occupation numbers as well as upwards/downwards loss and gain rates to all quantum levels included.

Variables
  • nlev (int) – Number of levels

  • num (numpy.ndarray) – Level number

  • atom (numpy.ndarray) – Atomic number

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ion charge

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • conf (numpy.ndarray) – Configuration of level

  • ener (numpy.ndarray) – Energy of level (keV)

  • occ (numpy.ndarray) – Population (sum=1)

  • occlte (numpy.ndarray) – Pop/PopLTE

  • cascade (numpy.ndarray) – Cascade (per s)

  • excite (numpy.ndarray) – Excitation (per s)

  • down (numpy.ndarray) – Down loss (per s)

  • up (numpy.ndarray) – Upward loss (per s)

  • arr (numpy.ndarray) – Radiative recombination (per s)

  • adr (numpy.ndarray) – Dielectronic recombination (per s)

  • aii (numpy.ndarray) – Innershell ionisation (per s)

  • cxrr (numpy.ndarray) – Charge exchange (per s)

get(isect, icomp)[source]

Obtain the occupation numbers from SPEX.

6.3.6.7. ELEX: Electron collisional excitation and de-excitation

class pyspex.ascdump.Elex[source]

Output the collisional excitation and de-excitation rates due to collisions with electrons.

Variables
  • nline (int) – Number of transitions.

  • il (numpy.ndarray) – Number of lower level

  • iu (numpy.ndarray) – Number of upper level

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Configuration of lower level

  • au (numpy.ndarray) – Configuration of upper level

  • upsilon (numpy.ndarray) – Upsilon

  • gbar (numpy.ndarray) – Gbar

  • exrate (numpy.ndarray) – Excitation rate (/atom/s)

  • dexrate (numpy.ndarray) – De-excitation rate (/atom/s)

get(isect, icomp)[source]

Obtain the collisional excitation and de-excitation rates due to collisions with electrons from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.8. PREX: Proton collisional excitation and de-excitation

class pyspex.ascdump.Prex[source]

Output the collisional excitation and de-excitation rates due to collisions with protons.

Variables
  • nline (int) – Number of transitions.

  • il (numpy.ndarray) – Number of lower level

  • iu (numpy.ndarray) – Number of upper level

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Configuration of lower level

  • au (numpy.ndarray) – Configuration of upper level

  • exrate (numpy.ndarray) – Excitation rate (/atom/s)

  • dexrate (numpy.ndarray) – De-excitation rate (/atom/s)

get(isect, icomp)[source]

Obtain the collisional excitation and de-excitation rates due to collisions with protons from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.9. RAD: Radiative transition rates for each level

class pyspex.ascdump.Rad[source]

Output the radiative transition rates from each level

Variables
  • nline (int) – Number of transitions.

  • il (numpy.ndarray) – Number of lower level

  • iu (numpy.ndarray) – Number of upper level

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Configuration of lower level

  • au (numpy.ndarray) – Configuration of upper level

  • prob (numpy.ndarray) – Transition probability

get(isect, icomp)[source]

Obtain the radiative transition probablilities from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.10. TWO: Two-photon emission transition rates

class pyspex.ascdump.Two[source]

Output the two-photon emission transition rates from each level.

Variables
  • nline (int) – Number of two-photon transitions.

  • il (numpy.ndarray) – Number of lower level

  • iu (numpy.ndarray) – Number of upper level

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Configuration of lower level

  • au (numpy.ndarray) – Configuration of upper level

  • prob (numpy.ndarray) – Transition probability

get(isect, icomp)[source]

Obtain the two-photon transition probablilities from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.11. TIME: Ionisation/recombination time scale

class pyspex.ascdump.Time[source]

Recombination time scale per ion according to the Bottorf et al. (2000) definition, and relative ion concentrations. Note that the recombination time scale depends upon the hydrogen density, so do not forget to set the relevant density in the model.

Variables
  • nline (int) – Number of two-photon transitions.

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • texp (numpy.ndarray) – Time scale (s)

  • conrel (numpy.ndarray) – Relative concentration

get(isect, icomp)[source]

Obtain the ionisation/recombination time scale for each ion from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.12. REC: Recombination rates per level

class pyspex.ascdump.Rec[source]

Outputs for each atomic level the populating contributions from radiative, dielectronic and charge exchange recombination, as well as inner-shell ionisation.

Variables
  • nline (int) – Number of two-photon transitions.

  • ilev (numpy.ndarray) – Level number.

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • tran (numpy.ndarray) – Transition type

  • arr (numpy.ndarray) – Radiative recombination rate (1E-20m**3/s).

  • adr (numpy.ndarray) – Di-electronic recombination rate (1E-20m**3/s).

  • cxrr – Charge exchange recombination rate (1E-20m**3/s).

  • aii – Inner-shell ionisation rate (1E-20m**3/s).

get(isect, icomp)[source]

Obtain the recombination rates per level from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.13. GRID: Energy and wavelength grid

class pyspex.ascdump.Grid[source]

Output the last used energy/wavelength grid used in the model.

Variables
  • nbin (int) – Number of energy bins.

  • ibin (numpy.ndarray) – Bin number.

  • elow (numpy.ndarray) – Low energy boundary of bin (keV).

  • eupp (numpy.ndarray) – Upper energy boundary of bin (keV).

  • ewidth (numpy.ndarray) – Width of the bin (keV).

  • emean (numpy.ndarray) – Mean energy of the bin (keV).

  • wave (numpy.ndarray) – Wavelength of the bin (Angstrom).

get(isect, icomp)[source]

Obtain the energy grid from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.14. CLIN: Continuum, line and total spectrum

class pyspex.ascdump.Clin[source]

Output the continuum, line and total flux for each energy bin.

Variables
  • nbin (int) – Number of energy bins.

  • ibin (numpy.ndarray) – Bin number.

  • emean (numpy.ndarray) – Mean energy of the bin (keV).

  • fluxcon (numpy.ndarray) – Continuum flux (10^{44} ph/s/keV).

  • fluxlin (numpy.ndarray) – Line flux (10^{44} ph/s/keV).

  • flux (numpy.ndarray) – Total flux (10^{44} ph/s/keV).

get(isect, icomp)[source]

Obtain the continuum, line and total fluxes from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.15. LINE: Line energies, wavelengths and total line emission

class pyspex.ascdump.Line[source]

The line energy and wavelength, as well as the total line emission (photons/s) for each line contributing to the spectrum, for the last plasma layer of the model. Also given is the natural line width and the Doppler broadening (including thermal and turbulent broadening), expressed as a FWHM in keV.

Variables
  • nline (int) – Number of lines in output.

  • id (numpy.ndarray) – Line ID number

  • atom (numpy.ndarray) – Atomic number

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Lower level configuration

  • au (numpy.ndarray) – Upper level configuration

  • ener (numpy.ndarray) – Line energy (keV)

  • wave (numpy.ndarray) – Line wavelength (Ang)

  • flux (numpy.ndarray) – Line strength in photons/s

  • width (numpy.ndarray) – Natural line width (FWHM)

  • dopp (numpy.ndarray) – Doppler line width (FWHM)

  • tau (numpy.ndarray) – Optical depth at line center (calculated)

  • pescl (numpy.ndarray) – Single flight line escape factor (calculated)

  • pescc (numpy.ndarray) – Single flight continuum escape factor (calculated, including Thomson scattering)

  • pesc (numpy.ndarray) – Single flight line escape factor including continuum extinction (calculated)

  • epsilon (numpy.ndarray) – Destruction probability (calculated in newlin)

  • sort (numpy.ndarray) – Sorting array containing the sorted indices.

get(isect, icomp, sort='ener', erange=0.1, 10.0, fluxlim=1e+35)[source]

Obtain the line list from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

  • sort (str) – Column to sort.

  • erange (Tuple) – Energy range for output.

  • fluxlim (float) – Minimum line emissivity to show (in photons/s).

6.3.6.16. EBAL: Energy balance contributions

class pyspex.ascdump.Ebal[source]

Output the energy balance contributions of each layer (only photoionized plasmas). (Heating and cooling in W/m**3)

Variables
  • niter (int) – Number of iterations.

  • icond (float) – I

  • ncedec (float) – CE

  • hden (float) – Hydrogen density (1E20/m**3)

  • elden (float) – Electron density (1E20/m**3)

  • ed (float) – Hydrogen / Electron density

  • t (float) – Electron temperature (keV)

  • dif (float) – Delta

  • heat (float) – Total heating

  • cool (float) – Total cooling

  • heatcom (float) – Heating by Compton scattering

  • heatffa (float) – FF absorption heating

  • heatphi (float) – Photo-electron heating

  • heatcio (float) – Compton ion. heating

  • heataug (float) – Auger electron heating

  • heatdex (float) – Collisional de-excitation heating

  • heatext (float) – External heating

  • coolcom (float) – Compton scattering cooling

  • coolion (float) – Collisional ionisation cooling

  • coolrec (float) – Recombination cooling

  • coolffe (float) – FF emission cooling

  • coolexc (float) – Collisional excitation cooling

  • cooldr (float) – Di-electronic recombination cooling

  • cooladi (float) – Adiabatic cooling

get(isect, icomp)[source]

Obtain the energy balance for each iteration of the model.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.17. CON: Ions contributing to the continuum

class pyspex.ascdump.Con[source]

List of the ions that contribute to the free-free, free-bound and two-photon continuum emission, followed by the free-free, free-bound, two-photon and total continuum spectrum for the last plasma layer of the model.

Variables
  • ff_nion (int) – Number of ions contributing to free-free continuum.

  • ff_atom (numpy.ndarray) – Atomic numbers of ions contributing to free-free continuum.

  • ff_ion (numpy.ndarray) – Ion numbers of ions contributing to free-free continuum.

  • ff_name (numpy.ndarray) – Ion names of ions contributing to free-free continuum.

  • fb_nion (int) – Number of ions contributing to free-bound continuum.

  • fb_atom (numpy.ndarray) – Atomic numbers of ions contributing to free-bound continuum.

  • fb_ion (numpy.ndarray) – Ion numbers of ions contributing to free-bound continuum.

  • fb_name (numpy.ndarray) – Ion names of ions contributing to free-bound continuum.

  • tf_nion (int) – Number of ions contributing to two-photon continuum.

  • tf_atom (numpy.ndarray) – Atomic numbers of ions contributing to two-photon continuum.

  • tf_ion (numpy.ndarray) – Ion numbers of ions contributing to two-photon continuum.

  • tf_name (numpy.ndarray) – Ion names of ions contributing to two-photon continuum.

  • nbin (int) – Number of spectral bins.

  • ener (numpy.ndarray) – Mean energy (keV).

  • ff (numpy.ndarray) – Free-Free continuum (1E44 ph/s/keV).

  • fb (numpy.ndarray) – Free-Bound continuum (1E44 ph/s/keV).

  • tf (numpy.ndarray) – Two-photon continuum (1E44 ph/s/keV).

  • tot (numpy.ndarray) – Total continuum (1E44 ph/s/keV).

get(isect, icomp)[source]

Obtain the continuum contributions from SPEX.

6.3.6.18. TCL: Layer added continuum, line and total spectrum

class pyspex.ascdump.Tcl[source]

Output the continuum, line and total flux for each energy bin summed for all plasma layers of the model.

Variables
  • nbin (int) – Number of energy bins.

  • ibin (numpy.ndarray) – Bin number.

  • emean (numpy.ndarray) – Mean energy of the bin (keV).

  • fluxcon (numpy.ndarray) – Continuum flux (10^{44} ph/s/keV).

  • fluxlin (numpy.ndarray) – Line flux (10^{44} ph/s/keV).

  • flux (numpy.ndarray) – Total flux (10^{44} ph/s/keV).

get(isect, icomp)[source]

Obtain the continuum, line and total fluxes from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.19. TCON: Ions contributing to the continuum (added layers)

class pyspex.ascdump.Tcon[source]

List of the ions that contribute to the free-free, free-bound and two-photon continuum emission, followed by the free-free, free-bound, two-photon and total continuum spectrum added for all plasma layers of the model.

Variables
  • ff_nion (int) – Number of ions contributing to free-free continuum.

  • ff_atom (numpy.ndarray) – Atomic numbers of ions contributing to free-free continuum.

  • ff_ion (numpy.ndarray) – Ion numbers of ions contributing to free-free continuum.

  • ff_name (numpy.ndarray) – Ion names of ions contributing to free-free continuum.

  • ff_layer (numpy.ndarray) – Number of layers in the model

  • fb_nion (int) – Number of ions contributing to free-bound continuum.

  • fb_atom (numpy.ndarray) – Atomic numbers of ions contributing to free-bound continuum.

  • fb_ion (numpy.ndarray) – Ion numbers of ions contributing to free-bound continuum.

  • fb_name (numpy.ndarray) – Ion names of ions contributing to free-bound continuum.

  • fb_layer (numpy.ndarray) – Number of layers in the model

  • tf_nion (int) – Number of ions contributing to two-photon continuum.

  • tf_atom (numpy.ndarray) – Atomic numbers of ions contributing to two-photon continuum.

  • tf_ion (numpy.ndarray) – Ion numbers of ions contributing to two-photon continuum.

  • tf_name (numpy.ndarray) – Ion names of ions contributing to two-photon continuum.

  • tf_layer (numpy.ndarray) – Number of layers in the model

  • nbin (int) – Number of spectral bins.

  • ener (numpy.ndarray) – Mean energy (keV).

  • ff (numpy.ndarray) – Free-Free continuum (1E44 ph/s/keV).

  • fb (numpy.ndarray) – Free-Bound continuum (1E44 ph/s/keV).

  • tf (numpy.ndarray) – Two-photon continuum (1E44 ph/s/keV).

  • tot (numpy.ndarray) – Total continuum (1E44 ph/s/keV).

get(isect, icomp)[source]

Obtain the continuum contributions from SPEX.

6.3.6.20. POP: Level populations

class pyspex.ascdump.Pop[source]

The occupation numbers as well as upwards/downwards loss and gain rates to all quantum levels included.

Variables
  • nlev (int) – Number of levels

  • num (numpy.ndarray) – Level number

  • atom (numpy.ndarray) – Atomic number

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ion charge

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • conf (numpy.ndarray) – Configuration of level

  • ener (numpy.ndarray) – Energy of level (keV)

  • occ (numpy.ndarray) – Population (sum=1)

  • occlte (numpy.ndarray) – Pop/PopLTE

  • cascade (numpy.ndarray) – Cascade (per s)

  • excite (numpy.ndarray) – Excitation (per s)

  • down (numpy.ndarray) – Down loss (per s)

  • up (numpy.ndarray) – Upward loss (per s)

  • arr (numpy.ndarray) – Radiative recombination (per s)

  • adr (numpy.ndarray) – Dielectronic recombination (per s)

  • aii (numpy.ndarray) – Innershell ionisation (per s)

  • cxrr (numpy.ndarray) – Charge exchange (per s)

get(isect, icomp)[source]

Obtain the occupation numbers from SPEX.

6.3.6.21. ELEX: Electron collision excitation and de-excitation

class pyspex.ascdump.Elex[source]

Output the collisional excitation and de-excitation rates due to collisions with electrons.

Variables
  • nline (int) – Number of transitions.

  • il (numpy.ndarray) – Number of lower level

  • iu (numpy.ndarray) – Number of upper level

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Configuration of lower level

  • au (numpy.ndarray) – Configuration of upper level

  • upsilon (numpy.ndarray) – Upsilon

  • gbar (numpy.ndarray) – Gbar

  • exrate (numpy.ndarray) – Excitation rate (/atom/s)

  • dexrate (numpy.ndarray) – De-excitation rate (/atom/s)

get(isect, icomp)[source]

Obtain the collisional excitation and de-excitation rates due to collisions with electrons from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.22. PREX: Proton collision excitation and de-excitation

class pyspex.ascdump.Prex[source]

Output the collisional excitation and de-excitation rates due to collisions with protons.

Variables
  • nline (int) – Number of transitions.

  • il (numpy.ndarray) – Number of lower level

  • iu (numpy.ndarray) – Number of upper level

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Configuration of lower level

  • au (numpy.ndarray) – Configuration of upper level

  • exrate (numpy.ndarray) – Excitation rate (/atom/s)

  • dexrate (numpy.ndarray) – De-excitation rate (/atom/s)

get(isect, icomp)[source]

Obtain the collisional excitation and de-excitation rates due to collisions with protons from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.23. RAD: Radiative transition rates

class pyspex.ascdump.Rad[source]

Output the radiative transition rates from each level

Variables
  • nline (int) – Number of transitions.

  • il (numpy.ndarray) – Number of lower level

  • iu (numpy.ndarray) – Number of upper level

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Configuration of lower level

  • au (numpy.ndarray) – Configuration of upper level

  • prob (numpy.ndarray) – Transition probability

get(isect, icomp)[source]

Obtain the radiative transition probablilities from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.24. TWO: Two-photon emission

class pyspex.ascdump.Two[source]

Output the two-photon emission transition rates from each level.

Variables
  • nline (int) – Number of two-photon transitions.

  • il (numpy.ndarray) – Number of lower level

  • iu (numpy.ndarray) – Number of upper level

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • al (numpy.ndarray) – Configuration of lower level

  • au (numpy.ndarray) – Configuration of upper level

  • prob (numpy.ndarray) – Transition probability

get(isect, icomp)[source]

Obtain the two-photon transition probablilities from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.25. TIME: Recombination timescale per ion

class pyspex.ascdump.Time[source]

Recombination time scale per ion according to the Bottorf et al. (2000) definition, and relative ion concentrations. Note that the recombination time scale depends upon the hydrogen density, so do not forget to set the relevant density in the model.

Variables
  • nline (int) – Number of two-photon transitions.

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • texp (numpy.ndarray) – Time scale (s)

  • conrel (numpy.ndarray) – Relative concentration

get(isect, icomp)[source]

Obtain the ionisation/recombination time scale for each ion from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.26. REC: Recombination and inner-shell ionisation for each level

class pyspex.ascdump.Rec[source]

Outputs for each atomic level the populating contributions from radiative, dielectronic and charge exchange recombination, as well as inner-shell ionisation.

Variables
  • nline (int) – Number of two-photon transitions.

  • ilev (numpy.ndarray) – Level number.

  • atom (numpy.ndarray) – Element number (atomic number)

  • name (numpy.ndarray) – Element name

  • ion (numpy.ndarray) – Ionisation stage

  • roman (numpy.ndarray) – Ionisation stage (Roman)

  • tran (numpy.ndarray) – Transition type

  • arr (numpy.ndarray) – Radiative recombination rate (1E-20m**3/s).

  • adr (numpy.ndarray) – Di-electronic recombination rate (1E-20m**3/s).

  • cxrr – Charge exchange recombination rate (1E-20m**3/s).

  • aii – Inner-shell ionisation rate (1E-20m**3/s).

6.3.6.27. NEI: History of ionisation parameter and temperature

class pyspex.ascdump.Nei[source]

Output the history of ionisation parameter and temperature for NEI models.

Variables
  • nbin (int) – Number of histogram bins.

  • u (numpy.ndarray) – Ionisation parameter (1E20 s/m**3).

  • kt (numpy.ndarray) – Temperature (keV).

get(isect, icomp)[source]

Obtain the history of the ionisation parameter from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.28. HEAT: Plasma heating rates

class pyspex.ascdump.Heat[source]

Plasma heating rates (only for photoionized plasmas).

Variables
  • heat (float) – Total heating

  • heatcom (float) – Heating by Compton scattering

  • heatffa (float) – Heating by free-free absorption

  • heatphi (float) – Heating by photo-electrons

  • heatcio (float) – Heating by Compton ionisation

  • heataug (float) – Heating by Auger electrons

  • heatdex (float) – Heating by collisional de-excitation

  • heatext (float) – Heating by external source

  • cool (float) – Total cooling

  • coolcom (float) – Cooling by inverse Compton scattering

  • coolion (float) – Cooling by electron ionisation

  • coolrec (float) – Cooling by radiative recombination

  • coolffe (float) – Cooling by free-free emission

  • coolexc (float) – Cooling by collisional excitation

  • cooldr (float) – Cooling by dielectronic recombination

  • cooladi (float) – Cooling by adiabatic expansion

get(isect, icomp)[source]

Obtain plasma heating rates from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.29. EBAL: Energy balance calculation

class pyspex.ascdump.Ebal[source]

Output the energy balance contributions of each layer (only photoionized plasmas). (Heating and cooling in W/m**3)

Variables
  • niter (int) – Number of iterations.

  • icond (float) – I

  • ncedec (float) – CE

  • hden (float) – Hydrogen density (1E20/m**3)

  • elden (float) – Electron density (1E20/m**3)

  • ed (float) – Hydrogen / Electron density

  • t (float) – Electron temperature (keV)

  • dif (float) – Delta

  • heat (float) – Total heating

  • cool (float) – Total cooling

  • heatcom (float) – Heating by Compton scattering

  • heatffa (float) – FF absorption heating

  • heatphi (float) – Photo-electron heating

  • heatcio (float) – Compton ion. heating

  • heataug (float) – Auger electron heating

  • heatdex (float) – Collisional de-excitation heating

  • heatext (float) – External heating

  • coolcom (float) – Compton scattering cooling

  • coolion (float) – Collisional ionisation cooling

  • coolrec (float) – Recombination cooling

  • coolffe (float) – FF emission cooling

  • coolexc (float) – Collisional excitation cooling

  • cooldr (float) – Di-electronic recombination cooling

  • cooladi (float) – Adiabatic cooling

get(isect, icomp)[source]

Obtain the energy balance for each iteration of the model.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.30. COL: Ionic column densities

class pyspex.ascdump.Col[source]

Output the ionic column densities.

Variables
  • nline (int) – Number of lines.

  • atom (numpy.ndarray) – Atomic number.

  • ion (numpy.ndarray) – Ionisation stage.

  • name (numpy.ndarray) – Element name.

  • roman (numpy.ndarray) – Ionisation stage (Roman).

  • column (numpy.ndarray) – Column density (1E28/m**2).

  • logcol (numpy.ndarray) – Recombination rate (/m**2).

get(isect, icomp)[source]

Obtain the ionic column denstities from SPEX.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

6.3.6.31. TRAN: Transmission and equivalent width of absorption lines and edges

class pyspex.ascdump.Tran[source]
In two subsequent objects, the transmission and equivalent width of

absorption lines (self.line) and absorption edges (self.edge) are listed for the hot, pion, slab, xabs and warm models.

Variables
  • line (pyspex.ascdump.Tranline) – Object containing the transmission and equivalent widths of the absorption lines.

  • edge (pyspex.ascdump.Tranedge) – Object containing the transmission and equivalent widths of the absorption edges.

get(isect, icomp, sortn='ener')[source]

Obtain the transmission and equivalent width from absorption lines and edges from SPEX. This works for the hot, pion, slab, xabs, and warm models.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

  • sortn (str) – Sort the data based on column: energy (ener), wavelength (wav), ion (ion), line power (powe), natural line width (wid).

6.3.6.31.1. Transmission and equivalent width of absorption lines (only)

class pyspex.ascdump.Tranline[source]

The transmission and equivalent width of absorption lines for the hot, pion, slab, xabs and warm models.

Variables
  • nline (int) – Number of lines

  • id (numpy.ndarray) – Line ID number

  • atom (numpy.ndarray) – Atomic number

  • ion (numpy.ndarray) – Ionisation stage

  • name (numpy.ndarray) – Element name.

  • roman (numpy.ndarray) – Ionisation stage (Roman).

  • ener (numpy.ndarray) – Line energy (keV)

  • ew (numpy.ndarray) – Equivalent width (keV)

  • tau (numpy.ndarray) – Optical depth tau

  • avoigt (numpy.ndarray) – Natural line width

  • sorted (numpy.ndarray) – Sorted index array

get(isect, icomp, sortn='ener')[source]

Obtain the transmission and equivalent width from absorption lines from SPEX. This works for the hot, pion, slab, xabs, and warm models.

Parameters
  • isect (int) – Sector number of the component.

  • icomp (int) – Component number.

  • sortn (str) – Sort the data based on column: energy (ener), wavelength (wav), ion (ion), line power (powe), natural line width (wid).

6.3.6.31.2. Transmission and equivalent width of absorption edges (only)

class pyspex.ascdump.Tranedge[source]

The transmission and equivalent width of absorption edges for the hot, pion, slab, xabs and warm models.

Variables
  • nedge (int) – Number of edges

  • atom (numpy.ndarray) – Atomic number

  • ion (numpy.ndarray) – Ionisation stage

  • shell (numpy.ndarray) – Atomic shell

  • shname (numpy.ndarray) – Shell name

  • name (numpy.ndarray) – Element name.

  • roman (numpy.ndarray) – Ionisation stage (Roman).

  • ener (numpy.ndarray) – Edge energy

  • tau (numpy.ndarray) – Optical depth tau

  • ew (numpy.ndarray) – Equivalent width (keV)

get(isect, icomp)[source]

Obtain the transmission and equivalent width from absorption edges from SPEX. This works for the hot, pion, slab, xabs, and warm models.

6.3.6.32. WARM: Column densities, ionisation parameters and temperatures

class pyspex.ascdump.Warm[source]

Column densities, ionisation parameters and temperatures of the warm model.

Variables
  • nline (int) – Number of lines.

  • atom (numpy.ndarray) – Atomic number.

  • ion (numpy.ndarray) – Ionisation stage.

  • name (numpy.ndarray) – Element name.

  • roman (numpy.ndarray) – Ionisation stage (Roman).

  • xi (numpy.ndarray) – Log Xi (1E-9 Wm).

  • t (numpy.ndarray) – Log T (keV).

  • col (numpy.ndarray) – dN/d ln Xi.

  • nxil (int) – Number of Xi grid points.

  • xilgrid (numpy.ndarray) – Xi (1E-9 Wm).

  • dndlnxi (numpy.ndarray) – dN/d ln Xi

get(isect, icomp)[source]

Obtain the column densities, ionisation parameters and temperatures of the warm model from SPEX.