SPLAT_CORE

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: Fri Mar 9 05:37:55 2007.


List of Routines


Routine Descriptions

CONVERT_PLASTIC_UNITS

[Next Routine] [List of Routines]
 FUNCTION: convert_plastic_units

 PURPOSE: to convert data units for the stereo/plastic instrument

 INPUT: dat:   data structure
        units: A string telling the procedure which units to convert to, such
		as ncounts,rate,nrate,eflux,flux

 KEYWORDS:

 CREATED BY:

 LAST MODIFIED:

 MODIFICATION HISTORY:

(See .//convert_plastic_units.pro)


FIND_CAL_INDICES

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: find_cal_indices
PURPOSE: figure out which data points use which calibration file

PARAMETERS:   
 in : epoch -- array of epoch times, may include NaN
 in : data  -- array of data, indices of Nan should match those for
               epoch
 in : cal_start  -- for each element, start time of that
                       calibration file
 in : cal_stop   -- for each element, stop time of that
                       calibration file
 out: data_indices   -- indices into a data array for valid data
                      (record index)
 out: cal_file_index -- for each valid data point, gives index of cal
                       file to use

CREATED BY: L. Ellis

LAST MODIFICATION: 10/14/2006

MODIFICATION HISTORY:
    10/14/2006 Created
	November 2006 -- K. Simunac modified cal_file_index to "long' 

(See .//find_cal_indices.pro)


GET_CLASS

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_class

 PURPOSE: To create the data structure of the 'class' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_class.pro)


GET_INPUT_PARAM

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: get_input_param

 PURPOSE: to extract/translate the input parameters from the input
          string sprod

 INPUT:  sprod - the crib sheet input string

 OUTPUT: sat/prod/class three separate arrays with the sat, prod,
         class information 

 CREATED BY: C. Mouikis

 LAST MODIFIED:

 MODIFICATION HISTORY:

(See .//get_input_param.pro)


GET_PLA_DEF_SPEC

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: get_pla_def_spec

 PURPOSE:

 INPUT:

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION LIST:

(See .//get_pla_def_spec.pro)


GET_PLA_ENERGIES

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE:     get_pla_energies, sat, esa_step

 PURPOSE:   Get STEREO/PLASTIC energy bins

 INPUT:  sat: S/C id - 'A' or 'B'

 OUTPUT: esa_step: energy values of the esa steps

 CREATED BY:    C. Mouikis

 LAST MODIFICATION:  

 MODIFICATION HISTORY:

(See .//get_pla_energies.pro)


GET_PLA_EN_SPEC

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: get_pla_en_spec

 PURPOSE: to get the product related data and create the
          corresponding  tplot variable

 INPUT: sat   - S/C id - 'A' or 'B'
        prod  - product
        class - classification
        units - units

 KEYWORDS: diagn - if set extra diagnostic tplot variables are created

 OUTPUT: the output is provided via the tplot variables.

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION LIST:

(See .//get_pla_en_spec.pro)


GET_PLA_EN_SPEC_LINE

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: get_pla_en_spec_line

 PURPOSE:

 INPUT:

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION LIST:

(See .//get_pla_en_spec_line.pro)


GET_PLA_H1_ALPHA

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_h1_alpha

 PURPOSE: To create the data structure of the 'h_alpha' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_h1_alpha.pro)


GET_PLA_H1_PEAK

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_h1_peak

 PURPOSE: To create the data structure of the 'h1_peak' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_h1_peak.pro)


GET_PLA_HE2_PEAK

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_he2_peak

 PURPOSE: To create the data structure of the 'h1_peak' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_he2_peak.pro)


GET_PLA_HE2_TCR

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_he2_tcr

 PURPOSE: To create the data structure of the 'h1_peak' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_he2_tcr.pro)


GET_PLA_PHI_ANGLES

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE:     get_pla_phi_angles, sat, prod, phi_step

 PURPOSE:   Get STEREO/PLASTIC position angles

 INPUT:  sat: S/C id - 'A' or 'B'
         prod: the product string

 OUTPUT: phi_step: position angle values

 CREATED BY: C. Mouikis

 LAST MODIFICATION:  

 MODIFICATION HISTORY:

(See .//get_pla_phi_angles.pro)


GET_PLA_POS_SPEC

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: get_pla_pos_spec

 PURPOSE:

 INPUT:

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION LIST:

(See .//get_pla_pos_spec.pro)


GET_PLA_SW_PRIORITY

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_sw_priority

 PURPOSE: To create the data structure of the 
          heavy ion 'sw_priority' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_sw_priority.pro)


GET_PLA_SW_Z2_H

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_sw_z2_h

 PURPOSE: To create the data structure of the 'sw z>2 h' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_sw_z2_h.pro)


GET_PLA_SW_Z2_L

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_sw_z2_l

 PURPOSE: To create the data structure of the 'sw z>2 l' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_sw_z2_l.pro)


GET_PLA_THETA_ANGLES

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: get_pla_theta_angles, sat, theta_step

 PURPOSE: Get STEREO/PLASTIC deflection angles

 INPUT:  sat: S/C id - 'A' or 'B'
         prod: the product string

 OUTPUT: theta_step: deflection angle vlaues

 CREATED BY: C. Mouikis

 LAST MODIFICATION:  

 MODIFICATION HISTORY:

(See .//get_pla_theta_angles.pro)


GET_PLA_WAP_NO_SSD_DCR

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_wap_no_ssd_dcr

 PURPOSE: To create the data structure of the 'wap_no_ssd_dcr' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_wap_no_ssd_dcr.pro)


GET_PLA_WAP_PRIORITY_NO_SSD

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_wap_priority_no_ssd

 PURPOSE: To create the data structure of the 'wap_priority_no_ssd' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_wap_priority_no_ssd.pro)


