Extended IDL Help

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.


List of Routines


Routine Descriptions

CONVERTNAME

[Next Routine] [List of Routines]

 PROJECT:  CHIANTI

 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:
	convertname

 PURPOSE:
	Ion names as character strings are converted into
	numerical values (note c_2 is C II or C^+1
	in spectroscopic or atomic notation)

 CATEGORY:
	
	naming utility

 CALLING SEQUENCE:

       CONVERTNAME,Name,Iz,Ion


 INPUTS:
	Name:   such as 'c_2'


 OUTPUTS:

	Iz:  nuclear charge Z  (6 for 'c_2', the equivalent of C II)
       Ion:  ionization stage:  (2 for 'c_2')

 OPTIONAL OUTPUTS

       DIELECTRONIC   Set to 1 if NAME has a 'd' appended to it 
                      (indicating dielectronic recombination data) else 
                      set to 0

 EXAMPLE:

                     > convertname,'c_2',iz,ion
                     > print,iz,ion
                     > 6,2

                     > convertname,'o_6d',iz,ion
                     > print,iz,ion
                     > 8,6

 MODIFICATION HISTORY:
 	Written by:	Ken Dere
	March 1996:     Version 2.0
       October 1999:   Version 3.  by kpd

       Ver.4, 11-Dec-01, Peter Young
           Revised routine, removing ch_repstr call.
           Added DIELECTRONIC optional output.

(See convert/convertname.pro)


CONVERT_TERMS

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI   http://wwwsolar.nrl.navy.mil/chianti.html

       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        : CONVERT_TERMS
     		          
 PURPOSE     : 
              to convert the transition information into readable formats.
               

 CALLING SEQUENCE:

       IDL>this_design =  convert_terms(l1, l2, result_latex =result_latex)

 PROCEDURE: 
 		This function is used to convert the transition information into
 		readable formats, including spaces and calulating the J values.
		The process is quite complex since the notation of the level
		designations in the CHIANTI files is not standard. 
		A very useful latex-style output is also created.

    
 INPUTS      : 
		l1:  the index of the lower level
               l2:  the index of the upper level
               
               the rest of the input info is taken from the COMMON.

 OPT. INPUTS : none

               
 OUTPUTS     : 
	        a string with the transition information. 
		
		
 OPT. OUTPUTS:
	       a string with the transition information in latex format. 
	
		
 KEYWORDS    : 
              RESULT_LATEX: the name of an output string.
    

 CALLS       : 		
		CONVERT_CONFIG (included here) and other SolarSoft routines.

		
 COMMON BLOCKS: elvlc,l1a,term,conf,ss,ll,jj,ecm,eryd,ecmth,erydth,eref
 		from here, all the information needed is taken.
		

 RESTRICTIONS: It will not convert every case. 

               
 SIDE EFFECTS: None known yet.
               

 EXAMPLES    : 
		this_design =  convert_terms(l1, l2, result_latex =result_latex)		


 CATEGORY    : 
               spectral synthesis.

 PREV. HIST. :
             parts of the function convert_terms  are derived from the CHIANTI
             routines.  

 WRITTEN     : 

       Giulio Del Zanna (GDZ), 10-Oct-2000 
	DAMTP  (University of Cambridge, UK) 

 MODIFIED    : Version 1, GDZ 10-Oct-2000
               Version 2, GDZ 10-Oct-2001  
               Uses standard SolarSoft routines.
               V. 3, 18-Sep-2002, GDZ 
                Fixed a bug with the jvalue


 VERSION     : 3, 18-Sep-2002

(See convert/convert_terms.pro)


CONVERT_TERMS_ALL

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI   http://wwwsolar.nrl.navy.mil/chianti.html

       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        : CONVERT_TERMS_ALL
     		          
 PURPOSE     : 
              to convert level information into readable formats for all the levels
              of an ion.
               

 CALLING SEQUENCE:

       IDL>convert_terms_all, res_ascii, res_latex

 PROCEDURE: 
 		This function is used to convert the level information into
 		readable formats, including spaces and calculating the J values.
		A very useful latex-style output is also created.
               It has been adapted to manage all the levels of a given ion
               at once from the original routine CONVERT_TERMS.PRO.

    
 INPUTS      : all the input info is taken from the COMMON.

 OPT. INPUTS : none

               
 OUTPUTS     : 
	       RES_ASCII: a string array with the transition information in ASCII format. 
		
              RES_LATEX: a string array with the transition information in LATEX format.
    

 CALLS       : 		
		CONVERT_CONFIG (included here) and other SolarSoft routines.

		
 COMMON BLOCKS: elvlc,l1a,term,conf,ss,ll,jj,ecm,eryd,ecmth,erydth,eref
 		from here, all the information needed is taken.
		

 RESTRICTIONS: It will not convert every case. 

               
 SIDE EFFECTS: None known yet.
               

 EXAMPLES    : 
		convert_terms_all, res_ascii, res_latex


 CATEGORY    : 
               spectral synthesis.

 PREV. HIST. :
             convert_terms_all has been derived from the existing CHIANTI
             routine CONVERT_TERMS.

 WRITTEN     : 
             Enrico Landi, 11-Apr-2005
	      Naval Research Laboratory

 MODIFIED    : Version 1, EL 11-Apr-2005


 VERSION     : 1, 11-Apr-2005

