This page was created by the IDL library routine `mk_html_help2`.

Last modified: Thu Aug 9 01:15:36 2012.

# Directory Listing of Routines

# ssl_general/key_param

- HDF_LIST_ANNS
- LOAD_ACE_CRIS
  loads ACE CRIS Experiment key parameter data for "tplot".
- LOAD_ACE_EPAM
  loads ACE EPAM Experiment key parameter data for "tplot".
- LOAD_ACE_MAG
  loads ACE MAG Experiment key parameter data for "tplot".
- LOAD_ACE_SEPICA
  loads ACE SEPICA Experiment key parameter data for "tplot".
- LOAD_ACE_SIS
  loads ACE SIS Experiment key parameter data for "tplot".
- LOAD_ACE_SWEPAM
  loads ACE SWEPAM (Ion) Experiment key parameter data for "tplot".
- LOAD_ACE_ULEIS
  loads ACE ULEIS Experiment key parameter data for "tplot".
- LOAD_DST
  loads DST data from a DST text file
- LOAD_GE_MGF
  loads GEOTAIL MAGNETOMETER Experiment key parameter data for "tplot".
- LOAD_HKP_MFI
  Creates TPLOT magnetic field variables from 3DP housekeeping data.
- LOAD_I8_MAG
  loads IMP-8 magnetometer key parameter data for "tplot".
- LOAD_I8_PLA
  loads IMP-8 Plasma Experiment key parameter data for "tplot".
- LOAD_IG_PCI
  loads INTERBALL Ground key parameter data for "tplot".
- LOAD_KP
  Loads Kp and ap data from a text file
- LOAD_PO_PWI
  Loads Polar Plasma Wave Instrument key parameter data into "tplot" variables.
- LOAD_SO_CEL
  loads SOHO CEL key parameter data for "tplot".
- LOAD_SO_CST
  loads SOHO CST key parameter data for "tplot".
- LOAD_SO_ERN
  loads SOHO ERN key parameter data for "tplot".
- LOAD_WI_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_EHPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_EHSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_ELM2
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_ELPD2
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_ELPD_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_ELSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_EM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_EPA
  loads WIND Energetic Particle Analyser key parameter data for "tplot".
- LOAD_WI_FRM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_H0_MFI
  loads WIND MAGNETOMETER high resolution data for "tplot".
- LOAD_WI_HKP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_MFI
  loads WIND MAGNETOMETER Experiment key parameter data for "tplot".
- LOAD_WI_OR
  loads WIND 3D Plasma Experiment orbit data for "tplot".
- LOAD_WI_PHSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_PLSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_PM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_SFPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_SFSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_SOPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_SOSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
- LOAD_WI_SP_MFI
  loads WIND MAGNETOMETER 3 second data for "tplot".
- LOAD_WI_SWE
  loads WIND Solar Wind Experiment key parameter data for "tplot".
- LOAD_WI_WAV
  loads WIND WAVES Experiment key parameter data for "tplot".
- LOADALLHDF
  Loads selected HDF file variables into a data structure.
- PB5_TO_TIME
- REDUCE_DIMEN
- SETFILEENV
  Sets up environment variables giving information on the location

# Routine Descriptions

## HDF_LIST_ANNS

[Next Routine] [List of Routines]

     PROCEDURE: hdf_list_anns

     PURPOSE: prints the annotations in an hdf file

     KEYWORDS:
       filename: the filename from which annotations should be lifted

       anns(optional): a named variable in which the annotations will be returned

     $LastChangedBy: pcruce $
     $LastChangedDate: 2007-12-07 22:48:56 -0800 (Fri, 07 Dec 2007) $
     $LastChangedRevision: 2165 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/idl_socware/trunk/external/IDL_GEOPACK/trace/ttrace2iono.pro $

(See ssl_general/key_param/hdf_list_anns.pro)

