This page was created by the IDL library routine mk_html_help2.

Last modified: Thu Aug 6 12:53:14 2020.

Directory Listing of Routines

Routine Descriptions

MMS_LOAD_BRST_SEGMENTS

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

 PURPOSE:
         Loads the brst segment intervals into a bar that can be plotted

 KEYWORDS:
         trange:       time range of interest
         suffix:       suffix to append to the tplot variable of the burst segments bar
         start_times:  returns an array of unix times (double) containing the start for each burst interval
         end_times:    returns an array of unix times (double) containing the end of each burst interval

$LastChangedBy: egrimes $
$LastChangedDate: 2020-05-19 12:45:03 -0700 (Tue, 19 May 2020) $
$LastChangedRevision: 28714 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/mms/common/data_status_bar/mms_load_brst_segments.pro $

(See projects/mms/common/data_status_bar/mms_load_brst_segments.pro)

MMS_LOAD_FAST_SEGMENTS

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

 PURPOSE:
         Loads the fast segment intervals into a bar that can be plotted

 KEYWORDS:
         trange:       time range of interest
         suffix:       suffix to append to the fast segments bar tplot variable
         start_times:  returns an array of unix times (double) containing the start for each fast interval
         end_times:    returns an array of unix times (double) containing the end of each fast interval
 
 NOTES:
         WARNING: this routine no longer loads the correct fast segments for later in the mission; 
                  for loading fast segment bars correctly throughout the entire mission, please
                  use the wrapper: spd_mms_load_bss, which switches between this routine (for dates 
                  before 6Nov15) and the new SRoI code (mms_load_sroi_segments) for dates on and after 6Nov15 
 
$LastChangedBy: egrimes $
$LastChangedDate: 2020-07-28 14:48:00 -0700 (Tue, 28 Jul 2020) $
$LastChangedRevision: 28949 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/mms/common/data_status_bar/mms_load_fast_segments.pro $

(See projects/mms/common/data_status_bar/mms_load_fast_segments.pro)

MMS_LOAD_SROI_SEGMENTS

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

 PURPOSE:
         Loads the SRoI segment intervals into a bar that can be plotted

 KEYWORDS:
         trange:       time range of interest
         probe:        spacecraft probe # to load the SRoIs for (default: 1)
         suffix:       suffix to append to the SRoI segments bar tplot variable
         start_times:  returns an array of unix times (double) containing the start for each SRoI interval
         end_times:    returns an array of unix times (double) containing the end of each SRoI interval

$LastChangedBy: egrimes $
$LastChangedDate: 2020-06-19 11:30:13 -0700 (Fri, 19 Jun 2020) $
$LastChangedRevision: 28790 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/mms/common/data_status_bar/mms_load_sroi_segments.pro $

(See projects/mms/common/data_status_bar/mms_load_sroi_segments.pro)

MMS_UPDATE_BRST_INTERVALS

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

  This routine will create a save file, mms_brst_intervals.sav in
  the directory:

        !mms.local_data_dir + '/'

 containing a structure with the tags "start_times" and "end_times".
 These are the start/end times of the brst  intervals as
 specified in the mms_burst_data_segment.csv file

 This is meant to be run by an automated script that rebuilds the
 mms_brst_intervals.sav file and uploads it to spedas.org:

     http://spedas.org/mms/mms_brst_intervals.sav


 $LastChangedBy: egrimes $
 $LastChangedDate: 2018-02-15 08:59:05 -0800 (Thu, 15 Feb 2018) $
 $LastChangedRevision: 24717 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/mms/common/data_status_bar/mms_update_brst_intervals.pro $

(See projects/mms/common/data_status_bar/mms_update_brst_intervals.pro)

MMS_UPDATE_FAST_INTERVALS

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

  This routine will create a save file, mms_fast_intervals.sav in 
  the directory: 
  
        !mms.local_data_dir + '/abs/'
        
 containing a structure with the tags "start_times" and "end_times".
 These are the start/end times of the fast survey intervals as 
 specified in the automated burst system (ABS) files
 
 This is meant to be run by an automated script that rebuilds the 
 mms_fast_intervals.sav file and uploads it to spedas.org:
 
     http://spedas.org/mms/mms_fast_intervals.sav

 Note: in order to run this script, you need a sav file in
       your working directory called 'mms_login_info_for_updating_abs.sav'
       containing your login information. 
 
 $LastChangedBy: egrimes $
 $LastChangedDate: 2018-05-11 11:17:19 -0700 (Fri, 11 May 2018) $
 $LastChangedRevision: 25199 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/mms/common/data_status_bar/mms_update_fast_intervals.pro $

(See projects/mms/common/data_status_bar/mms_update_fast_intervals.pro)

SPD_MMS_LOAD_BSS

 [Previous Routine] [List of Routines] 
 NAME: spd_mms_load_bss

 PURPOSE: To display horizontal color bars indicating burst data availability

 KEYWORDS: 
 
   trange:          time frame for bss
   datatype:        type of BSS data ['fast','burst','status','fom']. default includes 'fast' and 'burst'
   include_labels:  set this flag to have the horizontal bars labeled
   probe:           probe # for SRoI bars (used as fast survey segments after 6Nov15; default: 1)
 
 NOTES: 
   "bss" stands for Burst Segment Status (a term used in the MMS-SDC2SITL-ICD document). 
   By default, it produces the following tplot-variables.
   
   1. mms_bss_fast  (red bar) 
      the time periods of fast-survey mode (more precisely, the time periods of ROIs)
      
   2. mms_bss_burst (blue bar) 
      the time periods (segments) selected by SITLs for burst data
      
   3. mms_bss_status (green bar) 
      Represents segment statuses. 

   4. mms_bss_fom (histogram, black) 
      The height represents the FOM values (i.e., priority level defined by SITLs)

   5. To labels bss bars set the include_labels flag, /include_labels
   
   See examples/basic/spd_mms_load_bss_crib.pro for examples. 
   
 CREATED BY: Mitsuo Oka   Oct 2015
 
 Updated by egrimes, June 2016
 Updated by egrimes, July 2020 - to get the fast segment bars using the new SRoI code instead of 
      the older fast segment routine for dates on and after 6Nov15 (this is because the older fast segment
      bars routine returns incorrect segments for later in the mission, but the SRoI routine doesn't work 
      for dates before 6Nov15)

$LastChangedBy: egrimes $
$LastChangedDate: 2020-07-30 12:28:00 -0700 (Thu, 30 Jul 2020) $
$LastChangedRevision: 28956 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/projects/mms/common/data_status_bar/spd_mms_load_bss.pro $

(See projects/mms/common/data_status_bar/spd_mms_load_bss.pro)