(See convert/convert_terms_all.pro)


DESCALE_ALL

[Previous Routine] [Next Routine] [List of Routines]
 EXPLANATION

      This routine descales all types of spline fits into upsilons or 
      rates, i.e., it does both electron upsilons and proton rates, 
      and both 5-point and 10-point splines. In addition it can 
      simultaneously descale several temperatures at once.

 INPUTS

      TEMP     Temperature(s), K.

      SPLSTR   Structure output by read_splups.

      INDEX    Index of structure.

 OUTPUTS

      UPS      Upsilon value(s) at temperature(s) TEMP.

 EXAMPLES

      read_splups,splupsfile,splstr
      descale_all,[1.e6,2.e6],splstr,5,ups
      print,ups

 HISTORY

      Ver.1, 15-Mar-01, Peter Young
               adapted from Ken Dere's descale_ups.pro.

      Ver.2, 12-Nov-01, Peter Young
               added type 6 transitions (for protons)

(See convert/descale_all.pro)


DESCALE_UPS

[Previous Routine] [Next Routine] [List of Routines]

 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:
	DESCALE_UPS

 PURPOSE:

	convert from Burgess-Tully scaling spline fits to Upsilons

 CATEGORY:

	science.

 CALLING SEQUENCE:

       DESCALE_UPS,Index,Jndex,xt,upsilion

 INPUTS:

	Index:	index of lower energy level (lowest level is 1)
	Jndex:	index of upper energy level (lowest level is 1)
	xt:  scaled temperature

 OPTIONAL INPUTS:

	None:
	
 KEYWORD PARAMETERS:

	None:	

 OUTPUTS:

	Upsilon:  the Maxwellian averaged collision strength



 COMMON BLOCKS:

	common elvlc,l1a,term,conf,ss,ll,jj,ecm,eryd,ecmth,erydth,eref
       common wgfa, wvl,gf,a_value
       common upsilon,t_type,c_ups,splups


 PROCEDURE:

	see Burgess and Tully, 1992, Astron and Astrophys, 254, 436.

 EXAMPLE:

             ;
 MODIFICATION HISTORY:
 	Written by:	Ken Dere
	March 1996:     Version 2.0
       December 1998:  Include transition type 5   (kpd)

(See convert/descale_ups.pro)


ION2FILENAME

[Previous Routine] [Next Routine] [List of Routines]

 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:
	ion2filename

 PURPOSE:
	Ion names as character strings are converted to
	provide their complete file name (with out suffix)

 CATEGORY:
	
	naming utility

 CALLING SEQUENCE:

       ION@FILENAME,Ion,Filename


 INPUTS:
	Name:   such as 'c_2'


 OUTPUTS:

	Filename:  !xuvtop/c/c_2/c_2


 EXAMPLE:

                     > ion2filename,'c_2d',filename
                     > print,filename
                     > !xuvtop/c/c_2d/c_2d

 MODIFICATION HISTORY:

 	Written by:	Ken Dere

	V.2,  September 1999:  added for use with Version 3

       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 convert/ion2filename.pro)


ION2SPECTROSCOPIC

[Previous Routine] [Next Routine] [List of Routines]

 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:
	ION2SPECTROSCOPIC

 PURPOSE:

	provide identification string

 CATEGORY:

	database.

 CALLING SEQUENCE:

       ION2SPECTROSCOPIC, Ion, Spectroscopic

 INPUTS:

       Ion:   CHIANTI notation for an ion, i.e., 'c_2' for C II	

 OUTPUTS:

	Name:  the spectroscopic notation for the ion, i.e. 'C II'

 EXAMPLE:
             > ion2spectroscopic,'fe_13',name
             > print,name
             > Fe XIII   

             > ion2spectroscopic,'o_6d',name
             > print,name
             > O VI d   

 MODIFICATION HISTORY:
 	Written by:	    Ken Dere
	September 1999:     Version 3.0

       Ver.2, 11-Dec-2001, Peter Young
           Revised routine; removed call to repstr

       V.3, 29-May-2002, Giulio Del Zanna (GDZ) 
              Added output keyword dielectronic.

       V.4, 12-Aug-02, GDZ 
           Corrected a typo concerning XXII.

 VERSION     :   4, 12-Aug-02

(See convert/ion2spectroscopic.pro)


SPECTROSCOPIC2ION

