This page was created by the IDL library routine mk_html_help2.

Last modified: Fri Jul 20 01:17:09 2007.


Directory Listing of Routines


Routine Descriptions

THM_GEN_OVERPLOT

[Next Routine] [List of Routines]
 Purpose: To make mission overview plots of all instruments

 Inputs:  SC: spacecraft ('a','b','c','d','e')
          DATE: the date string or seconds since 1970 ('2007-03-23')
          DUR: duration (default units are days)
          DAYS: redundant keyword to set  the units of duration (but its comforting to have)
          HOURS: keyword to make the duration be in units of hours
          DEVICE: sets the device (x or z) (default is x)
          MAKEPNG: keyword to generate 5 png files
          DIRECTORY: sets the directory where the above pngs are placed (default is './')
	   FEARLESS: keyword that prevents program from quitting when it fears its in an infinite loop
			(infinite loop is feared when catch statement has been call 1000 times)

 Example: thm_gen_overplot,sc='a',date='2007-03-23',dur=1
	   The above example will produce a full day plot in the X window.


Version:
 $LastChangedBy$
 $LastChangedDate$
 $LastChangedRevision$
 $URL$

(See themis/l2gen/thm_gen_overplot.pro)


THM_L2GEN_ESA

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

Procedure:	thm_l2gen_esa

Purpose:	Creates Level 2 data CDF file of THEMIS ESA data.
		File includes ESA (Electrostatic Analyzer) ion and electron spectrograms and
			density, velocity and temperature moments.
		File includes all metadata (global and variable attributes) necessary 
			to be ISTP compliant and QSAS compatible.
		Program is intended primarily for generation of 1 day files.

Inputs:	probe:	  A string indicating probe. 
			  Valid names are : 'a', 'b', 'c', 'd' and 'e'.
		date:  	  A string indicating the start time.
			  Format: YYYY-MM-DD/hh:mm:ss
		dur:	  Number indicating the duration.
		days:	  A keyword that sets the units for dur to be day (default).
		hours:	  A keyword that sets the units for dur to be hours.
		minutes:  A keyword that sets the units for dur to be minutes.
		noload:	  A keyword that prevents data from being loaded.
			  Note: Data must already be loaded.
		mastercdf:A string indicating the location of the mastercdf to be use.
			  This master contains all the L2 metadata.

Outputs:	File is created in local directory.
 		Filename format:  thx_l2_esa_YYYYMMDD_v01.cdf

Example:	thm_l2gen_esa,probe='a',date='2007-03-23',dur=1,/noload

Written by:	Matt Davis

(See themis/l2gen/thm_l2gen_esa.pro)


THM_L2GEN_FBK

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

Procedure:	thm_l2gen_fbk

Purpose:	Creates Level 2 data CDF file of THEMIS FBK data.
		File includes EFI (Electric Field Instrument) and SCM (Search Coil Magnetometer) 
			Spectra Data.
		File includes all metadata (global and variable attributes) necessary 
			to be ISTP compliant and QSAS compatible.
		Program is intended primarily for generation of 1 day files.

Inputs:	probe:	  A string indicating probe. 
			  Valid names are : 'a', 'b', 'c', 'd' and 'e'.
		date:  	  A string indicating the start time.
			  Format: YYYY-MM-DD/hh:mm:ss
		dur:	  Number indicating the duration.
		days:	  A keyword that sets the units for dur to be day (default).
		hours:	  A keyword that sets the units for dur to be hours.
		minutes:  A keyword that sets the units for dur to be minutes.
		noload:	  A keyword that prevents data from being loaded.
			  Note: Data must already be loaded.
		mastercdf:A string indicating the location of the mastercdf to be use.
			  This master contains all the L2 metadata.

Outputs:	File is created in local directory.
 		Filename format:  thx_l2_fbk_YYYYMMDD_v01.cdf

Example:	thm_l2gen_fbk,probe='a',date='2007-06-15',dur=1,/noload

Written by:	Matt Davis

(See themis/l2gen/thm_l2gen_fbk.pro)


THM_L2GEN_FGM

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

Procedure:	thm_l2gen_fgm

Purpose:	Creates Level 2 data CDF file of THEMIS FGM data.
		File includes FGM (Fluxgate Magnetometer) engineering (FGE), low-res (FGL),
			high-res (FGH) and spin-res (FGS).
		File includes all metadata (global and variable attributes) necessary 
			to be ISTP compliant and QSAS compatible.
		Program is intended primarily for generation of 1 day files.

Inputs:	probe:	  A string indicating probe. 
			  Valid names are : 'a', 'b', 'c', 'd' and 'e'.
		date:  	  A string indicating the start time.
			  Format: YYYY-MM-DD/hh:mm:ss
		dur:	  Number indicating the duration.
		days:	  A keyword that sets the units for dur to be day (default).
		hours:	  A keyword that sets the units for dur to be hours.
		minutes:  A keyword that sets the units for dur to be minutes.
		noload:	  A keyword that prevents data from being loaded.
			  Note: Data must already be loaded.
		mastercdf:A string indicating the location of the mastercdf to be use.
			  This master contains all the L2 metadata.

Outputs:	File is created in local directory.
 		Filename format:  thx_l2_fgm_YYYYMMDD_v01.cdf

Example:	thm_l2gen_fgm,probe='a',date='2007-03-23',dur=1,/noload

Written by:	Matt Davis

(See themis/l2gen/thm_l2gen_fgm.pro)


THM_L2GEN_SST

[Previous Routine] [List of Routines]

Procedure:	thm_l2gen_sst

Purpose:	Creates Level 2 data CDF file of THEMIS SST data.
		File includes SST (Solid State Telescope) ion and electron spectrograms.
		File includes all metadata (global and variable attributes) necessary 
			to be ISTP compliant and QSAS compatible.
		Program is intended primarily for generation of 1 day files.

Inputs:	probe:	  A string indicating probe. 
			  Valid names are : 'a', 'b', 'c', 'd' and 'e'.
		date:  	  A string indicating the start time.
			  Format: YYYY-MM-DD/hh:mm:ss
		dur:	  Number indicating the duration.
		days:	  A keyword that sets the units for dur to be day (default).
		hours:	  A keyword that sets the units for dur to be hours.
		minutes:  A keyword that sets the units for dur to be minutes.
		noload:	  A keyword that prevents data from being loaded.
			  Note: Data must already be loaded.
		mastercdf:A string indicating the location of the mastercdf to be use.
			  This master contains all the L2 metadata.

Outputs:	File is created in local directory.
 		Filename format:  thx_l2_sst_YYYYMMDD_v01.cdf

Example:	thm_l2gen_sst,probe='a',date='2007-03-23',dur=1,/noload

Written by:	Matt Davis

(See themis/l2gen/thm_l2gen_sst.pro)