GET_PLA_WAP_PRIORITY_SSD

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_wap_priority_ssd

 PURPOSE: To create the data structure of the 'wap_priority_ssd' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_wap_priority_ssd.pro)


GET_PLA_WAP_SSD_DCR

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_wap_ssd_dcr

 PURPOSE: To create the data structure of the 'wap_ssd_dcr' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_wap_ssd_dcr.pro)


GET_PLA_WAP_SSD_TCR

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION: get_pla_wap_ssd_tcr

 PURPOSE: To create the data structure of the 'wap_ssd_tcr' product

 INPUT: sat: S/C id - 'A' or 'B'

 OUTPUT: the data structure is returned

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//get_pla_wap_ssd_tcr.pro)


MAKE_MOMENT_STRUCT

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_moment_struct
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'

CREATED BY: L. Ellis

LAST MODIFICATION: 10/14/2006

MODIFICATION HISTORY:
    10/14/2006 Created
    01/23/2007 LBE added diagonalization
    02/01/2007 LBE fixed bug in density

(See .//make_moment_struct.pro)


MAKE_MON_STRUCT

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_mon_struct
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'

CREATED BY: L. Ellis (make_moment_struct)

LAST MODIFICATION: 10/14/2006

MODIFICATION HISTORY:
    10/14/2006 Created

   December 2006 modified by K. Simunac for monitor rates
	4 Jan, 2007:  modified to store error flags
	12 Jan, 2007:  modified variable and program names to avoid confusion
	24 Jan, 20007:  IMPORTANT FIX TO low/high indices
       03/07/2007: Some of the code is compacted using the 'EXECUTE' command

(See .//make_mon_struct.pro)


MAKE_MON_STRUCT_FULL

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_mon_struct_full
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'

CREATED BY: L. Ellis (make_moment_struct)

LAST MODIFICATION: 10/14/2006

MODIFICATION HISTORY:
    10/14/2006 Created

   December 2006 modified by K. Simunac for monitor rates
	4 Jan, 2007:  modified to store error flags
	12 Jan, 2007:  modified variable and program names to avoid confusion
	24 Jan, 20007:  IMPORTANT FIX TO low/high indices

(See .//make_mon_struct_full.pro)


MAKE_MON_STRUCT_NO_ENG

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_mon_struct_no_eng
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'

CREATED BY: L. Ellis (make_moment_struct)

LAST MODIFICATION: 10/14/2006

MODIFICATION HISTORY:
    10/14/2006 Created

   December 2006 modified by K. Simunac for monitor rates
	4 Jan, 2007:  modified to store error flags
	12 Jan, 2007:  modified variable and program names to avoid confusion
	24 Jan, 20007:  IMPORTANT FIX TO low/high indices
       03/07/2007: Some of the code is compacted using the 'EXECUTE' command

(See .//make_mon_struct_no_eng.pro)


MAKE_SC_HK_STRUCT

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_sc_hk_struct
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'

CREATED BY: L. Ellis (make_moment_struct)

LAST MODIFICATION: 10/14/2006

MODIFICATION HISTORY:
    10/14/2006 Created

   November 2006 modified by K. Simunac for housekeeping data
	12 Jan, 2007:  modified variable and program names to avoid confusion

(See .//make_sc_hk_struct.pro)


MAKE_TPLOT_STRUCT

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_tplot_struct
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'
              prod: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 09/21/2006

MODIFICATION HISTORY:
    09/21/2006 Created

(See .//make_tplot_struct.pro)


MAKE_TPLOT_STRUCT_DIG_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_tplot_struct_dig_hk
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'
              prod_dig_hk: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 01/12/2007

MODIFICATION HISTORY:
    09/21/2006 Created
	November 2006 K. Simunac modifies for housekeeping data
	12 Jan, 2007 variable names modified to avoid confusion

(See .//make_tplot_struct_dig_hk.pro)


MAKE_TPLOT_STRUCT_HK_1MIN

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_tplot_struct_hk
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'
              prod_hk: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 01/12/2007

MODIFICATION HISTORY:
    09/21/2006 Created
	November 2006 K. Simunac modifies for housekeeping data
	12 Jan, 2007 variable names modified to avoid confusion

(See .//make_tplot_struct_hk_1min.pro)


MAKE_TPLOT_STRUCT_MON

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_tplot_struct_mon
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'
              prod: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 01/12/2007

MODIFICATION HISTORY:
    09/21/2006 Created
	November, 2006:  K. Simunac modified for monitor rates products
	12 Jan, 2007:  modified variable and program names to avoid confusion

(See .//make_tplot_struct_mon.pro)


MAKE_TPLOT_STRUCT_MON_FULL

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_tplot_struct_mon_full
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'
              prod: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 01/12/2007

MODIFICATION HISTORY:
    09/21/2006 Created
	November, 2006:  K. Simunac modified for monitor rates products
	12 Jan, 2007:  modified variable and program names to avoid confusion

(See .//make_tplot_struct_mon_full.pro)


MAKE_TPLOT_STRUCT_SC_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: make_tplot_struct_sc_hk
PURPOSE: Create tplot structures from data

PARAMETERS:   sat : 'A' or 'B'
              prod: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 09/21/2006

MODIFICATION HISTORY:
    09/21/2006 Created

(See .//make_tplot_struct_sc_hk.pro)


N_3D_PLASTIC

[Previous Routine] [Next Routine] [List of Routines]
FUNCTION:	n_3d_plastic(dat,ENERGY=en,ERANGE=er,EBINS=ebins,
                        ANGLE=an,ARANGE=ar,BINS=bins)
INPUT:	
	dat:	structure,	2d data structure filled 
                               by get_eesa_surv, get_eesa_burst, etc.
KEYWORDS
	ENERGY:	fltarr(2),	optional, min,max energy range for integration
	ERANGE:	fltarr(2),	optional, min,max energy bin numbers
	                                  for integration
	EBINS:	bytarr(na),	optional, energy bins array for integration
					0,1=exclude,include,  
					na = dat.nenergy
	ANGLE:	fltarr(2,2),	optional, angle range for integration
				theta min,max (0,0),(1,0) -90

(See .//n_3d_plastic.pro)


PLA_PLOT_DEF_SPEC

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: pla_plot_def_spec

 PURPOSE:
  To plot plastic energy spectra

 INPUT:
       sat:
       prod:

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//pla_plot_def_spec.pro)


PLA_PLOT_EN_SPEC

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: pla_plot_en_spec

 PURPOSE:
  To plot plastic energy spectra. This routine can be called from a
  crib or from the command line.

 INPUT:
       sprod - Spacecraft ('A' or 'B') & product ID.

 POSSIBLE PRODUCTS:
 
          SOURCE ARRAY             REDUCED ARRAY

      01: SW-all                 : h_alpha
      02: SW-H(D)                : h+peak
      03: SW-alpha(D)            : he++peak
      04: SW-alpha(T)            : he++trc
      05: SW Z>2                 : sw_z>2_h              class:0-1
      06: SW Z>2                 : sw_z>2_l              class:0-12
      07: WIDE ANGLE             : wap_ssd_tcr           class:0-14
      08: WIDE ANGLE(D)          : wap_ssd_dcr           class:0-6
      09: WIDE ANGLE(D)          : wap_no_ssd_dcr        class:0-6
      10: SW PHA PRIORITY RATES  : sw_priority           class:0-3
      11: WAP PHA PRIORITY RATES : wap_priority_ssd      class:0-1
      12: wap_priority_no_ssd   class:0-1
      13: class

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//pla_plot_en_spec.pro)


PLA_PLOT_EN_SPEC_LINE

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: pla_plot_en_spec_line

 PURPOSE:
  To plot plastic energy spectra

 INPUT:
       sat:
       prod:

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//pla_plot_en_spec_line.pro)


PLA_PLOT_POS_SPEC

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: pla_plot_pos_spec

 PURPOSE:
  To plot plastic energy spectra

 INPUT:
       sat:
       prod:

 CREATED BY: C. Mouikis

 LAST MODIFICATION:

 MODIFICATION HISTORY:

(See .//pla_plot_pos_spec.pro)


PLOT_DIG_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: plot_dig_hk
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis (plot_moments)

LAST MODIFICATION: 10/13/2006

MODIFICATION HISTORY:
    10/13/2006 Created

(See .//plot_dig_hk.pro)


PLOT_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: plot_hk
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis (plot_moments)

LAST MODIFICATION: 10/13/2006

MODIFICATION HISTORY:
    10/13/2006 Created
    02/27/2007 - C. Mouikis: The S/C descriptor is included in prefix

(See .//plot_hk.pro)


PLOT_MOMENTS

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: plot_moments
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis

LAST MODIFICATION: 10/13/2006

MODIFICATION HISTORY:
    10/13/2006 Created

(See .//plot_moments.pro)


PLOT_MON

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: plot_mon
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis (plot_moments)

LAST MODIFICATION: 01/19/2007

MODIFICATION HISTORY:
    10/13/2006 Created
	November 2006:  K. Simunac modified for monitor rates
	18 Jan, 2007:	plot attributes set in a separate program
			set_plot_attributes_mon.pro
	19 Jan, 2007:	changed tplot names to include A or B
       03/09/2007: The input variable HZ is replased by the variable units.       

(See .//plot_mon.pro)


PLOT_MON_FULL

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: plot_mon_full
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis (plot_moments)

LAST MODIFICATION: 01/19/2007

MODIFICATION HISTORY:
    10/13/2006 Created
	November 2006:  K. Simunac modified for monitor rates
	18 Jan, 2007:	plot attributes set in separate program
			set_plot_attributes_mon.pro
	19 Jan, 2007:	changed tplot names to include A or B

(See .//plot_mon_full.pro)


PLOT_SC_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: plot_sc_hk
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis (plot_moments)

LAST MODIFICATION: 10/13/2006

MODIFICATION HISTORY:
    10/13/2006 Created

(See .//plot_sc_hk.pro)


PL_OBMOM

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: pl_obmom

 DESCRIPTION:
	computes OB moments for the STEREO PLASTIC instrument

 INPUT:
       PROD -> product number
	MOMENTS -> moments to compute
	NAME -> tplot structure name
	ENERGY -> energy range
	ANGLE -> angle range
       TRANS -> coordinate transformation direction

 CREATED BY: Lorna Ellis

 LAST MODIFICATION: 09/14/06

 MODIFICATION HISTORY:
    09/14/06 Modified from Chris Mouikis's codif_obmom.pro

(See .//pl_obmom.pro)


PL_PLOT_DIG_HK_FROM_CRIB

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_plot_dig_hk_from_crib
PURPOSE:
  It is a crib sheet for plotting stereo-plastic analog housekeeping using
  the TPLOT package

INPUT
PARAMETERS:   sat_a_hk: Array of housekeeping variables wanted for sat A
              sat_b_hk: Array of housekeeping variables wanted for sat B

CREATED BY: L. Ellis (pl_plot_obmom_from_crib)

LAST MODIFICATION: 01/12/2007

MODIFICATION HISTORY:
    09/11/2006: Adjusted from C. Mouikis's plot_obmom_from_crib

	November 2006:  K. Simunac adjusted to plot analog housekeeping products

    02/28/2007: The PS output option is taken out (C. Mouikis)	

(See .//pl_plot_dig_hk_from_crib.pro)


PL_PLOT_HK_FROM_CRIB

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_plot_hk_from_crib
PURPOSE:
  It is a crib sheet for plotting stereo-plastic analog housekeeping using
  the TPLOT package

INPUT
PARAMETERS:   sat_a_hk: Array of housekeeping variables wanted for sat A
              sat_b_hk: Array of housekeeping variables wanted for sat B

CREATED BY: L. Ellis (pl_plot_obmom_from_crib)

LAST MODIFICATION: 01/12/2007

MODIFICATION HISTORY:
    09/11/2006 Adjusted from C. Mouikis's plot_obmom_from_crib

	November 2006:  K. Simunac adjusted to plot analog housekeeping products
	12 Jan, 2007:  modified variable names to avoid confusion
		prod -> prod_hk
		share1 -> share1_hk
		moments_finished -> hk_finished
		check_prod -> check_prod_hk
		a_array -> a_hk_array
		b_array -> b_hk_array
    02/28/2007: The PS output option is taken out (C. Mouikis)

(See .//pl_plot_hk_from_crib.pro)


PL_PLOT_MON_FROM_CRIB

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_plot_mon_from_crib
PURPOSE:
  It is a crib sheet for plotting stereo-plastic analog housekeeping using
  the TPLOT package

INPUT
PARAMETERS:   sat_a_mon: Array of monitor rates wanted for sat A
              sat_b_mon: Array of monitor rates wanted for sat B

CREATED BY: L. Ellis (pl_plot_obmom_from_crib)

LAST MODIFICATION: 01/18/2007

MODIFICATION HISTORY:
    09/11/2006 Adjusted from C. Mouikis's plot_obmom_from_crib

	November 2006:  K. Simunac adjusted to plot monitor rates
	12 January, 2007:  modified variable and program names to avoid confusion
	18 January, 2007:  added routine to set plot attributes	
       02/28/2007: The PS output option is taken out (C. Mouikis)
       03/09/2007: The input variable HZ is replased by the variable units.       


(See .//pl_plot_mon_from_crib.pro)


PL_PLOT_MON_FULL_FROM_CRIB

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_plot_mon_full_from_crib
PURPOSE:
  It is a crib sheet for plotting stereo-plastic analog housekeeping using
  the TPLOT package

INPUT
PARAMETERS:   sat_a_mon: Array of monitor rates wanted for sat A
              sat_b_mon: Array of monitor rates wanted for sat B

CREATED BY: L. Ellis (pl_plot_obmom_from_crib)

LAST MODIFICATION: 01/18/2007

MODIFICATION HISTORY:
    09/11/2006 Adjusted from C. Mouikis's plot_obmom_from_crib

	November 2006:  K. Simunac adjusted to plot monitor rates
	12 January, 2007:  modified variable and program names to avoid confusion
	18 January, 2007:  added routine to set plot attributes	
       02/28/2007: The PS output option is taken out (C. Mouikis)
       03/09/2007: The input variable HZ is replased by the variable units. 

(See .//pl_plot_mon_full_from_crib.pro)


PL_PLOT_OBMOM_FROM_CRIB

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_plot_obmom_from_crib
PURPOSE:
  It is a crib sheet for plotting stereo-plastic OB moments using
  the TPLOT package

INPUT
PARAMETERS:   sat_a_mom: Array of moments wanted for sat A
              sat_b_mom: Array of moments wanted for sat B

CREATED BY: L. Ellis

LAST MODIFICATION: 09/11/2006

MODIFICATION HISTORY:
    09/11/2006 Adjusted from C. Mouikis's plot_obmom_from_crib
    02/09/2007 Changed set_plot_attributes to set_plot_attributes_mom

    02/28/2007: The PS output option is taken out (C. Mouikis)	

(See .//pl_plot_obmom_from_crib.pro)


PL_PLOT_SC_HK_FROM_CRIB

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_plot_sc_hk_from_crib
PURPOSE:
  It is a crib sheet for plotting stereo-plastic analog housekeeping using
  the TPLOT package

INPUT
PARAMETERS:   sat_a_hk: Array of housekeeping variables wanted for sat A
              sat_b_hk: Array of housekeeping variables wanted for sat B

CREATED BY: L. Ellis (pl_plot_obmom_from_crib)

LAST MODIFICATION: 01/12/2007

MODIFICATION HISTORY:
    09/11/2006 Adjusted from C. Mouikis's plot_obmom_from_crib

	January 2007:  K. Simunac adjusts to plot spacecraft housekeeping products
	12 January, 2007:  variable and program names modified to avoid confusion
    02/28/2007: The PS output option is taken out (C. Mouikis)

(See .//pl_plot_sc_hk_from_crib.pro)


PL_READ_CDF

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_cdf
PURPOSE:
  Read data from cdf files.

PARAMETERS:   in:  sat        : 'A' or 'B'
                   files      : Array of file paths to read from (strings)
                   products   : Array of Products wanted (strings)
                   which_epoch: 0(for variable), 1, or 5 minute resolution

CREATED BY: L. Ellis

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created

(See .//pl_read_cdf.pro)


PL_READ_CDF_DIG_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_cdf_dig_hk
PURPOSE:
  Read data from cdf files.

PARAMETERS:   in:  sat        : 'A' or 'B'
                   files      : Array of file paths to read from (strings)
                   products   : Array of Products wanted (strings)
                   which_epoch: 0(for variable), 1, or 5 minute resolution, 2 (for analog housekeeping, 
				which can be reported every 2 seconds)

CREATED BY: L. Ellis (pl_read_cdf)

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created

	January 2007 K.Simunac adds digital housekeeping variables

(See .//pl_read_cdf_dig_hk.pro)


PL_READ_CDF_HK_1MIN

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_cdf_hk_1min
PURPOSE:
  Read data from cdf files.

PARAMETERS:   in:  sat        : 'A' or 'B'
                   files      : Array of file paths to read from (strings)
                   products   : Array of Products wanted (strings)
                   which_epoch: 0(for variable), 1, or 5 minute resolution, 2 (for analog housekeeping, 
				which can be reported every 2 seconds)

CREATED BY: L. Ellis (pl_read_cdf)

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created

	November 2006 K.Simunac adds housekeeping variables
	12 January, 2007:  variable and program names modified to avoid confusion
		read_product -> read_product_hk
		remove_fill -> remove_fill_hk
		init_mom -> init_hk
		moments_initialized -> hk_initialized
		mom_read -> hk_read
		check_indices -> check_indices_hk

(See .//pl_read_cdf_hk_1min.pro)


PL_READ_CDF_MOM

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_cdf_mom
PURPOSE:
  Read data from cdf files.

PARAMETERS:   in:  sat        : 'A' or 'B'
                   files      : Array of file paths to read from (strings)
                   products   : Array of Products wanted (strings)
                   which_epoch: 0(for variable), 1, or 5 minute resolution

CREATED BY: L. Ellis

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created
    02/07/2007: LBE changed fillval for moments
    02/16/2007: LBE added _mom to name

(See .//pl_read_cdf_mom.pro)


PL_READ_CDF_MON

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_cdf_mon
PURPOSE:
  Read data from cdf files.

PARAMETERS:   in:  sat        : 'A' or 'B'
                   files      : Array of file paths to read from (strings)
                   products   : Array of Products wanted (strings)
                   which_epoch: 0(for variable), 1, or 5 minute resolution, 2 (for analog housekeeping, 
				which can be reported every 2 seconds)

CREATED BY: L. Ellis (pl_read_cdf)

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created

	December 2006 K.Simunac modifies for monitor rates
	4 Jan, 2007:  modified to check for error flags
	7 Jan, 2007:  modified to output counts per second (if desired)
	8 Jan, 2007:  modified to calculate select ratios
	12 Jan, 2007:  modified variable and program names to avoid confusion
		read_product -> read_product_mon
		remove_fill -> remove_fill_mon
		init_mom -> init_mon
		mom_initialized -> mon_initialized
		mom_read -> mon_read
		check_indices -> check_indices_mon
	24 Jan, 2007:  IMPORTANT FIX to sum_defl... index system

(See .//pl_read_cdf_mon.pro)


PL_READ_CDF_MON_FULL

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_cdf_mon_full
PURPOSE:
  Read data from cdf files.

PARAMETERS:   in:  sat        : 'A' or 'B'
                   files      : Array of file paths to read from (strings)
                   products   : Array of Products wanted (strings)
                   which_epoch: 0(for variable), 1, or 5 minute resolution
				

CREATED BY: L. Ellis (pl_read_cdf)

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created

	December 2006 K.Simunac modifies for monitor rates
	4 Jan, 2007:  modified to check for error flags
	7 Jan, 2007:  modified to output counts per second (if desired)
	8 Jan, 2007:  modified to calculate select ratios
	12 Jan, 2007:  modified variable and program names to avoid confusion
		read_product -> read_product_mon
		remove_fill -> remove_fill_mon
		init_mom -> init_mon
		mom_initialized -> mon_initialized
		mom_read -> mon_read
		check_indices -> check_indices_mon
	24 Jan, 2007:  IMPORTANT FIX to sum_defl... index system

(See .//pl_read_cdf_mon_full.pro)


PL_READ_CDF_MON_NO_ENG

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_cdf_mon_no_eng
PURPOSE:
  Read data from cdf files.

PARAMETERS:   in:  sat        : 'A' or 'B'
                   files      : Array of file paths to read from (strings)
                   products   : Array of Products wanted (strings)
                   which_epoch: 0(for variable), 1, or 5 minute resolution, 2 (for analog housekeeping, 
				which can be reported every 2 seconds)

CREATED BY: L. Ellis (pl_read_cdf)

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created

	December 2006 K.Simunac modifies for monitor rates
	4 Jan, 2007:  modified to check for error flags
	7 Jan, 2007:  modified to output counts per second (if desired)
	8 Jan, 2007:  modified to calculate select ratios
	12 Jan, 2007:  modified variable and program names to avoid confusion
		read_product -> read_product_mon
		remove_fill -> remove_fill_mon
		init_mom -> init_mon
		mom_initialized -> mon_initialized
		mom_read -> mon_read
		check_indices -> check_indices_mon
	24 Jan, 2007:  IMPORTANT FIX to sum_defl... index system
	25 Jan, 2007:  variant created that skips looking for engineering mode data

(See .//pl_read_cdf_mon_no_eng.pro)


PL_READ_CDF_SC_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_cdf_sc_hk
PURPOSE:
  Read data from cdf files.

PARAMETERS:   in:  sat        : 'A' or 'B'
                   files      : Array of file paths to read from (strings)
                   products   : Array of Products wanted (strings)
                   which_epoch: 0(for variable), 1, or 5 minute resolution, 3 (for spacecraft housekeeping) 
				

CREATED BY: L. Ellis (pl_read_cdf)

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created

	January 2007 K.Simunac adds spacecraft housekeeping variables
	12 Jan, 2007:  modified variable and program names to avoid confusion

(See .//pl_read_cdf_sc_hk.pro)


PL_READ_MOM_CONV

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: pl_read_mom_conv
PURPOSE: Find appropriate calibration files and read in calibration values.

INPUT
PARAMETERS:  sat: 'A' or 'B'

CREATED BY: L. Ellis

LAST MODIFICATION: 10/12/2006

MODIFICATION HISTORY:
    10/12/2006 Created

(See .//pl_read_mom_conv.pro)


SEEK_FILES

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: seek_files
PURPOSE:
  Find the files needed for the timespan and satellites given.

PARAMETERS:   in:  sat:        'A' or 'B'
                   file_type:  'science', 'hk', 'cl' (classifier), or 'sc' (spacecraft housekeeping)
              out: files_a:    Array of filenames (and paths) needed for
                               given timespan 

CREATED BY: L. Ellis

LAST MODIFICATION: 09/18/2006

MODIFICATION HISTORY:
    09/18/2006: Created

	November 2006:  K. Simunac modified version number and prefix for housekeeping files
	3 Jan, 2007:  K. Simunac modifies to look for latest version
	of file
       9 Jan, 2007: L. Ellis fixed bug with looping
	9 Jan, 2007: K. Simunac adds type for spacecraft housekeeping
       1 Feb, 2007: C. Mouikis - An extra day was read when time
                                interval ended in 00:00:00 time
       26 Feb, 2007: C. Mouikis - the level1 data environment
                                  variable points to the cdf directory
       26 Feb, 2007: C. Mouikis - two level1 data environment variables
                                  are intriduced; one for each S/C

(See .//seek_files.pro)


SET_COM

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_com
PURPOSE: Set up common variables for PLASTIC data analysis.
    

INPUT
PARAMETERS:   none

CREATED BY: L. Ellis

LAST MODIFICATION: 09/20/2006

MODIFICATION HISTORY:
    09/20/2006 Created
    01/12/2007 LBE, Moved moments variables to set_com_mom
    02/16/2007 LBE, added error variables

(See .//set_com.pro)


SET_COM_DIG_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_com_dig_hk
PURPOSE: Set up common variables for PLASTIC data analysis.
    

INPUT
PARAMETERS:   none

CREATED BY: L. Ellis

LAST MODIFICATION: 09/20/2006

MODIFICATION HISTORY:
    09/20/2006 Created
	November 2006 modified by K. Simunac for housekeeping data

(See .//set_com_dig_hk.pro)


SET_COM_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_com_hk
PURPOSE: Set up common variables for PLASTIC data analysis.
    

INPUT
PARAMETERS:   none

CREATED BY: L. Ellis

LAST MODIFICATION: 09/20/2006

MODIFICATION HISTORY:
    09/20/2006 Created
	November 2006 modified by K. Simunac for housekeeping data

(See .//set_com_hk.pro)


SET_COM_MOM

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_com_mom
PURPOSE: Set up common variables for moments variables
    

INPUT
PARAMETERS:   none

CREATED BY: L. Ellis

LAST MODIFICATION: 01/12/07

MODIFICATION HISTORY:
    01/12/2007 Created

(See .//set_com_mom.pro)


SET_COM_MON

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_com_mon
PURPOSE: Set up common variables for PLASTIC data analysis.
    

INPUT
PARAMETERS:   none

CREATED BY: L. Ellis

LAST MODIFICATION: 09/20/2006

MODIFICATION HISTORY:
    09/20/2006 Created

(See .//set_com_mon.pro)


SET_COM_MON_FULL

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_com_mon_full
PURPOSE: Set up common variables for PLASTIC data analysis.
    

INPUT
PARAMETERS:   none

CREATED BY: L. Ellis

LAST MODIFICATION: 09/20/2006

MODIFICATION HISTORY:
    09/20/2006 Created

(See .//set_com_mon_full.pro)


SET_COM_SC_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_com_sc_hk
PURPOSE: Set up common variables for PLASTIC data analysis.
    

INPUT
PARAMETERS:   none

CREATED BY: L. Ellis

LAST MODIFICATION: 09/20/2006

MODIFICATION HISTORY:
    09/20/2006 Created
	November 2006 modified by K. Simunac for housekeeping data

(See .//set_com_sc_hk.pro)


SET_PLOT_ATTRIBUTES

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_plot_attributes
PURPOSE: Set the plot attributes for different products

PARAMETERS:   sat : 'A' or 'B'
              prod: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 09/21/2006

MODIFICATION HISTORY:
    09/21/2006 Created

(See .//set_plot_attributes.pro)


SET_PLOT_ATTRIBUTES_DIG_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_plot_attributes_dig_hk
PURPOSE: Set the plot attributes for different products

PARAMETERS:   sat : 'A' or 'B'
              prod: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 09/21/2006

MODIFICATION HISTORY:
    09/21/2006 Created
	18 January, 2007:  modified for digital housekeeping

(See .//set_plot_attributes_dig_hk.pro)


SET_PLOT_ATTRIBUTES_HK

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_plot_attributes_hk
PURPOSE: Set the plot attributes for different products

PARAMETERS:   sat : 'A' or 'B'
              prod: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 09/21/2006

MODIFICATION HISTORY:
    09/21/2006 Created

(See .//set_plot_attributes_hk.pro)


SET_PLOT_ATTRIBUTES_MOM

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_plot_attributes_mom
PURPOSE: Set the plot attributes for different products

PARAMETERS:   sat : 'A' or 'B'
              prod: array of product names

CREATED BY: L. Ellis

LAST MODIFICATION: 09/21/2006

MODIFICATION HISTORY:
    09/21/2006: Created
    02/09/2007: Added _mom to name. Changed ylim.
    02/28/2007: All attributes are set for all moments (CGM)

(See .//set_plot_attributes_mom.pro)


SET_PLOT_ATTRIBUTES_MON

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_plot_attributes_mon
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis (plot_moments)

LAST MODIFICATION: 10/13/2006

MODIFICATION HISTORY:
    10/13/2006 Created
    03/07/2007: Energy step '32', that corresponds to the full energy
                range, is added

(See .//set_plot_attributes_mon.pro)


SET_PLOT_ATTRIBUTES_MON_FULL

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE: set_plot_attributes_mon_full
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis (plot_moments)

LAST MODIFICATION: 10/13/2006

MODIFICATION HISTORY:
    10/13/2006 Created

(See .//set_plot_attributes_mon_full.pro)


SET_PLOT_ATTRIBUTES_MON_NO_ENG

[Previous Routine] [List of Routines]
PROCEDURE: set_plot_attributes_mon_no_eng
PURPOSE: Plot the products.

PARAMETERS:   prod: array of product names 
              num_files_a: number of files for sat a
              num_files_b: number of files for sat b

CREATED BY: L. Ellis (plot_moments)

LAST MODIFICATION: 10/13/2006

MODIFICATION HISTORY:
    10/13/2006 Created
    03/07/2007: Energy step '32', that corresponds to the full energy
                range, is added

(See .//set_plot_attributes_mon_no_eng.pro)