This page was created by the IDL library routine
mk_html_help2.
Last modified: Tue Aug 12 14:47:10 2008.
Themis moment calibration routine. Author: Davin Larson
(See themis/spacecraft/particles/moments/thm_load_mom.pro)
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 '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
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.
/VERBOSE set to output some useful info
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: 2008-05-05 12:28:15 -0700 (Mon, 05 May 2008) $
$LastChangedRevision: 2987 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/spacecraft/particles/moments/thm_load_mom.pro $
(See themis/spacecraft/particles/moments/thm_load_mom.pro)
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: 2008-04-24 11:36:54 -0700 (Thu, 24 Apr 2008) $
$LastChangedRevision: 2813 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/spacecraft/particles/moments/thm_load_mom_l2.pro $
(See themis/spacecraft/particles/moments/thm_load_mom_l2.pro)
procedure: thm_part_spec_calc Purpose: Calculates moments and spectra for themis particle distributions. Author: Davin Larson 2007 $Id: $
(See themis/spacecraft/particles/moments/thm_part_moments.pro)
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
MODIFIED BY: Bryan kerr from Davin Larson's thm_part_moments
HISTORY:
v0.3 12/04/07: Improved ability to better handle phi input from
THM_PART_GETSPEC.
v0.4 12/13/07: Added doangle, doenergy, phiwrap keywords, moved p_start_angle
and p_end_angle code from thm_part_getspec to here. Added
test to check whether all energy/angle bins are turned off.
v0.5 01/04/08: Changed tplotsuffix to suffix. Reduced banding of masked SST
data. DOANGLE keyword now specifies type of angular spectrum
and adds a corresponding suffix to an_eflux tplot variable
names. Now reduces en_eflux tplot variable to a single time
series when only one energy bin is requested. Fixed NAN bug
that corrupted SST energy bins that were turned off.
v0.6 01/09/08: Added reduced mode (peir) capability.
v0.6.3 01/15/08: All reduced modes implemented. Energy/angle maps now passed
to THM_PART_GETANBINS. *en_eflux tplot variables resized to
actual number of energies requested. Fixed bug that
prevented plotting of single-angle angular spectrograms.
v0.7 01/31/08: Added theta spectrograms capability. Angular spectra code now
generalized to calculate dOmega for arbitrary angle maps.
Fixed bug that didn't allow plotting of spectra for a single
angle bin.
v0.8 02/04/08: Alpha release of pitch angle spectragram capability.
v0.8.1 02/20/08: Fixed bug incorrectly weighting angle bins introduced in v0.7.
Fixed bug that didn't account for negative minphi angles.
Modified code to better handle 6-angle pser data.
v0.8.12 02/26/08: Fixed bug that senses incorrect angle mode at the beginning
of given timespan. Made output echoing current angle mode
more user friendly by outputting numbers of energies/angles.
v0.8.5 03/26/08: Added REGRID keyword. Fixed bug that caused the code to bomb
when a phi range is specified for theta spectragrams. Fixed
bug preventing theta and pitch angle plots from showing full
theta/pitch range requested by user. New algo to calc pitch
angle and gyrophase spectra that's accurate and fast.
v0.8.6 03/27/08: Fixed bug that bombs code when a requested data type doesn't
exist.
v0.9 04/08/08: Added ability to handle phi, theta, pitch, gyrophase angle
ranges for pitch and gyrophase spectra. Added OTHER_DIM keyword
for use by thm_fac_matrix_make. Added en_tnames and an_tnames
keywords. Added en_tnames and an_tnames keywords to make sure
autoplot sets angle bounds only for newly created tplot
variables.
v0.9.2 04/17/08: Fixed bug not allowing high regrid numbers (needed long int).
Fixed bug producing all zeros in pitch/gyro plots when narrow
phi/theta/energy ranges used.
v0.9.3 04/18/08: Fixed bug that improperly handled pa/gyro SST data when
rotated FAC bins fell into theta gaps of SST data between
+/- 5 degrees. Fixed bug with /NORMALIZE keyword not
properly handling NaNs for pitch and gyrophase plots.
v0.9.4 04/25/08: Comments update.
v1.0 05/09/08: Ready for Release v4.0.
VERSION: 1.0
$LastChangedBy: bckerr $
$LastChangedDate: 2008-05-09 11:02:12 -0700 (Fri, 09 May 2008) $
$LastChangedRevision: 3058 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/spacecraft/particles/moments/thm_part_moments2.pro $
(See themis/spacecraft/particles/moments/thm_part_moments2.pro)
procedure: thm_part_spec_calc Purpose: Calculates moments and spectra for themis particle distributions. Author: Davin Larson 2007 $Id: thm_part_spec_calc.pro 1605 2007-09-21 18:42:02Z davin-win $
(See themis/spacecraft/particles/moments/thm_part_spec_calc.pro)