[Previous Routine] [Next Routine] [List of Routines]

 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:
	SPECTROSCOPIC2ION

 PURPOSE:
	provide identification string

 CATEGORY:

	database.

 CALLING SEQUENCE:

       SPECTROSCOPIC2ION,  snote, Ion, dielectronic=dielectronic

 INPUTS:

	snote:  the spectroscopic notation for the ion, i.e. 'C II'

 OPTIONAL INPUTS: none

 KEYWORD PARAMETERS:
              
 OUTPUTS:
       Ion:   CHIANTI notation for an ion, i.e., 'c_2' for C II	

 OPTIONAL OUTPUTS:  dielectronic (0/1)

 EXAMPLE:
             > spectroscopic2ion, 'O VI d', ion,dielectronic=dielectronic
             > help, ion, dielectronic
             > ION             STRING    = 'o_6d'
             > DIELECTRONIC    INT       =        1

 WRITTEN     : 
       Version 1, Written by: Giulio Del Zanna (GDZ) 25-May-2002

 MODIFICATION HISTORY:

       V.2, 12-Aug-02, GDZ 
           Corrected a typo concerning XXII.

 VERSION     :   2, 12-Aug-02

(See convert/spectroscopic2ion.pro)


Z2ELEMENT

[Previous Routine] [Next Routine] [List of Routines]

 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:
	Z2ELEMENT

 PURPOSE:


	provide identification strings

 CATEGORY:

	database.

 CALLING SEQUENCE:

       Z2ELEMENT, Iz, Name


 INPUTS:

	Iz:  nuclear charge of ion of interest, i.e. 26 for Fe


 OUTPUTS:

	Name:  a string identifying the element



 EXAMPLE:

             > z2element,2,name
             > print,name
             > He  

 MODIFICATION HISTORY:
 	Written by:	Ken Dere
	March 1996:     Version 2.0

(See convert/z2element.pro)


ZION2FILENAME

[Previous Routine] [Next Routine] [List of Routines]

 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:
	ZION2FILENAME

 PURPOSE:

	help locate CHIANTI database files

 CATEGORY:

	database.

 CALLING SEQUENCE:

       ZION2FILENAME, Iz, Ion, Filename


 INPUTS:

	Iz:  nuclear charge of ion of interest, i.e. 26 for Fe
       Ion:   charge state of ion of interest, i.e. 2 for Fe II	

  KEYWORDS:
       
       diel:  set if excitation of this ion is by dielectronic
		recombination

 OUTPUTS:

	Filename:  the complete filename and path specification for generic
                  CHIANTI database file, i.e. '.elvlc' suffix is not included


 RESTRICTIONS:

	!xuvtop must be set


 EXAMPLE:

             > zion2filename,26,2,filename
             > print,filename
             > /data1/xuv/fe/fe_2/fe_2   assuming !xuvtop = '/data1/xuv'

 MODIFICATION HISTORY:
 	Written by:	Ken Dere
	March 1996:     Version 2.0
       Sept  1996:     Modified for use with VMS
       December 1998:  Modified to diel keyword

       V.5, 29-May-2002, Giulio Del Zanna (GDZ) 
                   generalized directory concatenation to work for
                   Unix, Windows  and VMS. Added keyword name to output just
                   the name of the file and changed the dielectronic  keyword. 

 VERSION     :   5, 29-May-2002 

(See convert/zion2filename.pro)


ZION2NAME

[Previous Routine] [Next Routine] [List of Routines]

 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:
	ZION2NAME

 PURPOSE:

       Help locate CHIANTI database files.

 CATEGORY:

	Database.

 CALLING SEQUENCE:

       ZION2NAME, Iz, Ion, Name [, /diel]


 INPUTS:

	Iz:  nuclear charge of ion of interest, i.e. 26 for Fe
       Ion:   charge state of ion of interest, i.e. 2 for Fe II

 KEYWORDS:

	diel:   set if ion produced by dielectronic recombination	


 OUTPUTS:

	Name:  the generic filename for a CHIANTI database file.

 EXAMPLE:

             > zion2name,26,2,name
             > print,name
             > fe_2   

 MODIFICATION HISTORY:

     Ver.1, Mar-96, Ken Dere
     Ver.2, Sep-99, Ken Dere
              added /diel keyword

(See convert/zion2name.pro)


ZION2SPECTROSCOPIC

[Previous Routine] [List of Routines]

 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:
	ZION2SPECTROSCOPIC

 PURPOSE:


	provide identification strings

 CATEGORY:

	database.

 CALLING SEQUENCE:

       ZION2SPECTROSCOPIC, Iz, Ion, Name


 INPUTS:

	Iz:  nuclear charge of ion of interest, i.e. 26 for Fe
       Ion:   charge state of ion of interest, i.e. 2 for Fe II	


 OUTPUTS:

	Name:  the spectroscopic notation for the ion, i.e. 'Fe II'



 EXAMPLE:

             > zion2spectroscopic,26,2,name
             > print,name
             > Fe II   

 WRITTEN     :  Ken Dere

 MODIFICATION HISTORY:

	March 1996:     Version 2.0

       V.3, 25-May-2002, Giulio Del Zanna (GDZ)
            added the DIELECTRONIC keyword.

 VERSION     : 3, 25-May-2002

(See convert/zion2spectroscopic.pro)