This page was created by the IDL library routine mk_html_help2.

Last modified: Wed Apr 14 11:49:06 2010.

Directory Listing of Routines

Routine Descriptions

THM_CORRECTED_PXXM_POT

 [Next Routine] [List of Routines] 
NAME:
 thm_corrected_pxxm_pot
PURPOSE:
 Returns an offset corrected time-shifted value of the PXXM pot variable from
 MOM (on-board moment) files
CALLING SEQUENCE:
 thm_corrected_pxxm_pot,suffix=suffix
INPUT:
 No Input, the program detects the presence of variables
 'thx_pxxm_pot' and corrects each one.
OUTPUT:
 None explicit, tplot variables are created which are time-shifted
 and offset corrected pxxm_pot variables.
KEYWORDS:
 suffix = is set, this will be appended to the variable names, the
          default value is '_corrected'
 no_time_shift = if set, no time shifting is performed.
HISTORY:
 8-feb-2010, jmm, jimm@ssl.berkeley.edu
$LastChangedBy: jimm $
$LastChangedDate: 2010-02-09 15:37:45 -0800 (Tue, 09 Feb 2010) $
$LastChangedRevision: 7258 $ 
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_21/idl/themis/spacecraft/particles/moments/thm_corrected_pxxm_pot.pro $

(See themis/spacecraft/particles/moments/thm_corrected_pxxm_pot.pro)

THM_LOAD_MOM[1]

 [Previous Routine] [Next Routine] [List of Routines] 
 Themis moment calibration routine.
 Author: Davin Larson

(See themis/spacecraft/particles/moments/thm_load_mom.pro)

THM_LOAD_MOM[2]

 [Previous Routine] [Next Routine] [List of Routines] 
Procedure: THM_LOAD_MOM

Purpose:  Loads THEMIS moments data

keywords:
  probe = Probe name. The default is 'all', i.e., load all available probes.
          This can be an array of strings, e.g., ['a', 'b'] or a
          single string delimited by spaces, e.g., 'a b'
  datatype = The type of data to be loaded, for this case, there is only
          one option, the default value of 'mom', so this is a
          placeholder should there be more that one data type. 'all'
          can be passed in also, to get all variables.
  TRANGE= (Optional) Time range of interest  (2 element array), if
          this is not set, the default is to prompt the user. Note
          that if the input time range is not a full day, a full
          day's data is loaded
  level = the level of the data, the default is 'l1', or level-1
          data. A string (e.g., 'l2') or an integer can be used. 'all'
          can be passed in also, to get all levels.
  CDF_DATA: named variable in which to return cdf data structure: only works
          for a single spacecraft and datafile name.
  VARNAMES: names of variables to load from cdf: default is all.
  /GET_SUPPORT_DATA: load support_data variables as well as data variables
                      into tplot variables.
  /DOWNLOADONLY: download file but don't read it.
  /valid_names, if set, then this routine will return the valid probe, datatype
          and/or level options in named variables supplied as
          arguments to the corresponding keywords.
  files   named variable for output of pathnames of local files.
          WARNING: performing operations on the file paths returned by this
          keyword will break abstraction.  This can decrease the maintainability
          of code based upon thm_load_mom.
  /VERBOSE  set to output some useful info
  raw     if set, then load raw data, without calibrating
  type    added for compatibility with other THM_LOAD routines, if
          set to 'raw', then load raw data with no calibration,
          otherwise the default is to load calibrated data.
Example:
   thg_load_mom,/get_suppport_data,probe=['a', 'b']
Notes:
  Written by Davin Larson Jan 2007.
  Updated keywords KRB Feb 2007
  If you aren't getting data and can't figure out why try
  increasing your debug output level using:
  'dprint,setdebug=3'


 $LastChangedBy: jimm $
 $LastChangedDate: 2010-03-01 15:43:33 -0800 (Mon, 01 Mar 2010) $
 $LastChangedRevision: 7390 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_21/idl/themis/spacecraft/particles/moments/thm_load_mom.pro $