## LOADALLHDF

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

    PROCEDURE: loadallhdf
    PURPOSE:
      Loads selected HDF file variables into a data structure.
    KEYWORDS:
      VDATANAME:   (Required) name of VData set to be retrieved from HDF file.
      (following keywords are optional)
      FILENAMES:   string (array); full pathname of file(s) to be loaded.
         (INDEXFILE, ENVIRONVAR, MASTERFILE and TIME_RANGE are ignored
         if this is set.)

      MASTERFILE:  Full Pathname of indexfile or name of environment variable
         giving path and filename information as defined in "get_file_names".
         (INDEXFILE and ENVIRONVAR are ignored if this is set)

      INDEXFILE:   File name (without path) of indexfile. This file
         should be located in the directory given by ENVIRONVAR.  If not given
         then "PICKFILE" is used to select an index file. see "make_cdf_index" for
         information on producing this file.

      ENVIRONVAR:  Name of environment variable containing directory of indexfiles
         (default is 'CDF_INDEX_DIR')

      TIME_RANGE:  Two element vector specifying time range (default is to use
         trange_full; see "TIMESPAN" or "GET_TIMESPAN" for more info)

      HDFNAMES:    Names of HDF variables to be loaded. (string array)
      TAGNAMES:    String array of structure tag names.
      DATA:        Named variable that data is returned in.

      TPLOT_NAME:  "TPLOT" string name. If set then a tplot variable is created.
         Individual elements can be referred to as 'NAME.ELEMENT'

    VERSION:  @(#)loadallhdf.pro	1.1 00/01/20
    Created by Peter Schroeder, January 2000

(See ssl_general/key_param/loadallhdf.pro)

## LOAD_ACE_CRIS

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

    PROCEDURE:     load_ace_cris
    PURPOSE:
       loads ACE CRIS Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (String) full filename of master file.
    SEE ALSO:
      "loadallhdf"

    CREATED BY:    Peter Schroeder
    LAST MODIFIED: @(#)load_ace_cris.pro	1.1 00/01/20

(See ssl_general/key_param/load_ace_cris.pro)

## LOAD_ACE_EPAM

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

    PROCEDURE:     load_ace_epam
    PURPOSE:
       loads ACE EPAM Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (String) full filename of master file.
    SEE ALSO:
      "loadallhdf"

    CREATED BY:    Peter Schroeder
    LAST MODIFIED: @(#)load_ace_epam.pro	1.1 00/01/20

(See ssl_general/key_param/load_ace_epam.pro)

## LOAD_ACE_MAG

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

    PROCEDURE:     load_ace_mag
    PURPOSE:
       loads ACE MAG Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (String) full filename of master file.
      POLAR:	Computes B field and SC position in polar coordinates.
    SEE ALSO:
      "loadallhdf"

    CREATED BY:    Peter Schroeder
    Modified by D. Larson 5/2008  to automatically download files from the ACE data center (masterfile is ignored)
    LAST MODIFIED: @(#)load_ace_mag.pro	1.2 02/04/12

(See ssl_general/key_param/load_ace_mag.pro)

## LOAD_ACE_SEPICA

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

    PROCEDURE:     load_ace_sepica
    PURPOSE:
       loads ACE SEPICA Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (String) full filename of master file.
    SEE ALSO:
      "loadallhdf"

    CREATED BY:    Peter Schroeder
    LAST MODIFIED: @(#)load_ace_sepica.pro	1.1 00/01/20

(See ssl_general/key_param/load_ace_sepica.pro)

## LOAD_ACE_SIS

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

    PROCEDURE:     load_ace_sis
    PURPOSE:
       loads ACE SIS Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (String) full filename of master file.
    SEE ALSO:
      "loadallhdf"

    CREATED BY:    Peter Schroeder
    LAST MODIFIED: @(#)load_ace_sis.pro	1.1 00/01/20

(See ssl_general/key_param/load_ace_sis.pro)

## LOAD_ACE_SWEPAM

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

    PROCEDURE:     load_ace_swepam
    PURPOSE:
       loads ACE SWEPAM (Ion) Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (String) full filename of master file.
      POLAR:	Computes proton velocity and SC position in polar coordinates.
    SEE ALSO:
      "loadallhdf"

    CREATED BY:    Peter Schroeder
    Modified by D. Larson 5/2008  to automatically download files from the ACE data center (masterfile is ignored)
    LAST MODIFIED: @(#)load_ace_swepam.pro	1.3 02/04/12

(See ssl_general/key_param/load_ace_swepam.pro)

## LOAD_ACE_ULEIS

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

    PROCEDURE:     load_ace_uleis
    PURPOSE:
       loads ACE ULEIS Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (String) full filename of master file.
    SEE ALSO:
      "loadallhdf"

    CREATED BY:    Peter Schroeder
    LAST MODIFIED: @(#)load_ace_uleis.pro	1.1 00/01/20

(See ssl_general/key_param/load_ace_uleis.pro)

## LOAD_DST

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

    PROCEDURE:	load_dst
    PURPOSE:
       loads DST data from a DST text file

    INPUTS:
      none, but will call "timespan" if time_range is not already set.

    KEYWORDS:
      time_range:	2 element vector specifying the time range.

    CREATED BY:	Peter Schroeder
    LAST MODIFIED: @(#)load_dst.pro	1.6 02/11/01

(See ssl_general/key_param/load_dst.pro)

## LOAD_GE_MGF

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

    PROCEDURE:	load_ge_mgf
    PURPOSE:
       loads GEOTAIL MAGNETOMETER Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time range is not already set.
    KEYWORDS:
      POLAR:       Also computes the B field in polar coordinates.
      TIME_RANGE:  2 element vector specifying the time range
      DATA:        Data returned in this named variable
    RESTRICTIONS:
      This routine expects to find the master file: 'ge_k0_mgf_files'
      in the directory specified by the environment variable: 'CDF_DATA_DIR'
      See "make_cdf_index" for more info.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_ge_mgf.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_ge_mgf.pro)

## LOAD_HKP_MFI

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

    PROCEDURE:	load_hkp_mfi
    PURPOSE:
    	Creates TPLOT magnetic field variables from 3DP housekeeping data.
    	To be used when key parameter file is not available.
    INPUTS:
    	none
    KEYWORDS:
    	none
    NOTES:
    	3DP housekeeping data gives direction of magnetic field only.  A
    	magnitude of 1 is assumed to create these variables.
    CREATED BY:	Peter Schroeder
    LAST MODIFIED:	%W% %E%

(See ssl_general/key_param/load_hkp_mfi.pro)

## LOAD_I8_MAG

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

    PROCEDURE:	load_i8_mag
    PURPOSE:
       loads IMP-8 magnetometer key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      TIME_RANGE:  2 element vector specifying the time range
      DATA:	returns data structure
    RESTRICTIONS:
      This routine expects to find the master file: 'i8_k0_mag_files'
      In the directory specified by the environment variable: 'CDF_DATA_DIR'
      See "make_cdf_index" for more info.

    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_i8_mag.pro
    LAST MODIFICATION: 02/04/12

(See ssl_general/key_param/load_i8_mag.pro)

## LOAD_I8_PLA

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

    PROCEDURE:	load_i8_pla
    PURPOSE:
       loads IMP-8 Plasma Experiment key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      TIME_RANGE:  2 element vector specifying the time range
      DATA:	returns data structure
    RESTRICTIONS:
      This routine expects to find the master file: 'i8_k0_pla_files'
      In the directory specified by the environment variable: 'CDF_DATA_DIR'
      See "make_cdf_index" for more info.

    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_i8_pla.pro
    LAST MODIFICATION: 02/04/12

(See ssl_general/key_param/load_i8_pla.pro)

## LOAD_IG_PCI

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

    PROCEDURE:	load_ig_pci
    PURPOSE:
       loads INTERBALL Ground key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      TIME_RANGE:  2 element vector specifying the time range
    SEE ALSO:
      "make_cdf_index"

    CREATED BY:	Davin Larson
    FILE:  load_wi_epa.pro
    LAST MODIFICATION: 96/08/23

(See ssl_general/key_param/load_ig_pci.pro)

## LOAD_KP

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

    PROCEDURE:	load_kp
    PURPOSE:
       Loads Kp and ap data from a text file
       Variables stored include:
    	Kp: Kp index (multiplied by 10)
    	ap: ap index
    	Sol_Rot_Num: Bartels Solar Rotation Number
    	Sol_Rot_Day: Number of day within Bartels 27-day cycle
    	Kp_Sum: Sum of the eight Kp indices for the day
    	ap_Mean: Mean of the eight ap indices for the day
    	Cp: Cp or Planetary Daily Character Figure
    	C9: Conversion of Cp to the 0-9 range
    	Sunspot_Number: International Sunspot Number
    	Solar_Radio_Flux: Ottawa 10.7-cm Solar Radio Flux Adjusted to 1 AU
    	Flux_Qualifier: "0" indicates flux required no adjustment.
    		"1" indicates flux required adjustment for burst
    		in progress at time of measurement.  "2" indicates a flux
    		approximated by either interpolation or extrapolation.
    		"3" indicates no observation.

    INPUTS:
      none, but will call "timespan" if time_range is not already set.

    KEYWORDS:
      time_range:	2 element vector specifying the time range.

     HISTORY:
       CREATED BY:	Peter Schroeder
       2012-07-20: Jianbao Tao (JBT), SSL, UC Berkeley.
           1. Added the VERSION section to the documentation comment.

     VERSION:
       $LastChangedBy$
       $LastChangedDate$
       $LastChangedRevision$
       $URL$

(See ssl_general/key_param/load_kp.pro)

## LOAD_PO_PWI

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

    PROCEDURE:	load_po_pwi
    PURPOSE:
      Loads Polar Plasma Wave Instrument key parameter data into "tplot" variables.

    INPUTS:
       none, but will call "timespan" if time range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range

    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_po_pwi.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_po_pwi.pro)

## LOAD_SO_CEL

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

    PROCEDURE:	load_so_cel
    PURPOSE:
       loads SOHO CEL key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      TIME_RANGE:  2 element vector specifying the time range
      MASTERFILE:  (string) full filename of master index file

    CREATED BY:	Davin Larson
    FILE:  load_so_cel.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_so_cel.pro)

## LOAD_SO_CST

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

    PROCEDURE:	load_so_cst
    PURPOSE:
       loads SOHO CST key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      TIME_RANGE:  2 element vector specifying the time range

    CREATED BY:	Davin Larson
    FILE:  load_so_cst.pro
    LAST MODIFICATION: 97/11/20

(See ssl_general/key_param/load_so_cst.pro)

## LOAD_SO_ERN

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

    PROCEDURE:	load_so_ern
    PURPOSE:
       loads SOHO ERN key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      TIME_RANGE:  2 element vector specifying the time range
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_so_ern.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_so_ern.pro)

## LOAD_WI_3DP

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

    PROCEDURE:	load_wi_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      POLAR:       Computes polar coordinates if set.
      TIME_RANGE:  2 element vector specifying the time range.
      VTHERMAL:	if nonzero, calculates ion thermal velocities.
      RESOLUTION:	Returns data at a given time resolution.  In seconds.
      MASTERFILE:	(String) full filename of master file.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_3dp.pro
    LAST MODIFICATION: 02/04/19

(See ssl_general/key_param/load_wi_3dp.pro)

## LOAD_WI_EHPD

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

    PROCEDURE:	load_wi_ehpd
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'ehpd'

    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_ehpd.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_wi_ehpd.pro)

## LOAD_WI_EHSP_3DP

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

    PROCEDURE:	load_wi_ehsp_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:	(string) full filename of master file.
      PREFIX:	Prefix for tplot variables. Default is 'ehsp'
      RESOLUTION:	Resolution to be returned in seconds.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_ehsp_3dp.pro
    LAST MODIFICATION: 01/10/08

(See ssl_general/key_param/load_wi_ehsp_3dp.pro)

## LOAD_WI_ELM2

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

    PROCEDURE:	load_wi_elm2
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'el_mom'

    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Peter Schroeder
    LAST MODIFIED: @(#)load_wi_elm2.pro	1.3 99/05/27

(See ssl_general/key_param/load_wi_elm2.pro)

## LOAD_WI_ELPD2

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

    PROCEDURE:	load_wi_elpd_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range
    RESTRICTIONS:
      This routine expects to find the master file: 'wi_elsp_3dp_files'
      In the directory specified by the environment variable: 'CDF_INDEX_DIR'
      See "make_cdf_index" for more info.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_elpd2.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_wi_elpd2.pro)

## LOAD_WI_ELPD_3DP

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

    PROCEDURE:	load_wi_elpd_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      NO_PLOT:	Suppresses the display of the summary plot.
      MASTERFILE:	(string) full filename of master file.
      PREFIX:	(string) prefix for returned TPLOT variables.  Default is
    		'elpd'
      RESOLUTION:	Resolution to return in seconds.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_elpd_3dp.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_wi_elpd_3dp.pro)

## LOAD_WI_ELSP_3DP

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

    PROCEDURE:	load_wi_elsp_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'elsp'
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_elsp_3dp.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_wi_elsp_3dp.pro)

## LOAD_WI_EM_3DP

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

    PROCEDURE:	load_wi_em_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'wi_em_'
      POLAR:	If nonzero, compute velocities in polar coordinates.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_em_3dp.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_wi_em_3dp.pro)

## LOAD_WI_EPA

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

    PROCEDURE:	load_wi_epa
    PURPOSE:
       loads WIND Energetic Particle Analyser key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
    		none
    SEE ALSO:
      "make_cdf_index"

    CREATED BY:	Davin Larson
    FILE:  load_wi_epa.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_wi_epa.pro)

