This page was created by the IDL library routine
mk_html_help2.
Last modified: Tue May 7 11:36:21 2013.
NAME:
thm_apply_esa_mom_dtc
PURPOSE:
Corrects ESA on-board moments for dead time. Note that this will
apply the dead-time correction to all of the moments for the given
probe and species.
CALLING SEQUENCE:
thm_apply_esa_mom_dtc, probe=probe, instrument=instrument,
out_suffix=out_suffix,in_suffix=in_suffix
INPUT:
All via keyword
OUTPUT:
None explicit, a number of tplot variables are created.
KEYWORDS:
probe='a','b','c','d' or 'e'
instrument='peim' or 'peem', similar in use to the 'instrument'
keyword for thm_part_moments
use_esa_mode = 'f','r', or 'b', use this mode for the ESA data to get
the dead time correction, the default is 'f'
out_suffix= a suffix to add to new tplot variables for the
moments. The default is the null string, so that
variables are overwritten.
in_suffix= if set, only varaibles with this suffix will be
corrected, to avoid correcting variables that have been
loaded without corrections.
HISTORY:
13-may-2011, jmm, jimm@ssl.berkeley.edu
27-may-2011, jmm, dropped save_esa_vars keywords, to avoid suffix
confusion, also passes out_suffix keyword through to
thm_esa_dtc4mom
9-aug-2011, jmm, added in_suffix keyword
$LastChangedBy: aaflores $
$LastChangedDate: 2012-01-26 16:43:39 -0800 (Thu, 26 Jan 2012) $
$LastChangedRevision: 9625 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/spacecraft/particles/moments/thm_apply_esa_mom_dtc.pro $
(See themis/spacecraft/particles/moments/thm_apply_esa_mom_dtc.pro)
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: aaflores $
$LastChangedDate: 2012-01-26 16:43:39 -0800 (Thu, 26 Jan 2012) $
$LastChangedRevision: 9625 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/spacecraft/particles/moments/thm_corrected_pxxm_pot.pro $
(See themis/spacecraft/particles/moments/thm_corrected_pxxm_pot.pro)
NAME:
thm_esa_dtc4mom
PURPOSE:
calculates a dead-time correction value for ESA particle moments,
which then can be applied to on-board MOM data.
CALLING SEQUENCE:
thm_esa_dtc4mom, probe=probe, trange=trange
INPUT:
All via keyword
OUTPUT:
None explicit, a number of tplot variables are created.
KEYWORDS:
probe='a','b','c','d' or 'e'
trange = an input time range, otherwise the current time range is
used.
noload = if set, make the assumption that the data is there, and
don't load it
use_esa_mode = 'f','r', or 'b', use this mode for the ESA data to get
the dead time correction, the default is 'f'
scpot_correct = if set, use thm_load_esa_pot to correct for SC
potential in moments. The default is to avoid the correction
HISTORY:
10-may-2011, jmm, jimm@ssl.berkeley.edu
27-may-2011, jmm, This version deletes the temporary ESA moments
$LastChangedBy: jimmpc1 $
$LastChangedDate: 2012-02-08 13:35:47 -0800 (Wed, 08 Feb 2012) $
$LastChangedRevision: 9695 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/spacecraft/particles/moments/thm_esa_dtc4mom.pro $
(See themis/spacecraft/particles/moments/thm_esa_dtc4mom.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 '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.
coord = (optional) String denoting coordinates system to transform
valid 3-vectors into (e.g. 'gsm').
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.
/NO_TIME_CLIP: Disables time clipping, which is the default
/dead_time_correct: If set, then calculate dead time correction
based on ESA moments, this is the default
for L2 input
/no_dead_time_correct: If set, do not calculate a dead time
correction based on ESA ground-based
moments, this is the default for L1
data. If both the no_dead and dead
keywords are set, then NO correction is
applied.
Example:
thm_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'
New calibrations for ESA moments solar wind mode and non-solar wind
mode added Jul 23,2010 by pcruce (under Jim McFadden's direction.)
Detailed descriptions of methods in code. These updated calibrations correct
most of the discrepancy between ground and on-board moments.
Some uncorrectable difference remains because on-board calculations
don't account for variation in energy sweep, different spacecraft
potential, and efficiency.
$LastChangedBy: nikos $
$LastChangedDate: 2012-12-13 18:20:20 -0800 (Thu, 13 Dec 2012) $
$LastChangedRevision: 11357 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/spacecraft/particles/moments/thm_load_mom.pro $
(See themis/spacecraft/particles/moments/thm_load_mom.pro)
Themis moment calibration routine. Author: Davin Larson
(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
/NO_TIME_CLIP: Disables time clipping, which is the default
Example:
thm_load_mom,/get_suppport_data,probe=['a', 'b']
Notes:
Temporary version, to avoid conflicts, but can read Level 2 data, jmm
$LastChangedBy: aaflores $
$LastChangedDate: 2012-06-19 16:27:38 -0700 (Tue, 19 Jun 2012) $
$LastChangedRevision: 10597 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/spacecraft/particles/moments/thm_load_mom_l2.pro $
(See themis/spacecraft/particles/moments/thm_load_mom_l2.pro)
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
Keywords:
dist_array: Provide an array of data instead of having thm_part_moments load the data directly.
This allows preprocessing/sanitization operations to be performed prior to moment generation.
See thm_part_dist_array.pro, thm_part_conv_units.pro
fractional_counts: Flag to keep the ESA unit conversion routine from rounding to an even
number of counts when removing the dead time correction.
(no effect if input data already in counts, no effect on SST data)
ESA PEER/PEIR/PEIF Background Removal Keywords:
/bdnd_remove: Turn on ESA background removal.
bgnd_type(Default 'anode'): Set to string naming background removal type:
'angle','omni', or 'anode'.
bgnd_npoints(Default = 3): Set to the number of lowest values points to average over when determining background.
bgnd_scale(Default=1): Set to a scaling factor that the background will be multiplied by before it is subtracted
BACKGROUND REMOVAL(BGND) Description, Warnings and Caveats(from Vassilis Angelopoulos):
This code allows for keywords that permit omni-directional or anode-dependent
background removal from penetrating electrons in the ESA ion and electron
detectors. Anode-dependent subtraction is used when possible by default,
i.e., when angle information is available; but user has full control by
keyword specification. Default bgnd estimates use 3 lowest counts/s values.
Scaling of the background (artificial scaling) can also allow playing with
background estimates to account for noise statistics in the background itself.
The parameters that have worked well for me during high bgnd levels are:
,/bgnd_remove, bgnd_type='anode', bgnd_npoints=3, bgnd_scale=1.5
The same keywords when used in thm_part_getspec, and thm_part_moments
are understood and passed to the data extraction routines, such that
they will do the removal before computing moments or spectra.
This background subtraction to be used at the inner magnetosphere,
or when SST electron fluxes indicate presence of significant electron
fluxes at the satellite (injections). At quiet times the code tends to remove
real fluxes, so beware.
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,THM_CRIB_SST_CONTAMINATION,
THM_SST_REMOVE_SUNPULSE
dist_array: Provide an array of data instead of having thm_part_getspec/thm_part_moments2 load the data directly.
This allows preprocessing/sanitization operations to be performed prior to moment generation.
See thm_part_dist_array.pro, thm_part_conv_units.pro
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)
HELPER Function. (Main routine below)
Purpose: Checks returnd error messages from underlying routines
against previously returned messages. If the message
is new it will be printed and added to the stored
message array.
This should allow messages generated within the loop
over time to be printed once instead of hundreds or
thousands of times.
Usage: thm_part_moments2_msg, msg_ball, msg, dlevel=1
Arguments:
msg_ball: string array of all previously printed messages
msg: string or string array of newly returned message(s)
Keywords:
dlevel: Not a formal keyword, but passed through _extra
Notes: This routine assumes it will get correct input,
please do not disappoint it.
(See themis/spacecraft/particles/moments/thm_part_moments2.pro)
PURPOSE:
Apply eclipse corrections (when present) to 3D data structures
within thm_part_moments.pro
ARGUMENTS:
dat: Valid 3D data structure
KEYWORDS:
domega: Array of weights used inside the Wind routines to calculate
vector and tensore components. This array should be set to
0 if a correction is being applied or if a correction was
applied on the last loop.
eclipse: Flag used by this routine to determine when an ecplise
starts or ends (assists output messages). Should be set
to 1 at the start of an eclipse and 0 at the end.
previous: Stores the delta phi value from the last time through the
loop. Helps determine when domega should be zeroed.
NOTES:
(See themis/spacecraft/particles/moments/thm_part_moments_apply_eclipse.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 7232 2010-02-09 01:11:58Z jimm $
(See themis/spacecraft/particles/moments/thm_part_spec_calc.pro)
NAME:
thm_read_mom_cal_file
PURPOSE:
reads in the text version of the MOM cal
file. tha_l1_mom_cal_v02.txt.
Note that the cal file for THEMIS A is used for the data for all
probes.
CALLING SEQUENCE:
caldata = thm_read_mom_cal_file(probe=probe)
INPUT:
all via keyword
OUTPUT:
caldata = a structure containing scalings for normal (mom_scale) and
solar wind (mom_scale_sw1) modes. Also contains a single
value used for scaling the spacecraft potential
(scpot_scale)
KEYWORDS:
probe = in here in case somebody decides to create a separate file
for each probe.
cal_file = the name of the calibration file, output so that
thm_load_mom message doesn't crash
HISTORY:
4-Oct-2010, jmm, jimm@ssl.berkeley.edu
$LastChangedBy: jimm $
$LastChangedDate: 2010-10-29 16:01:14 -0700 (Fri, 29 Oct 2010) $
$LastChangedRevision: 7891 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/spacecraft/particles/moments/thm_read_mom_cal_file.pro $
(See themis/spacecraft/particles/moments/thm_read_mom_cal_file.pro)