This page was created by the IDL library routine mk_html_help2.

Last modified: Wed Jun 7 13:17:36 2017.

Directory Listing of Routines

Routine Descriptions

MMS_BASIC_DAYSIDE

 [Next Routine] [List of Routines] 
 script for basic dayside science (from EVA, first plot)
 
  This version is meant to work with v3.0.0+ of the FPI CDFs
  
 Plots on the figure include:
   1: FGM, srvy, GSM
   2. FGM magnitude
   3. FPI ion spectra
   4. FPI electron spectra
   5. FPI Ni (ion density)
   6. EDP, -log(scpot)
   7. FPI Vi (ion velocity, 3 components)
   8. (ExB)z, vperp(z)
   9. HPCA H+
   10. HPCA O+
   11. EDP fast
   12. EDP srvy, EPSD spectra (x) mms*_edp_hfesp_srvy_l2
   13. DSP, fast, bpsd omni
   
 $LastChangedBy: egrimes $
 $LastChangedDate: 2017-02-16 09:46:56 -0800 (Thu, 16 Feb 2017) $
 $LastChangedRevision: 22802 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_basic_dayside.pro $

(See projects/mms/examples/advanced/mms_basic_dayside.pro)

MMS_FPI_DIST_SLICE_COMPARISON_CRIB

 [Previous Routine] [Next Routine] [List of Routines] 
 mms_fpi_dist_slice_comparison_crib.pro

 This version is meant to work with v3.0.0+ of the FPI CDFs


 do you have suggestions for this crib sheet?
   please send them to egrimes@igpp.ucla.edu
  changed ion burst mode time range   SAB
  
 $LastChangedBy: egrimes $
 $LastChangedDate: 2017-02-16 10:06:43 -0800 (Thu, 16 Feb 2017) $
 $LastChangedRevision: 22803 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_fpi_dist_slice_comparison_crib.pro $

(See projects/mms/examples/advanced/mms_fpi_dist_slice_comparison_crib.pro)

MMS_ISEE_3D_CRIB_BASIC

 [Previous Routine] [Next Routine] [List of Routines] 
Purpose:
   A crib sheet for visualizing MMS 3D distribution function data (L2) 
   by using an interactive visualization tool, ISEE3D, developed by 
   Institute for Space-Earth Environmental Research (ISEE), Nagoya University, Japan.

Notes:
   Please use the latest version of SPEDAS bleeding edges. 
   Please use both 'bfield' and 'velocity' keywords to run isee3d. 

See also:
   mms_isee_3d_crib.pro

$LastChangedBy: egrimes $
$LastChangedDate: 2016-11-04 15:54:42 -0700 (Fri, 04 Nov 2016) $
$LastChangedRevision: 22310 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_isee_3d_crib_basic.pro $

(See projects/mms/examples/advanced/mms_isee_3d_crib_basic.pro)

MMS_LOAD_FPI_SUMMARY_CRIB

 [Previous Routine] [Next Routine] [List of Routines] 
 MMS FPI summary crib sheet
 
 mms_load_fpi_summary_crib.pro
 
 Note:
   This version is meant to work with v3.0.0 of the FPI CDFs
   and will not work with v2.1 and below
 
 do you have suggestions for this crib sheet?  
   please send them to egrimes@igpp.ucla.edu
 
    
 History:
 egrimes updated 8/23/2016, forked for v3 of the FPI CDFs;
     updated variable names for the new naming scheme
 
 
 egrimes updated 1/29/2016, changing to DMPA coordinates for 
     magnetic field data, now using position from DFG files, 
     instead of the ASCII/MEC files
 egrimes updated 12/9/2015, changed to GSM coordinates, adding 
     support for l2pre, switched to use QL data instead of SITL
 egrimes updated 23Sep2015, to set some metadata for spectra/PADs
 egrimes updated 8Sept2015
 BGILES UPDATED 1Sept2015
 BGILES UPDATED 31AUGUST2015
 SBoaardsen added query for brst or fast
 
 $LastChangedBy: egrimes $
 $LastChangedDate: 2017-02-16 10:06:43 -0800 (Thu, 16 Feb 2017) $
 $LastChangedRevision: 22803 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_load_fpi_summary_crib.pro $

(See projects/mms/examples/advanced/mms_load_fpi_summary_crib.pro)

MMS_MULTI_AXIS_FIGURE

 [Previous Routine] [Next Routine] [List of Routines] 

  This crib sheet shows how to create a figure with multiple panels, one
  of which contains 2 variables with independent axes (FPI DES perpendicular temp and density)
     i.e., line plots of two tplot variables in a single panel where one has its 
     y-axis/title on the left and the other has its y-axis/title on the right

 do you have suggestions for this crib sheet?
   please send them to egrimes@igpp.ucla.edu

 $LastChangedBy: egrimes $
 $LastChangedDate: 2017-03-27 13:01:47 -0700 (Mon, 27 Mar 2017) $
 $LastChangedRevision: 23048 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_multi_axis_figure.pro $

(See projects/mms/examples/advanced/mms_multi_axis_figure.pro)

MMS_MVA_CRIB

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

Purpose:
  A crib on showing how to transform tplot variables into 
  minimum variance analysis coordinates

Notes:


 $LastChangedBy: egrimes $
 $LastChangedDate: 2016-06-29 14:53:36 -0700 (Wed, 29 Jun 2016) $
 $LastChangedRevision: 21398 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_mva_crib.pro $