(See themis/spacecraft/particles/moments/thm_load_mom.pro)

THM_LOAD_MOM_L2

 [Previous Routine] [Next Routine] [List of Routines] 
Procedure: THM_LOAD_MOM_l2

Purpose:  Loads THEMIS Level 2 moments data

keywords:
  probe = Probe name. The default is 'all', i.e., load all available probes.
          This can be an array of strings, e.g., ['a', 'b'] or a
          single string delimited by spaces, e.g., 'a b'
  datatype = The type of data to be loaded, for this case, there is only
          one option, the default value of 'fgm', so this is a
          placeholder should there be more that one data type. 'all'
          can be passed in also, to get all variables.
  TRANGE= (Optional) Time range of interest  (2 element array), if
          this is not set, the default is to prompt the user. Note
          that if the input time range is not a full day, a full
          day's data is loaded
  /DOWNLOADONLY: download file but don't read it.
  /valid_names, if set, then this routine will return the valid probe, datatype
          and/or level options in named variables supplied as
          arguments to the corresponding keywords.
  files   named variable for output of pathnames of local files.
  /VERBOSE  set to output some useful info
Example:
   thg_load_mom,/get_suppport_data,probe=['a', 'b']
Notes:
  Temporary version, to avoid conflicts, but can read Level 2 data, jmm
 $LastChangedBy: jimm $
 $LastChangedDate: 2010-02-08 17:11:58 -0800 (Mon, 08 Feb 2010) $
 $LastChangedRevision: 7232 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_21/idl/themis/spacecraft/particles/moments/thm_load_mom_l2.pro $

(See themis/spacecraft/particles/moments/thm_load_mom_l2.pro)

THM_PART_MOMENTS

 [Previous Routine] [Next Routine] [List of Routines] 
 procedure: thm_part_moments

 Purpose: Calculates moments and spectra for themis particle distributions.

  For documentation on sun contamination correction keywords that
  may be passed in through the _extra keyword please see:
  thm_sst_remove_sunpulse.pro or thm_crib_sst_contamination.pro
  
 

 Author: Davin Larson 2007
 $Id: $

(See themis/spacecraft/particles/moments/thm_part_moments.pro)

THM_PART_MOMENTS2

 [Previous Routine] [Next Routine] [List of Routines] 
PROCEDURE: thm_part_moments2
PURPOSE: Calculates moments and spectra for themis particle distributions.

SEE ALSO:
	THM_CRIB_PART_GETSPEC, THM_PART_GETSPEC, THM_PART_GETANBINS, THM_LOAD_SST,
   THM_LOAD_ESA_PKT, THM_FAC_MATRIX_MAKE,THM_CRIB_SST_CONTAMINATION,
   THM_SST_REMOVE_SUNPULSE


NOTE:
  For documentation on sun contamination correction keywords that
  may be passed in through the _extra keyword please see:
  thm_sst_remove_sunpulse.pro or thm_crib_sst_contamination.pro

MODIFIED BY:	Bryan kerr from Davin Larson's thm_part_moments

  $LastChangedBy: pcruce $
  $LastChangedDate: 2008-07-21 17:38:17 -0700 (Mon, 21 Jul 2008) $
  $LastChangedRevision: 3298 $
  $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/particles/moments/thm_part_moments2.pro $

(See themis/spacecraft/particles/moments/thm_part_moments2.pro)

THM_PART_SPEC_CALC

 [Previous Routine] [List of Routines] 
 procedure: thm_part_spec_calc
 Purpose: Calculates moments and spectra for themis particle distributions.
 Author: Davin Larson 2007
 $Id: thm_part_spec_calc.pro 7232 2010-02-09 01:11:58Z jimm $

(See themis/spacecraft/particles/moments/thm_part_spec_calc.pro)