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_LOAD_MEC

[Next Routine] [List of Routines]
 PROCEDURE:
         mms_load_mec

 PURPOSE:
         Load the attitude/ephemeris data from the LANL MEC files

 KEYWORDS:
         trange:       time range of interest [starttime, endtime] with the format
                       ['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day
                       ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss']
         probes:       list of probes, valid values for MMS probes are ['1','2','3','4'].
                       if no probe is specified the default is probe '1'
         datatype:     valid datatypes include ['ephts04d', 'epht89q', 'epht89d']
                       default is 'ephts04d'
         data_rate:    instrument data rates include ['srvy', 'brst']. The default is 'srvy'.
 
         local_data_dir: local directory to store the CDF files; should be set if
                       you're on *nix or OSX, the default currently assumes Windows (c:\data\mms\)
         source:       specifies a different system variable. By default the MMS mission system
                       variable is !mms
         get_support_data: load support data (defined by support_data attribute in the CDF)
         tplotnames:   names for tplot variables
         no_color_setup: don't setup graphics configuration; use this keyword when you're
                       using this load routine from a terminal without an X server running
         time_clip:    clip the data to the requested time range; note that if you do not use
                       this keyword you may load a longer time range than requested
         no_update:    set this flag to preserve the original data. if not set and newer data is
                       found the existing data will be overwritten
         suffix:       appends a suffix to the end of the tplot variable name. this is useful for
                       preserving original tplot variable.
         varformat:    should be a string (wildcards accepted) that will match the CDF variables
                       that should be loaded into tplot variables
         cdf_filenames:  this keyword returns the names of the CDF files used when loading the data
         cdf_version:  specify a specific CDF version # to load (e.g., cdf_version='4.3.0')
         latest_version: only grab the latest CDF version in the requested time interval
                       (e.g., /latest_version)
         major_version: only open the latest major CDF version (e.g., X in vX.Y.Z) in the requested time interval
         min_version:  specify a minimum CDF version # to load
         cdf_records:  specify a number of records to load from the CDF files.
                       e.g., cdf_records=1 only loads in the first data point in the file
                       This is especially useful for loading S/C position for a single time
         spdf:         grab the data from the SPDF instead of the LASP SDC (only works for public access)
         available:    returns a list of files available at the SDC for the requested parameters
                       this is useful for finding which files would be downloaded (along with their sizes) if
                       you didn't specify this keyword (also outputs total download size)
         versions:     this keyword returns the version #s of the CDF files used when loading the data
         always_prompt: set this keyword to always prompt for the user's username and password;
                       useful if you accidently save an incorrect password, or if your SDC password has changed

 EXAMPLES:
         to load/plot the S/C position data for probe 3 on 2/20/2016:
         MMS> mms_load_mec, probe=3, trange=['2016-02-20', '2016-02-21']
         MMS> tplot, 'mms3_mec_r_gsm'

 NOTES:
 
    Have questions regarding this load routine, or its usage?
          https://groups.google.com/forum/#!forum/spedas
          
          
$LastChangedBy: egrimes $
$LastChangedDate: 2017-01-12 14:22:41 -0800 (Thu, 12 Jan 2017) $
$LastChangedRevision: 22583 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/mec/mms_load_mec.pro $

(See projects/mms/mec/mms_load_mec.pro)


MMS_MEC_FIX_METADATA

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE:
         mms_mec_fix_metadata

 PURPOSE:
         Helper routine for setting metadata of MEC variables



$LastChangedBy: egrimes $
$LastChangedDate: 2017-05-01 13:00:22 -0700 (Mon, 01 May 2017) $
$LastChangedRevision: 23255 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/mec/mms_mec_fix_metadata.pro $

(See projects/mms/mec/mms_mec_fix_metadata.pro)


MMS_MEC_FORMATION_PLOT

[Previous Routine] [List of Routines]
 PROCEDURE:
       mms_mec_formation_plot

 PURPOSE:
       Creates a plot showing the spacecraft formation
       at a given time
       
 INPUT:
       time:   string containing the date and time to create 
               the plot for. e.g., 'YYYY-MM-DD/HH:MM'
 
 KEYWORDS:
       projection:   project the spacecraft positions 
               onto all planes
       
       xy_projection: project the S/C positions onto the XY plane
       xz_projection: project the S/C positions onto the XZ plane
       yz_projection: project the S/C positions onto the YZ plane
               
       quality_factor: include the tetrahedron quality factor
       coord: coordinate system of the formation plot; default is GSE
              valid options are eci, gsm, geo, sm, gse, gse2000
       xyz: a 3 x 3 rotation matrix for rotating position data to an
            arbitrary coordinate system from the coordinate system
            defined by coord 
       lmn: a 3 x 3 rotation matrix for rotating position data to an
            LMN coordinate system from the coordinate system
            defined by coord (do not use with xyz keyword)
       sundir: direction of the sun (+x) in the figure (right or left); default is 'right'
               (+N direction for LMN coordinate)
               
 EXAMPLES:
       mms_mec_formation_plot, '2016-1-08/2:36', /xy_projection, coord='gse'
       
       should create something like:
       https://lasp.colorado.edu/mms/sdc/public/data/sdc/mms_formation_plots/mms_formation_plot_20160108023624.png
       
       Sun to the left:
       mms_mec_formation_plot, '2016-1-08/2:36', /xy_projection, coord='gse', sundir='left'
       
       Specify an LMN transformation:
       mms_mec_formation_plot, '2016-1-08/2:36', /xy_projection, coord='gse', lmn=[[0.00,0.00,1.00],[0.00,-1.00,0.00],[1.00,0.00,0.00]], sundir='left'
       
       Specify an XYZ transformation:
       mms_mec_formation_plot, '2016-1-08/2:36', /xy_projection, coord='gse', xyz=[[0.00,0.00,1.00],[0.00,-1.00,0.00],[1.00,0.00,0.00]], sundir='left'

 HISTORY:
       August 2016: Lots of updates from Naritoshi Kitamura
 
       The original copy of this comes from the 
       SDC version, which was written by Kris Larsen 
       and Kim Kokkonen at LASP

 $LastChangedBy: egrimes $
 $LastChangedDate: 2016-08-09 12:53:09 -0700 (Tue, 09 Aug 2016) $
 $LastChangedRevision: 21625 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_00/projects/mms/mec/mms_mec_formation_plot.pro $

(See projects/mms/mec/mms_mec_formation_plot.pro)