## LOAD_WI_FRM_3DP

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

    PROCEDURE:	load_wi_frm_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'wi_frm'
      RESOLUTION:	Resolution of data in seconds.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Peter Schroeder
    FILE:  load_wi_frm_3dp.pro
    LAST MODIFICATION: 97/02/26

(See ssl_general/key_param/load_wi_frm_3dp.pro)

## LOAD_WI_H0_MFI

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

    PROCEDURE:	load_wi_h0_mfi
    PURPOSE:
       loads WIND MAGNETOMETER high resolution data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      TIME_RANGE:  2 element vector specifying the time range
      POLAR:       Also computes the B field in polar coordinates.
      DATA:        Data returned in this named variable.
      HOUR:	Load hourly averages instead of 3 second data.
      MINUTE:	Load 60 second averages instead of 3 second data.
      NODATA:	Returns 0 if data exists for time range, otherwise returns 1.
      GSM:		If set, GSM data is retrieved.
      PREFIX:	(string) prefix for tplot variables.  Default is 'wi_'
      NAME:	(string) name for tplot variables. Default is 'wi_Bh'
      RESOLUTION:	Resolution to return in seconds.
      MASTERFILE:	(string) full filename of master file.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Peter Schroeder
    LAST MODIFIED:	@(#)load_wi_h0_mfi.pro	1.10 02/11/01

(See ssl_general/key_param/load_wi_h0_mfi.pro)

## LOAD_WI_HKP_3DP

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

    PROCEDURE:	load_wi_hkp_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'wi_hkp'
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Peter Schroeder
    LAST MODIFIED:	@(#)load_wi_hkp_3dp.pro	1.5 99/05/27

(See ssl_general/key_param/load_wi_hkp_3dp.pro)

## LOAD_WI_MFI

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

    PROCEDURE:	load_wi_mfi
    PURPOSE:
       loads WIND MAGNETOMETER Experiment key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'wi_'
      POLAR:       Also computes the B field in polar coordinates.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_mfi.pro
    LAST MODIFICATION: 02/11/01

(See ssl_general/key_param/load_wi_mfi.pro)

## LOAD_WI_OR

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

    PROCEDURE:	load_wi_or
    PURPOSE:
       loads WIND 3D Plasma Experiment orbit data for "tplot".
    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      RESOLUTION:  number of seconds resolution to return.
      POLAR:       Computes polar coordinates if set.
      PRE:		If set, use predicted (pre) data.
      NODATA:	Returns 1 if no data available.
      HEC:		If set, retrieve HEC data.
      VAR_LAB:	Return polar data and use as var_labels in tplot.
      GSM:		If set, retrieve GSM data.
      LAT:		If set, retrieve LAT data.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_or.pro
    LAST MODIFICATION: 99/12/28

(See ssl_general/key_param/load_wi_or.pro)

## LOAD_WI_PHSP_3DP

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

    PROCEDURE:	load_wi_phsp_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'phsp'
    SEE ALSO:
      "loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Peter Schroeder
    LAST MODIFICATION: @(#)load_wi_phsp_3dp.pro	1.4 99/05/27

(See ssl_general/key_param/load_wi_phsp_3dp.pro)

## LOAD_WI_PLSP_3DP

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

    PROCEDURE:	load_wi_plsp_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'plsp'
      MOMENT:	Load PESA Low moment data.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    LAST MODIFICATION: @(#)load_wi_plsp_3dp.pro	1.7 02/11/01

(See ssl_general/key_param/load_wi_plsp_3dp.pro)

## LOAD_WI_PM_3DP

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

    PROCEDURE:	load_wi_pm_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'wi_pm_'
      POLAR:       Computes polar coordinates if set.
      VTHERMAL:	If set, calculates and stores thermal velocity.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_pm_3dp.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_wi_pm_3dp.pro)

## LOAD_WI_SFPD

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

    PROCEDURE:	load_wi_sfpd
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'sfpd'
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_sfpd.pro
    LAST MODIFICATION: 02/04/19

(See ssl_general/key_param/load_wi_sfpd.pro)

## LOAD_WI_SFSP_3DP

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

    PROCEDURE:	load_wi_sfsp_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'sfsp'
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
     $LastChangedBy: davin-win $
     $LastChangedDate: 2009-07-02 12:11:10 -0700 (Thu, 02 Jul 2009) $
     $LastChangedRevision: 6380 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/key_param/load_wi_sfsp_3dp.pro $

(See ssl_general/key_param/load_wi_sfsp_3dp.pro)

## LOAD_WI_SOPD

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

    PROCEDURE:	load_wi_sopd
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'ehpd'

    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Peter Schroeder
    FILE:  load_wi_sopd.pro
    LAST MODIFICATION: 2000/9/13

(See ssl_general/key_param/load_wi_sopd.pro)

## LOAD_WI_SOSP_3DP

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

    PROCEDURE:	load_wi_sosp_3dp
    PURPOSE:
       loads WIND 3D Plasma Experiment key parameter data for "tplot".

    INPUTS:
      none, but will call "timespan" if time_range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      PREFIX:	Prefix for TPLOT variables created.  Default is 'sosp'
    SEE ALSO:
      "loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Peter Schroeder
    FILE:  load_wi_sosp_3dp.pro
    LAST MODIFICATION: 03/04/30

(See ssl_general/key_param/load_wi_sosp_3dp.pro)

## LOAD_WI_SP_MFI

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

    PROCEDURE:	load_wi_sp_mfi
    PURPOSE:
       loads WIND MAGNETOMETER 3 second data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      TIME_RANGE:  2 element vector specifying the time range
      POLAR:       Also computes the B field in polar coordinates.
      DATA:        Data returned in this named variable.
      NODATA:	Returns 0 if data exists for time range, otherwise returns 1.
      GSM:		If set, GSM data is retrieved.
      PREFIX:	(string) prefix for tplot variables.  Default is 'wi_'
      NAME:	(string) name for tplot variables. Default is 'wi_B3'
      RESOLUTION:	Resolution to return in seconds.
      MASTERFILE:	(string) full filename of master file.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_sp_mfi.pro
    VERSION: 1.17
    LAST MODIFICATION: 01/07/16

(See ssl_general/key_param/load_wi_sp_mfi.pro)

## LOAD_WI_SWE

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

    PROCEDURE:	load_wi_swe
    PURPOSE:
       loads WIND Solar Wind Experiment key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      POLAR:	If set, calculate and store velocity in polar
    		coordinates.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_swe.pro
    LAST MODIFICATION: 02/12/03

(See ssl_general/key_param/load_wi_swe.pro)

## LOAD_WI_WAV

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

    PROCEDURE:	load_wi_wav
    PURPOSE:
       loads WIND WAVES Experiment key parameter data for "tplot".

    INPUTS:	none, but will call "timespan" if time
    		range is not already set.
    KEYWORDS:
      DATA:        Raw data can be returned through this named variable.
      NVDATA:	Raw non-varying data can be returned through this variable.
      TIME_RANGE:  2 element vector specifying the time range.
      MASTERFILE:  (string) full file name to the master file.
      RESOLUTION:  number of seconds resolution to return.
      NE_FILTER:	Name of electron density variable to be used as filter.
      MOON:	Load moon position data.
      SOLAR:	Load solar data.
    SEE ALSO:
      "make_cdf_index","loadcdf","loadcdfstr","loadallcdf"

    CREATED BY:	Davin Larson
    FILE:  load_wi_wav.pro
    LAST MODIFICATION: 99/05/27

(See ssl_general/key_param/load_wi_wav.pro)

## PB5_TO_TIME

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

    WARNING!!! This Function is OBSOLETE try not to use it...
    FUNCTION: pb5_to_time
    INPUT: pb5 array from cdf files (especially kpd files)
    OUTPUT:  double array,  seconds since 1970

    SEE ALSO: 	"print_cdf_info",
    		"loadcdf"

    CREATED BY: 	Davin Larson
    LAST MODIFICATION:	@(#)pb5_to_time.pro	1.5 95/10/18

(See ssl_general/key_param/pb5_to_time.pro)

## REDUCE_DIMEN

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

    PROCEDURE: reduce_dimen,name,d,n1,n2,deflim=deflim,newname=newname
    PURPOSE:  reduces dimension of tplot variable for plotting.
    INPUT:
      name:  tplot handle of 3 dimensional data
      d:  dimension to sum over.  (1 or 2)
      n1: starting index
      n2: ending index

    Caution:  This procedure is still in development.
    Created by: Davin Larson,  Sept 1995
    File:  reduce_dimen.pro
    Version:  1.1
    Last Modified:  02/04/12

(See ssl_general/key_param/reduce_dimen.pro)

## SETFILEENV

[Previous Routine] [List of Routines]

    PROCEDURE: setfileenv
    PURPOSE:
       Sets up environment variables giving information on the location
       of master index files and file paths of WIND 3DP data.
      This should be the one and only file that needs editting for new file systems.
    CREATED BY:    Davin Larson and Peter Schroeder
    VERSION:   @(#)setfileenv.pro    1.24 03/09/20

(See ssl_general/key_param/setfileenv.pro)