This page was created by the IDL library routine
mk_html_help. For more information on
this routine, refer to the IDL Online Help Navigator
or type:
? mk_html_help
at the IDL command line prompt.
Last modified: Tue Jan 4 12:52:37 2011.
PROJECT: CHIANTI
CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
Astrophysical Plasmas. It is a collaborative project involving the Naval
Research Laboratory (USA), the University of Florence (Italy), the
University of Cambridge and the Rutherford Appleton Laboratory (UK).
NAME:
READ_ABUND
PURPOSE:
to read CHIANTI abundance files
CATEGORY:
science.
CALLING SEQUENCE:
READ_ABUND,File,Abundance,Reference
INPUTS:
File: the name (string) of the file containing the abundance values
(relative to hydrogen) usually of the form
'!xuvtop/abundance/*.abund'
OUTPUTS:
Abundance: an array of abuncance values
Reference: a string containing the reference to the chosen set
of abundances in the scientific literature
PROCEDURE:
You can describe the foobar superfloatation method being used here.
EXAMPLE:
> read_abund,'allen.abund',abundance,ref
abundance(26) = abundance of iron relative to hydrogen
quoted by C.W. Allen in Astrophysical Quantities
MODIFICATION HISTORY:
Written by: Ken Dere
March 1996: Version 2.0
V. 3, 21-May-2002, Giulio Del Zanna (GDZ)
generalized directory concatenation to work for
Unix, Windows and VMS.
VERSION : 3, 21-May-2002
(See read/read_abund.pro)
PROJECT: CHIANTI
CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
Astrophysical Plasmas. It is a collaborative project involving the Naval
Research Laboratory (USA), the University of Florence (Italy), the
University of Cambridge and the Rutherford Appleton Laboratory (UK).
NAME:
READ_DEM
PURPOSE:
to read values the differential emission measure as a function
of temperature
CATEGORY:
science.
CALLING SEQUENCE:
READ_DEM, File, T, Dem, Ref
INPUTS:
File: the name of the file containing the DEM values, usually in
!xuvtop/dem/*.dem
OUTPUTS:
T: Log10 values of temperature (K)
Dem: Log10 values of the differential emission measure
Ref: the reference to the DEM values in the scientific literature
OPTIONAL OUTPUTS:
Describe optional outputs here. If the routine doesn't have any,
just delete this section.
EXAMPLE:
> read_dem,!xuvtop+'/dem/active_region.dem',t,dem,ref
MODIFICATION HISTORY:
Written by: Ken Dere
March 1996: Version 2.0
V. 3, 21-May-2002, Giulio Del Zanna (GDZ)
generalized directory concatenation to work for
Unix, Windows and VMS.
Ver.4, 20-Nov-2002, Peter Young
DEM values of -1 caused errors, so this has been corrected.
VERSION : 4, 20-Nov-2002
(See read/read_dem.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
astrophysical emission line spectra. It is a collaborative project
involving Ken Dere (Naval Research Laboratory, Washington DC),
Brunella Monsignori-Fossi and Enrico Landi (Arcetri Observatory,
Florence), and Helen Mason and Peter Young (DAMTP, Cambridge Univ.).
NAME:
READ_ELVLC
PURPOSE:
to read files containing observed and theoretical energy levels
CATEGORY:
science.
CALLING SEQUENCE:
READ_ELVLC, File, L1, Term, Conf, ss, ll, jj, Ecm, Eryd, Ecmth, Erydth, Ref
INPUTS:
File: the name of the file
i.e., !xuvtop+'/si/si_12/si_12.elvlc' for Si XII
OPTIONAL INPUTS:
None:
OUTPUTS: L1 - level index
Term - configuration index
Conf - configuration description
ss - 2S+1
ll - L
jj - J
Ecm - observed energy (cm^-1)
Eryd - observed energy (Rydbergs)
Ecmth - theoretical energy (cm^-1)
Erydth - theoretical energy (Rydbergs)
Ref - reference
note: the theoretical energies are usually those used in the scattering
calculation and are only useful for predicting approximate
wavelengths
EXAMPLE:
> file = !xuvtop+'/si/si_12/si_12.elvlc'
> read_elvlc,file,l1,term,conf,ss,ll,jj,ecm,eryd,ref
>
MODIFICATION HISTORY:
Written by: Ken Dere
March 1996: Version 2.0
Ver.2, 6-Dec-2001, Peter Young
Modified the form of the "term" output. The J-value is now
represented by a fraction rather than a decimal.
(See read/read_elvlc.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
continuum and emission line spectra from astrophysical plasmas. It is a
collaborative project involving the Naval Research Laboratory
(Washington DC, USA), the Arcetri Observatory (Firenze, Italy), and the
Cambridge University (United Kingdom).
NAME:
READ_ELVLC_DIRECT
PURPOSE:
to read files containing observed energy levels
does not reformat some variables like READ_ELVL
CATEGORY:
science.
CALLING SEQUENCE:
READ_ELVLC_DIRECT, File, L1, Term, Conf, ss, ll, spd, jj, Ecm, Eryd, Ecmth, Erydth, Ref
INPUTS:
File: the name of the file
i.e., !xuvtop+'/si/si_12/si_12.elvl' for Si XII
OPTIONAL INPUTS:
None:
OUTPUTS: L1 - level index
Term - configuration index
Conf - configuration description
ss - 2S+1
ll - L
spd - 'S', 'P', etc to denote L value
jj - J
Mult - multiplicity 2J+1
Ecm - energy (cm^-1)
Eryd - energy (Rydbergs)
Ecmth - energy (cm^-1)
Erydth- energy (Rydbergs)
Ref - reference
EXAMPLE:
> file = !xuvtop+'/si/si_12/si_12.elvl'
> read_elvlc_direct,file,l1,term,conf,ss,ll,jj,ecm,eryd,ecmth,erydth,ref
>
MODIFICATION HISTORY:
Written by: Ken Dere
March 1996: Version 2.0
(See read/read_elvlc_direct.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
continuum and emission line spectra from astrophysical plasmas. It is
a collaborative project involving the Naval Research Laboratory
(Washington DC, USA), the Arcetri Observatory (Firenze, Italy), and the
Cambridge University (United Kingdom).
NAME:
READ_GFFGU
PURPOSE:
Read gffgu.dat file containing free-free gaunt factors of
R. S. Sutherland, 1998, MNRAS, 300, 321
note: the file available from the web site are mislabelled
CALLING SEQUENCE:
READ_GFFGU,g2,u,gff
INPUTS:
None
OUTPUTS:
g2,u,gff defined in the paper by Sutherland
COMMON BLOCKS:
None
MODIFICATION HISTORY:
Written by: Ken Dere
April 2000: Version 3.0
October 2001: Version 4 - Ken Dere -
corrected for the fact that the original
Sutherland file was mislabelled
November 2001: Corrected the address of the gffgu.dat file - Enrico Landi
(See read/read_gffgu.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
continuum and emission line spectra from astrophysical plasmas. It is a
collaborative project involving the Naval Research Laboratory
(Washington DC, USA), the Arcetri Observatory (Firenze, Italy), and the
Cambridge University (United Kingdom).
NAME:
READ_GFFINT
PURPOSE:
Read gffint file containing integrated free-free gaunt factors of
R. S. Sutherland, 1998, MNRAS, 300, 321
CALLING SEQUENCE:
READ_GFFINT,g2,gff,s1,s2,s3
INPUTS:
None
OUTPUTS:
g2,gff,s1,s2,s3 defined in the paper by Sutherland
COMMON BLOCKS:
None
MODIFICATION HISTORY:
Written by: Ken Dere
April 2000: Version 3.0
(See read/read_gffint.pro)
PROJECT: CHIANTI
CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
Astrophysical Plasmas. It is a collaborative project involving the Naval
Research Laboratory (USA), the University of Florence (Italy), the
University of Cambridge and the Rutherford Appleton Laboratory (UK).
NAME:
READ_IONEQ
PURPOSE:
to read files containing the ionization equilibrium values
CATEGORY:
science.
CALLING SEQUENCE:
READ_IONEQ, File, T, Ioneq, Ref
INPUTS:
File: for example, !xuvtop+'/ioneq/arnaud_rothenflug.ioneq'
OPTIONAL INPUTS:
None:
OUTPUTS:
T: array of log10 temperatures
Ioneq: 3-d array (T,element,ion)
of the fractional abundance of the ion in
ionization equilibrium.
Ref: reference in the scientific literature
EXAMPLE:
> read_ioneq,!xuvtop+'/ioneq/arnaud_rothenflug.ioneq'
> help,t,ioneq
> T FLOAT = Array(41)
> IONEQ FLOAT = Array(41, 28, 29)
> print, minmax(t)
> 4.00000 8.00000
> print,t(20)
> 6.0000
> print,ioneq(20,25,9)
> 0.269 = fractional abundance of Fe X in
ionization equilibrium
MODIFICATION HISTORY:
Written by: Ken Dere (KPD)
March 1996: Version 2.0
March 1999: KPD to read both number of temperature and number
of elements
25-Oct-2000 V. 4, Giulio Del Zanna (GDZ).
Corrected to interpret the '-1' as a reference only
if within the first 3 columns
V. 5, 21-May-2002, Giulio Del Zanna (GDZ)
generalized directory concatenation to work for
Unix, Windows and VMS.
v.6, 25-Oct-2004, Peter Young
modified format statement so that it will read any number of
temperatures.
V 7, 25-May-2005, GDZ
corrected routine header.
VERSION : 7, 25-May-2005
(See read/read_ioneq.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
continuum and emission line spectra from astrophysical plasmas. It is a
collaborative project involving the Naval Research Laboratory
(Washington DC, USA), the Arcetri Observatory (Firenze, Italy), and the
Cambridge University (United Kingdom).
NAME:
READ_IP
PURPOSE:
to read values of ionization potentials
CALLING SEQUENCE:
READ_IP, File, IP, Ref
INPUTS:
File: the name of the file containing the IP values, usually
!xuvtop/ip/chianti.ip
OUTPUTS:
IP: Array values of ionization potential (cm^-1)
Ref: the reference to the IP values in the scientific literature
EXAMPLE:
> read_ip,!xuvtop+'/ip/chianti.ip',ip,ref
ip(2-1,2-1) give the ionization potential of He II (Z=2, Ion=2)
MODIFICATION HISTORY:
Written by: Ken Dere
March 1998: Version 1.0
(See read/read_ip.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
continuum and emission line spectra from astrophysical plasmas. It is a
collaborative project involving the Naval Research Laboratory
(Washington DC, USA), the Arcetri Observatory (Firenze, Italy), and the
Cambridge University (United Kingdom).
NAME:
READ_MASTERLIST
PURPOSE:
read the masterlist.ions types of file and output a list of ions
CATEGORY:
science.
CALLING SEQUENCE:
READ_MASTERLIST,filename,list
INPUTS:
filename: name of the masterlist file
KEYWORD PARAMETERS:
none
OUTPUTS:
list: list of ions
COMMON BLOCKS:
none;
EXAMPLE:
> read_masterlist,'!xuvtop/masterlist.masterlist.ions',list
MODIFICATION HISTORY:
Written by: Ken Dere
December 1998: first version
(See read/read_masterlist.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
continuum and emission line spectra from astrophysical plasmas. It
is a
collaborative project involving the Naval Research Laboratory
(Washington DC, USA), the Arcetri Observatory (Firenze, Italy), and the
Cambridge University (United Kingdom).
NAME:
READ_SPLUPS
PURPOSE:
to read file containing spline fits to the Burgess-Tully scaled
collision strengths
CATEGORY:
science.
CALLING SEQUENCE:
READ_SPLUPS, File, Splstr, Splref
INPUTS:
File: the name of the input file, i.e. !xuvtop/si/si_4/si_4.splups
OUTPUTS:
SPLSTR Structure containing the data from the file. The tags are
as follows:
.lvl1 lower level index
.lvl2 upper level index
.t_type transition type
.gf gf value
.de Delta-E for transition (rydbergs)
.c_ups the scaling parameter
.nspl
.spl Vector of length 9, containing spline points
OPTIONAL OUTPUTS
SPLREF String array containing references.
KEYWORDS
PROT Allows reading of .psplups files for proton rates.
PROCEDURE:
see Burgess and Tully, 1992, Astronomy and Astrophysics, 254, 436.
EXAMPLE:
> read_splups, !xuvtop+'/si/si_4/si_4.splups',splstr,splref
PROGRAMMING NOTES
This routine is marginally quicker (20-25%) reading the .splups
files than Ken's original routine. The improvement in speed is
through minimising the lines of code in the WHILE loop.
MODIFICATION HISTORY:
Written by: Ken Dere
March 1996: Version 2.0
Ver.3, 23-Jan-01, Peter Young
completely revised. Now reads into a structure and
handles 9 point spline fits.
Ver.4, 26-Jan-01, Peter Young
speeded up routine
Ver.5, 22-Mar-01, Peter Young
now checks if file exists
(See read/read_splups.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
continuum and emission line spectra from astrophysical plasmas. It is a
collaborative project involving the Naval Research Laboratory
(Washington DC, USA), the Arcetri Observatory (Firenze, Italy), and the
Cambridge University (United Kingdom).
NAME:
READ_WGFA
PURPOSE:
:
CATEGORY:
science
CALLING SEQUENCE:
READ_WGFA, File, Lvl1, Lvl2, Wvl, Gf, A_value, Ref
INPUTS:
File: name of the file containing the radiative data
i.e. !xuvtop/c/c_4/c_4.wgfa
OUTPUTS:
Lvl1: 1D array of indices of the lower level (starting at 1)
Lvl2: 1D array of indices of the upper level (starting at 1)
Wvl: 2D array of transition wavelengths in Angstroms
Gf: 2D array of weighted oscillator strength gf
A_value: 2D array of radiative transition probability (s^-1)
Ref: 1D string array of references to the data in the scientific literature
EXAMPLE:
> read_wgfa,!xuvtop+'/c/c_4/c_4.wgfa',lvl1,lvl2,wvl,gf,a,ref
MODIFICATION HISTORY:
Written by: Ken Dere
March 1996: Version 2.0
v.3, 6-Mar-02, Peter Young
Changed the way the reference string is read in order to
prevent '-1' problems.
v.4, 12-Mar-02, Peter Young
Corrected bug following above change.
(See read/read_wgfa.pro)
PROJECT: CHIANTI
CHIANTI is an atomic database package for the calculation of
continuum and emission line spectra from astrophysical plasmas. It is a
collaborative project involving the Naval Research Laboratory
(Washington DC, USA), the Arcetri Observatory (Firenze, Italy), and the
Cambridge University (United Kingdom).
NAME:
READ_WGFA2
PURPOSE:
read radiative data files
a modified version of read_wgfa
needed to take account of two types of transitions between the same 2 levels:
for example, the M1 and the 2 photon E1 transition 1s-2s in hydrogenic ions
CATEGORY:
science
CALLING SEQUENCE:
READ_WGFA2, File, Lvl1, Lvl2, Wvl, Gf, A_value, Ref
INPUTS:
File: name of the file containing the radiative data
i.e. !xuvtop/c/c_4/c_4.wgfa
OUTPUTS:
Lvl1: 1D array of indices of the lower level (starting at 1)
Lvl2: 1D array of indices of the upper level (starting at 1)
Wvl: 1D array of transition wavelengths in Angstroms
Gf: 1D array of weighted oscillator strength gf
A_value: 1D array of the total radiative transition probability (s^-1)
Ref: 1D string array of references to the data in the scientific literature
EXAMPLE:
> read_wgfa2,!xuvtop+'/c/c_4/c_4.wgfa',lvl1,lvl2,wvl,gf,a,ref
MODIFICATION HISTORY:
Written by: Ken Dere
March 1996: Version 2.0
V.3, 3-Nov-03, Giulio Del Zanna (GDZ)
Modified size of input arrays. Now the routine can read a file up to
30 000 lines.
V.4, 26-May-09, Enrico Landi (EL)
Modified size of input arrays. Now the routine can read a file up to
100,000 lines.
Modified definition of variable index (now index=0L).
V.5, 26-May-09, Peter Young
Modified the way references are read.
VERSION : 5, 26-May-09
(See read/read_wgfa2.pro)
NAME
READ_WGFA_STR
PROJECT
CHIANTI
EXPLANATION
Reads the CHIANTI .wgfa file into a structure. For the most part
CHIANTI wgfa files contain radiative decay rates. I.e., rates for
transitions that yield photons of a definite wavelength. However
for some ions the .wgfa file is also used to contain
autoionization rates and/or two photon transitions. These are
needed for accurately modelling the level populations within
ions, but do not yield photons of a definite wavelength
(autoionization yields no photons; two photon transitions yield a
continuum which is separately modelled in CHIANTI).
These "radiationless" transitions are denoted in the .wgfa file
with a zero wavelength.
In the output structure all radiative decay rates are stored in
the .AVAL tag, while autoionization and two photon rates are
stored in the .AUTO tag.
INPUTS
WGFANAME The name of the file to be read.
OUTPUTS
STR A structure with the following tags:
.lvl1 The index of the lower level of the transition.
.lvl2 The index of the upper level of the transition.
.wvl The wavelength of the transition (angstroms).
.gf The weighted oscillator strength.
.aval The radiative decay rate (s^-1).
.auto The autoionization rate (s^-1).
REF A string array containing the file references.
HISTORY
Ver.1, 13-Feb-2009, Peter Young
(See read/read_wgfa_str.pro)