Package chianti :: Module util

Module util

Utility functions, many for reading the CHIANTI database files.

This software is distributed under the terms of the GNU General Public License that is found in the LICENSE file

Functions

between(array, limits)
returns an index array of elements of array where the values lie between the limits given as a 2 element list or tuple

source code

convertName(name)
convert ion name string to Z and Ion

source code

descale_bt(bte, btomega, f, ev1)
descale BT excitation scaling returns [energy,collision strength]

source code

descale_bti(bte, btx, f, ev1)
descale BT ionization scaling returns [energy,cross-section]

source code

diCross(diParams, energy=0, verbose=0)
Calculate the direct ionization cross section.

source code

diCross1(diParams, energy=0, verbose=0)
Calculate the direct ionization cross section.

source code

dilute(radius)
to calculate the dilution factor as a function distance from the center of a star in units of the stellar radius a radius of less than 1.0 (incorrect) results in a dilution factor of 0.

source code

eaCross(diparams, easplom, elvlc, energy=None, verbose=False)
Provide the excitation-autoionization cross section.

source code

eaDescale(easplups, temperature)
Calculates the effective collision strengths (upsilon) for excitation-autoionization as a function of temperature.

source code

el2z(els)
from an the name of the element (1-2 letter) return Z

source code

ion2filename(ions)
convert ion string to generic file name string

source code

listFiles(path)
walks the path and subdirectories to return a list of files

source code

qrp(z, u)
qrp(Z,u) u = E/IP calculate Qr-prime (equ.

source code

scale_bt(evin, omega, f, ev1)
apply BT excitation scaling to (energy, collision strength) returns [bte,btomega]

source code

scale_bti(evin, crossin, f, ev1)
apply BT ionization scaling to (energy, cross-section) returns [bte,btx]

source code

spectroscopic2name(el, roman, dielectronic=False)
convert Z and ion to spectroscopic notation string

source code

splomDescale(splom, energy)
Calculates the collision strength for excitation-autoionization as a function of energy.

source code

z2element(z)
convert Z to element string

source code

zion2dir(z, ion, dielectronic=False, xuvtop=0)
convert Z to generic file name string

source code

zion2filename(z, ion, dielectronic=False, xuvtop=0)
convert Z to generic file name string

source code

zion2localFilename(z, ion, dielectronic=False)
convert Z to generic file name string with current directory at top

source code

zion2name(z, ion, dielectronic=False)
convert Z, ion to generic name 26, 13 -> fe_13

source code

zion2spectroscopic(z, ion, dielectronic=False)
convert Z and ion to spectroscopic notation string

source code

Variables

[hide private]

__package__ = 'chianti'

Function Details

[hide private]

diCross(diParams, energy=0, verbose=0)

source code

Calculate the direct ionization cross section. diParams obtained by util.diRead with the following keys: ['info', 'ysplom', 'xsplom', 'btf', 'ev1', 'ref', 'eaev'] Given as a function of the incident electron energy in eV returns a dictionary - {'energy':energy, 'cross':cross}

diCross1(diParams, energy=0, verbose=0)

source code

eaCross(diparams, easplom, elvlc, energy=None, verbose=False)

source code

Provide the excitation-autoionization cross section.

Energy is given in eV.

eaDescale(easplups, temperature)

source code

Calculates the effective collision strengths (upsilon) for excitation-autoionization as a function of temperature. a duplicate of ion.eaDescale()

qrp(z, u)

source code

qrp(Z,u) u = E/IP calculate Qr-prime (equ. 2.12) of Fontes, Sampson and Zhang 1999

splomDescale(splom, energy)

source code

Calculates the collision strength for excitation-autoionization as a function of energy. energy in eV