(See projects/mms/examples/advanced/mms_mva_crib.pro)

MMS_NEUTRAL_SHEET_CRIB

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

Purpose:
     Example of how to load MMS position data and retrieve the 
     distance from the S/C to the neutral sheet

$LastChangedBy: egrimes $
$LastChangedDate: 2016-11-07 12:34:30 -0800 (Mon, 07 Nov 2016) $
$LastChangedRevision: 22333 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_neutral_sheet_crib.pro $

(See projects/mms/examples/advanced/mms_neutral_sheet_crib.pro)

MMS_PART_PRODUCTS_CRIB

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


Purpose:
  Basic example on how to use mms_part_getspec to generate particle
  spectrograms and moments from level 2 MMS HPCA and FPI distributions.

$LastChangedBy: egrimes $
$LastChangedDate: 2017-05-03 15:55:00 -0700 (Wed, 03 May 2017) $
$LastChangedRevision: 23266 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_part_products_crib.pro $

(See projects/mms/examples/advanced/mms_part_products_crib.pro)

MMS_SLICE2D_FPI_CRIB

 [Previous Routine] [Next Routine] [List of Routines] 
Purpose:
  Crib sheet demonstrating how to obtain particle distribution slices 
  from MMS FPI data using spd_slice2d.
  
  This version is meant to work with v3.0.0+ of the FPI CDFs

  Run as script or copy-paste to command line.
    (examples containing loops cannot be copy-pasted to command line)


Field-aligned coordinate descriptions:
  'BV':  The x axis is parallel to B field; the bulk velocity defines the x-y plane
  'BE':  The x axis is parallel to B field; the B x V(bulk) vector defines the x-y plane
  'xy':  (default) The x axis is along the coordinate's x axis and y is along the coordinate's y axis
  'xz':  The x axis is along the coordinate's x axis and y is along the coordinate's z axis
  'yz':  The x axis is along the coordinate's y axis and y is along the coordinate's z axis
  'xvel':  The x axis is along the coordinate's x axis; the x-y plane is defined by the bulk velocity 
  'perp':  The x axis is the bulk velocity projected onto the plane normal to the B field; y is B x V(bulk)
  'perp_xy':  The coordinate's x & y axes are projected onto the plane normal to the B field
  'perp_xz':  The coordinate's x & z axes are projected onto the plane normal to the B field
  'perp_yz':  The coordinate's y & z axes are projected onto the plane normal to the B field

Notes:
  -FPI data is large and can be very memory intensive!  It is recommended 
   that no more than a few minutes of data is loaded at a time for ions
   and less for electrons.

$LastChangedBy: egrimes $
$LastChangedDate: 2017-02-16 09:46:56 -0800 (Thu, 16 Feb 2017) $
$LastChangedRevision: 22802 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_slice2d_fpi_crib.pro $

(See projects/mms/examples/advanced/mms_slice2d_fpi_crib.pro)

MMS_SLICE2D_HPCA_CRIB

 [Previous Routine] [Next Routine] [List of Routines] 
Purpose:
  Crib sheet demonstrating how to obtain particle distribution slices 
  from MMS HPCA data using spd_slice2d.

  Run as script or copy-paste to command line.
    (examples containing loops cannot be copy-pasted to command line)


Field-aligned coordinate descriptions:
  'BV':  The x axis is parallel to B field; the bulk velocity defines the x-y plane
  'BE':  The x axis is parallel to B field; the B x V(bulk) vector defines the x-y plane
  'xy':  (default) The x axis is along the coordinate's x axis and y is along the coordinate's y axis
  'xz':  The x axis is along the coordinate's x axis and y is along the coordinate's z axis
  'yz':  The x axis is along the coordinate's y axis and y is along the coordinate's z axis
  'xvel':  The x axis is along the coordinate's x axis; the x-y plane is defined by the bulk velocity 
  'perp':  The x axis is the bulk velocity projected onto the plane normal to the B field; y is B x V(bulk)
  'perp_xy':  The coordinate's x & y axes are projected onto the plane normal to the B field
  'perp_xz':  The coordinate's x & z axes are projected onto the plane normal to the B field
  'perp_yz':  The coordinate's y & z axes are projected onto the plane normal to the B field



$LastChangedBy: egrimes $
$LastChangedDate: 2016-05-25 13:37:25 -0700 (Wed, 25 May 2016) $
$LastChangedRevision: 21200 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_slice2d_hpca_crib.pro $

(See projects/mms/examples/advanced/mms_slice2d_hpca_crib.pro)

MMS_WAVPOL_CRIB

 [Previous Routine] [List of Routines] 

     mms_wavpol_crib


     This crib sheet demonstrates usage of the wave polarization routines
     using MMS SCM data
     
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. Strictly 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.


 Last updated by:
 O. Le Contel, LPP, in order to manage data gaps in the waveform
 using test written by K. Bromund (in thm_cal_scm.pro)
   
 For more informations about SCM data, please contact olivier.lecontel@lpp.polytechnique.fr


 $LastChangedBy: egrimes $
 $LastChangedDate: 2016-11-07 11:58:16 -0800 (Mon, 07 Nov 2016) $
 $LastChangedRevision: 22332 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/examples/advanced/mms_wavpol_crib.pro $

(See projects/mms/examples/advanced/mms_wavpol_crib.pro)