This page was created by the IDL library routine
mk_html_help2.
Last modified: Tue Aug 12 14:47:10 2008.
thm_crib_asi.pro usage: .run thm_crib_asi Written by Harald Frey $LastChangedBy: kenb-win2000 $ $LastChangedDate: 2007-02-11 21:26:08 -0500 (Sun, 11 Feb 2007) $ $LastChangedRevision: 379 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/examples/thm_crib_asi.pro $
(See themis/examples/thm_crib_asi.pro)
Batch File: THM_CRIB_EFI Purpose: Demonstrate the loading, calibration, and plotting of THEMIS EFI data. Calling Sequence: .run thm_crib_fbk, or using cut-and-paste. Arguements: None. Notes: None. $LastChangedBy: michf $ $LastChangedDate: 2008-03-26 16:54:11 -0700 (Wed, 26 Mar 2008) $ $LastChangedRevision: 2530 $ $URL $
(See themis/examples/thm_crib_efi.pro)
NAME: thm_crib_esa_read_gmoms PURPOSE: This crib shows how to extract the ground-based moments from level 2 ESA data files Note on variable/routine names: Particle variables/routines follow the naming convention th[a/b/c/d/e]_p[e/s][i/e][f/r/b] where th=themis, [a/b/c/d/e]=spacecraft, p=particle, [e/s]=ESA or SST instrument, [i/e]=ion/electron, [f/r/b]=full/reduced/burst distribution 3-dec-2007, jmm, jimm@ssl.berkeley.edu $LastChangedBy: jimm $ $LastChangedDate: 2007-12-03 17:40:09 -0800 (Mon, 03 Dec 2007) $ $LastChangedRevision: 2139 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/examples/thm_crib_esa_read_gmoms.pro $
(See themis/examples/thm_crib_esa_read_gmoms.pro)
Procedure: thm_crib_esa_slice2d
Propose: Example to call the pro file of thm_esa_slice2d. PNG or PS files of ESA (ion or
electron) Distribution Functions for the spacecraft (sc) and the type of data (full, reduced
or burst) would be automatically printed, and the output file would be a 2-D slice of the
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
(See themis/examples/thm_crib_esa_slice2d.pro)
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 $
(See themis/examples/thm_crib_export.pro)
Procedure: thm_crib_fac Purpose: A crib on showing how to transform into field aligned coordinates DSL coordinates Notes: $LastChangedBy: pcruce $ $LastChangedDate: 2008-04-28 18:04:28 -0700 (Mon, 28 Apr 2008) $ $LastChangedRevision: 2893 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/examples/thm_crib_fac.pro $
(See themis/examples/thm_crib_fac.pro)
Batch File: THM_CRIB_FBK Purpose: Demonstrate the loading, calibration, and plotting of THEMIS FBK (Filter Bank) spectral data. Calling Sequence: .run thm_crib_fbk, 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 $
(See themis/examples/thm_crib_fbk.pro)
Batch File: THM_CRIB_FFT Purpose: Demonstrate the loading, calibration, and plotting of THEMIS FFT spectra (ParticleBurst and WaveBurst) data Calling Sequence: .run thm_crib_fft, or using cut-and-paste. Arguements: None. Notes: None. Written by Patrick Cruce(with liberal copying from thm_crib_fit.pro)
(See themis/examples/thm_crib_fft.pro)
thm_crib_fgm.pro usage: .run thm_crib_fgm Written by Hannes Schwarzl and Ken Bromund $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-08-01 22:11:55 -0700 (Wed, 01 Aug 2007) $ $LastChangedRevision: 1319 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/examples/thm_crib_fgm.pro $
(See 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 $
(See themis/examples/thm_crib_fit.pro)
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 selected lines into an idl window. Or alternatively compile and run using the command: .RUN THM_CRIB_GMAG
(See themis/examples/thm_crib_gmag.pro)
pro thm_crib_mom This is an example crib sheet that will load onboard MOMent data. It also shows how to compute moments from the full distributions. Data is corrected for spacecraft potential. Open this file in a text editor and then use copy and paste to copy selected lines into an idl window. Or alternatively compile and run using the command: .RUN THM_CRIB_MOM
(See themis/examples/thm_crib_mom.pro)
Procedure: thm_crib_mva Purpose: A crib on showing how to transform into minimum variance analysis coordinates Notes: $LastChangedBy: pcruce $ $LastChangedDate: 2007-08-28 10:40:01 -0700 (Tue, 28 Aug 2007) $ $LastChangedRevision: 1501 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/examples/thm_crib_mva.pro $
(See 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/tags/tdas_4_01/idl/themis/examples/thm_crib_overplot.pro $
(See 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.
The START_ANGLE 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'.
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
VERSION: 1.0
$LastChangedBy: bckerr $
$LastChangedDate: 2008-05-09 11:03:19 -0700 (Fri, 09 May 2008) $
$LastChangedRevision: 3059 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/examples/thm_crib_part_getspec.pro $
(See themis/examples/thm_crib_part_getspec.pro)
Name: thm_crib_plotxy
Purpose:crib to demonstrate capabilities of plotxy
Notes: run it by compiling in idl and then typing ".go"
or copy and paste.
$LastChangedBy: pcruce $
$LastChangedDate: 2008-02-06 13:43:58 -0800 (Wed, 06 Feb 2008) $
$LastChangedRevision: 2352 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/tplot/tplotxy.pro $
(See themis/examples/thm_crib_plotxy.pro)
Name: thm_crib_plotxyz
Purpose:crib to demonstrate capabilities of plotxyz
Notes: run it by compiling in idl and then typing ".go"
or copy and paste.
SEE ALSO: bin1d.pro,bin2d.pro,plotxyz.pro
$LastChangedBy: pcruce $
$LastChangedDate: 2008-02-06 13:43:58 -0800 (Wed, 06 Feb 2008) $
$LastChangedRevision: 2352 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/tplot/tplotxy.pro $
(See themis/examples/thm_crib_plotxyz.pro)
********************************************************************** thm_crib_scm.pro : IDL batch file to get, clean and calibrate SCM data with thm_cal_scm K. Bromund O. Le Contel & P. Robert, CETP ********************************************************************** $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-10-02 09:25:57 -0700 (Tue, 02 Oct 2007) $ $LastChangedRevision: 1646 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_4_01/idl/themis/examples/thm_crib_scm.pro $
(See themis/examples/thm_crib_scm.pro)
pro thm_sst_crib This is an example crib sheet that will load Solid State Telescope data. Open this file in a text editor and then use copy and paste to copy selected lines into an idl window. Or alternatively compile and run using the command: .RUN THM_SST_CRIB Author: Davin Larson Modified: 2007-07-19 by Matt Davis. This a simplified version of Davin's original crib and is intended to demonstrate the very basics of loading in the SST energy spectrograms. The more comprehensive crib can be found with the SST routines in: idl/themis/spacecraft/particles/SST/thm_sst_crib.pro $Id: thm_crib_sst.pro 1586 2007-09-18 12:42:50Z davin-win $
(See themis/examples/thm_crib_sst.pro)
Batch File: THM_CRIB_STATE Purpose: Demonstrate the loading, coordinate transformation, plotting and labeling with state data Calling Sequence: .run thm_crib_state, or using cut-and-paste. Arguements: None. Notes: None. $LastChangedBy: pcruce $ $LastChangedDate: 2008-05-03 14:34:46 -0700 (Sat, 03 May 2008) $ $LastChangedRevision: 2976 $ $URL $
(See themis/examples/thm_crib_state.pro)
Name: thm_crib_tplotxy
Purpose:crib to demonstrate capabilities of tplotxy
Notes: run it by compiling in idl and then typing ".go"
or copy and paste.
$LastChangedBy: pcruce $
$LastChangedDate: 2008-02-06 13:43:58 -0800 (Wed, 06 Feb 2008) $
$LastChangedRevision: 2352 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/tplot/tplotxy.pro $
(See themis/examples/thm_crib_tplotxy.pro)
**********************************************************************
thm_crib_twavpol.pro : with twavpol.pro
**********************************************************************
This version stores these outputs as tplot variables with the
specified prefix
These are follows:
Wave power: On a linear scale, at this stage no units
Degree of Polarisation:
This is similar to a measure of coherency between the input
signals, however unlike coherency it is invariant under
coordinate transformation and can detect pure state waves
which may exist in one channel only.100% indicates a pure
state wave. Less than 70% indicates noise. For more
information see J. C. Samson and J. V. Olson 'Some comments
on the description of the polarization states
of waves' Geophys. J. R. Astr. Soc. (1980) v61 115-130
Wavenormal Angle:
the angle between the direction of minimum
variance calculated from the complex off diagonal
elements of the spectral matrix and the Z direction
of the input
ac field data. For magnetic field data in
field aligned coordinates this is the
wavenormal angle assuming a plane wave.
Ellipticity:The ratio (minor axis)/(major axis) of the
ellipse transcribed by the field variations of the
components transverse to the Z direction. The sign
indicates the direction of rotation of the field vector in
the plane. Negative signs refer to left-handed
rotation about the Z direction. In the field
aligned coordinate system these signs refer to
plasma waves of left and right handed
polarisation.
Helicity:Similar to Ellipticity except defined in terms of the
direction of minimum variance instead of Z. Stricltly the Helicity
is defined in terms of the wavenormal direction or k.
However since from single point observations the
sense of k cannot be determined, helicity here is
simply the ratio of the minor to major axis transverse to the
minimum variance direction without sign.
Written by : Kaori(I'll remember to get her last name soon)
$LastChangedBy: pcruce $
$LastChangedDate: 2007-12-06 14:56:54 -0800 (Thu, 06 Dec 2007) $
$LastChangedRevision: 2161 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/misc/tplotxy.pro $
(See themis/examples/thm_crib_twavpol.pro)
NAME:
thm_fgm_fit_correlate_tplot.pro
Purpose:
Uses thm_correlation_shift.pro to do a correlation shift
analysis on the vector lengths(math not cs vectors) of a
selected fgm mnemonic and fit data
CATEGORY:
THEMIS-SOC
CALLING SEQUENCE:
pro thm_fgm_fit_correlate_tplot,fit_name, fgm_name, store_name, correlation_floor = correlation_floor, point_number = point_number, lag_step_number = lag_step_number, time_step_size = time_step_size, bin_size = bin_size
INPUTS:
fit_name: the tplot name of the fit data to be compared
fgm_name: the tplot name of the fgm_data to be
compared
store_name: the name of a tplot variable in which to store the result
correlation_floor: optional, if set filters all results where
the correlation between functions is too poor(default:0.0)
point_number: optional, the minimum number of points of
overlap necessary to try correlating a bin(default:10)
lag_step_number: optional, checks plus or minus lag_steps * time steps
to correlate the vectors (default:5)
time_step_size: optional, the size of the time step to use when
interpolating and correlating the vectors, in
seconds(default:1/8 seconds)
bin_size: optional, the size of each bin in seconds
(default:60 seconds)
OUTPUTS:
stores the time and the shift values in the selected tplot_var
KEYWORDS:
COMMENTS: This function will probably die horribly if time
values are not monotonic.
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY:
Written by: Patrick Cruce(pcruce@gmail.com)
2007-06-06 V1.0
KNOWN BUGS: tcs_vector_length doesn't filter NANs so it may output
arithmetic warnings
(See themis/examples/thm_fgm_fit_correlate_tplot.pro)