This page was created by the IDL library routine
mk_html_help2.
Last modified: Wed May 14 01:32:12 2008.
3-D distribution function. The detailed slice properties (such as the definition of x and y
axis, the two limits of the slice, etc) can be found in thm_esa_slice2d.
Remarks: You can select a start time and an end time to produce a set of distribution function plots
with the time increments (specified by INCREMENT) no less than 3 seconds. For each plot, it
is allowed to have a longer interval than 3 seconds (specified by TIMEINTERVAL) with the
distribution function being averaged during the whole time interval. Also you need to designate
the folder (specified by OUTPUTFOLDER) that you wish to put the output files.
LAST EDITED BY XUZHI ZHOU 4-24-2008
Batch File: THM_CRIB_EXPORT
Purpose: Demonstrate tplot export functions
Calling Sequence:
.run thm_crib_export, or using cut-and-paste.
Arguements:
None.
Notes:
None.
$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-08-01 22:11:55 -0700 (Wed, 01 Aug 2007) $
$LastChangedRevision: 1319 $
$URL $
Procedure: thm_crib_fac
Purpose: A crib on showing how to transform into field aligned coordinates DSL coordinates
Notes:
$LastChangedBy: jimm $
$LastChangedDate: 2008-05-13 18:02:53 -0700 (Tue, 13 May 2008) $
$LastChangedRevision: 3080 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/examples/thm_crib_fac.pro $
Batch File: THM_CRIB_FBK
(See themis/state/thm_cotrans.pro)
te: 2007-08-01 22:11:55 -0700 (Wed, 01 Aug 2007) $ $LastChangedRevision: 1319 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/examples/thm_crib_fgm.pro $ Batch File: THM_CRIB_FIT Purpose: Demonstrate the loading, calibration, and plotting of THEMIS FIT (On-Board E- and B-Field SpinFit) data. Calling Sequence: .run thm_crib_fit, or using cut-and-paste. Arguements: None. Notes: None. Written by John Bonnell $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-08-01 22:11:55 -0700 (Wed, 01 Aug 2007) $ $LastChangedRevision: 1319 $ $URL $ pro thm_crib_gmag This is an example crib sheet that will load ground mag data. Open this file in a text editor and then use copy and paste to copy
(See themis/state/thm_interpolate_state.pro)
E keyword specifies the start of the y-axis (phi). This is useful to center the spectra plot on the y-axis at a particular phi angle. If this keyword is not set, the y-axis starts at the first angle input to the PHI keyword. Use the ENERGY and ANGLE keywords to specify whether to create tplot variables for energy and/or angular spectra. The ANGLE keyword is also used to specify the type of angular spectrum created (e.g. phi, theta, pa, gyro). If neither of ENERGY and ANGLE keywords are specified, then both are turned on and the angular spectrum type defaults to phi. When set, the AUTOPLOT keyword enables to the tplot variables to be automatically plotted using some simple code located at the end of THM_PART_GETSPEC. The tplot variables created are properly formatted by THM_PART_MOMENTS2 and THM_PART_GETSPEC whether or not AUTOPLOT is set. Setting AUTOPLOT will also create a default tplot title containing the theta, phi, and energy ranges used to create the plot. After reading in the user's input, THM_PART_GETSPEC then calls THM_LOAD_SST and/or THM_LOAD_ESA_PKT to load the particle data. THM_PART_MOMENTS2 is then called to format the spectra data based on the user's input and create the tplot variables. THM_PART_MOMENTS2 calls THM_PART_GETANBINS in order to determine which energy/angle bins should be turned on/off. If there's a mode change, THM_PART_MOMENTS2 will re-call THM_PART_GETANBINS to account for any changes in the mode's anglemap. Pitch angle (ANGLE='pa') and gyrophase (ANGLE='gyro') spectra are generated by gridding a globe in a field-aligned coordinate (FAC) system at regular intervals along pitch (latitude) and gyrophase (longitude) as specified by the REGRID keyword. These FAC angle bins are then rotated back into the native DSL coordinates of the particle distribution data. The flux assigned to a given FAC angle bin is determined by native angle bin to which the center of FAC angle bin has been rotated. So if a FAC angle bin center is rotated into the 88th angle bin of the probe's particle distribution data, the flux for that FAC angle bin is the same as the flux in angle bin 88 of the particle distribution data. This rotation occurs for each time sample of the probe's particle data. The size of the FAC system grid is specified with the REGRID = [m,n], a two- element array in which the first element of the array specifies the number of grid elements in the gyrophase (longitudinal) direction while the second element sets he number of grid elements in the pitch (latitudinal) direction. Increasing the number of elements in the FAC system grid will increase the accuracy of the pitch angle and gyrophase angle spectra as it decreases the degree to which the FAC bins overlap into one or more native distribution angle bin. Suitable numbers for m and n are numbers like 2^k. So far, k=2-6 has been tested and work. Other numbers will work provided 180/n and 360/m are rational. The PITCH and GYROPHASE keywords set the angle range of interest for pitch angle and gyrophase spectra plots similarly to the THETA and PHI keywords. Setting PHI and THETA will affect pitch angle and gyrophase plot, but the PITCH and GYROPHASE keywords will be ignored when the ANGLE keyword is set to 'PHI' or 'THETA'. The OTHER_DIM keyword specifies the second axis for the field aligned coordinate system, necessary when plotting pitch angle or gyrophase spectra. See THM_FAC_MATRIX_MAKE for more info. If the keyword is not set in THM_PART_GETSPEC, OTHER_DIM defaults to 'xgse'.
(See themis/state/thm_load_state.pro)
os/thmsoc/trunk/idl/themis/examples/thm_crib_mva.pro $
NAME: thm_crib_overplot
PURPOSE: this crib describes how to generate overview plots
if there are any arguments or features for these
procedures you would like to request, please feel
free to ask.
$LastChangedBy: pcruce $
$LastChangedDate: 2008-01-30 12:39:05 -0800 (Wed, 30 Jan 2008) $
$LastChangedRevision: 2328 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/examples/thm_crib_overplot.pro $
PROCEDURE: thm_crib_part_getspec
***** A copy and paste crib *****
PURPOSE:
A crib showing how to create energy and angular spectrograms using
THM_PART_GETSPEC.
DETAILS
THM_PART_GETSPEC is a wrapper that takes user input and creates tplot
variables containing energy and/or angular spectra of ESA and SST data. The
tplot variables created end in 'en_eflux' for energy spectra and 'an_eflux'
plus a suffix corresponding to the type of angular spectrum specified by
the ANGLE keyword for angular spectra by default. The user can select a
range of probe(s), PROBE, and time range, TRANGE, of interest. The energy
range of interest, ERANGE, is specified in eV. The user can also choose to
create tplot variable for one or more data types, DATA_TYPE. The phi, PHI,
and theta, THETA, ranges of interest, specified in DSL coordinates, can also
be input, by the user. SUFFIX specifies a string that will be added to the
*an_eflux*' tplot variables.
If the phi range is greater than 360 degrees, then the phi bins at the
beginning of the phi range are added and wrapped around the end of phi
range. For example, if phi=[0,420], the phi bins corresponding to 0-60
degrees are appended to the top of the plot.
(See themis/state/thm_load_state2.pro)
ing the number of elements in the FAC system grid will increase the accuracy of the pitch angle and gyrophase angle spectra as it decreases the degree to which the FAC bins overlap into one or more native distribution angle bin. Suitable numbers for m and n are numbers like 2^k. So far, k=2-6 has been tested and work. Other numbers will work provided 180/n and 360/m are rational. The PITCH and GYROPHASE keywords set the angle range of interest for pitch angle and gyrophase spectra plots similarly to the THETA and PHI keywords. Setting PHI and THETA will affect pitch angle and gyrophase plot, but the PITCH and GYROPHASE keywords will be ignored when the ANGLE keyword is set to 'PHI' or 'THETA'. The OTHER_DIM keyword specifies the second axis for the field aligned coordinate system, necessary when plotting pitch angle or gyrophase spectra. See THM_FAC_MATRIX_MAKE for more info. If the keyword is not set in THM_PART_GETSPEC, OTHER_DIM defaults to 'xgse'. Also, when calculating pitch angle and/or gyrophase spectra THM_FAC_MATRIX_MAKE might require the data be de-gapped in order to calculate the rotation matrix. If so, the /degap keyword and tdegap keywords can passed in the call to THM_PART_GETSPEC. See TDEGAP and THM_FAC_MATRIX_MAKE for more info.
(See themis/state/thm_spin_phase.pro)
THM_PART_GETSPEC, OTHER_DIM defaults to 'xgse'.
Also, when calculating pitch angle and/or gyrophase spectra
THM_FAC_MATRIX_MAKE might require the data be de-gapped in order to
calculate the rotation matrix. If so, the /degap keyword and tdegap keywords
can passed in the call to THM_PART_GETSPEC. See TDEGAP and
THM_FAC_MATRIX_MAKE for more info.
The /NORMALIZE keyword will normalize the flux for each time sample in a
spectra plot to values between 0 and 1.
The /MASK keyword is used to enable masking of sun pulse in SST data.
BINS2MASK is an array of SST angle bin numbers that will be masked with a
NaN to eliminate sun contamination. If BINS2MASK is called without setting
the /MASK keyword, the /MASK is turned on. If /MASK is set, and BINS2MASK is
not set, the masked bins are determined by whatever the default is in
THM_SST_PS** (currently [0,16,32,48] in for full SST data, and no masking
for reduced SST data).
NOTES:
- All angles are in DSL coordinates
- All datatypes are now valid
- Theta input must satisfy: -90 < theta[0] < theta[1] < 90
- Phi input must be specified in ascending order in degrees
(e.g. [270, 450] or [-90, 90] to specify the 'daylight' hemisphere in DSL
coordinates)
- Incorporates improvements contained in v1.0
CREATED BY: Bryan Kerr
(See themis/state/thm_sunpulse.pro)