This page was created by the IDL library routine `mk_html_help2`.

Last modified: Tue Aug 5 18:17:40 2025.

# Directory Listing of Routines

# projects/mms/sitl/bss

- MMS_BSS_LIST
  To generate a list of segments from the back-structure.
- MMS_BSS_TABLE
  To create a table of segments in the back-structure
- MMS_GET_ROI
  To return the SROI timerange closest to the specified time "t".

# Routine Descriptions

## MMS_BSS_LIST

[Next Routine] [List of Routines]

     NAME: mms_bss_list

     PURPOSE:
       To generate a list of segments from the back-structure.
       'bss' stands for 'burst segment status' which is the official
       name of the back-structure.

     USAGE:
       If you call this procedure with no keyword, then you will get
       a list of all segments from the entire mission (but 'bad' segments
       excluded). Please use keywords to narrow down the list.

     EXAMPLES:

       (1) A list of segments during a specific time range.

           MMS> mms_bss_list,trange=['2015-08-15/12:00','2015-08-15/16:00']

       (2) A list of 'overwritten' segments

           MMS> mms_bss_list,/overwritten

     KEYWORDS:
       BSS: back-structure created by mms_bss_query
       OVERWRITTEN: Set this keyword to show overwritten segments only.
       BAD:         Set this keyword to show bad segments only. Bad segments mean
                    segments with TRIMMED, SUBSUMED, DELETED statuses.
       _EXTRA: See 'mms_bss_query' for other optional keywords

     CREATED BY: Mitsuo Oka  Aug 2015

     $LastChangedBy: moka $
     $LastChangedDate: 2020-07-19 10:13:49 -0700 (Sun, 19 Jul 2020) $
     $LastChangedRevision: 28911 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/sitl/bss/mms_bss_list.pro $

(See projects/mms/sitl/bss/mms_bss_list.pro)

## MMS_BSS_TABLE

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

     NAME: mms_bss_table

     PURPOSE:
       To create a table of segments in the back-structure
       organized by categories. 'bss' stands for 'burst segment status'
       which is the official name of the back-structure.

     USAGE:
       With no keyword, this program diplays a table of segments from the
       entire mission. Use the keywords to select certain types of segments.

     EXAMPLE:
       To make a table of PENDING segmnents,

         MMS> mms_bss_table, /isPending

       Pending segments are actually non-FINISHED segments (if bad segments
       are removed). So, the same result can be obtained by

         MMS> mms_bss_table, exclude='FINISHED'

     KEYWORDS:
       BSS: back-structure created by mms_bss_query
       TRANGE: narrow the time range. It can be in either string or double.
       OVERWRITTEN: Set this keyword to show overwritten segments only.
       BAD:         Set this keyword to show bad segments only. Bad segments mean
                    segments with TRIMMED, SUBSUMED, DELETED statuses. Some of
                    the bad segments have infinite number of buffers. In such
                    cases, 'Nbuffs' and 'min' will be displayed as *******.
       CONSOLE: If set to 1 (DEFAULT), output in console
       JSON: If set to 1, output in a json file
       DIR: directory for the json output
       _EXTRA: See 'mms_bss_query' for other optional keywords

     CREATED BY: Mitsuo Oka  Aug 2015

     $LastChangedBy: moka $
     $LastChangedDate: 2016-10-06 15:43:35 -0700 (Thu, 06 Oct 2016) $
     $LastChangedRevision: 22058 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/sitl/bss/mms_bss_table.pro $

(See projects/mms/sitl/bss/mms_bss_table.pro)

## MMS_GET_ROI

[Previous Routine] [List of Routines]

     NAME:  mms_get_roi

     PURPOSE:
       To return the SROI timerange closest to the specified time "t".
       If "t" is a large enough time range, then all ROIs within the time range
       will be returned.

     CALLING SEQUENCE: roi = mms_get_roi( t [, num] )

     INPUT:
        t (optional) Can be either string or double.
                     Can be either a scalar or a 2-element array.
                     If omitted, current time (UTC) will be used as the input.

     OUTPUT:
        (2 x N) array indicating matched ROI time ranges.
        N is the number of matched ROIs.

     OTHER OUTPUT:
        num : the number of matched ROIs

     KEYWORDS:
        NEXT: Returns the next ROI (does not overlap with the input timerange)
        PREVIOUS: Returns the previous ROI (does not overlap with the input timerange)

     EXAMPLES:

       (1) Find all ROIs within a time range

       MMS> print, time_string(mms_get_roi(['2015-12-01/00:00','2015-12-07/24:00']))

       (2) Find the ROI closest to time 2015-12-02/06:00

       MMS> print, time_string(mms_get_roi('2015-12-02/06:00'))

       (3) Find the ROI just after 2015-12-02/06:00

       MMS> print, time_string(mms_get_roi('2015-12-02/06:00',/next))

     CREATED BY: moka in Oct 2015
     UPDATED after introducing dynamic SITL window: May 2020

     $LastChangedBy: moka $
     $LastChangedDate: 2020-05-24 15:23:34 -0700 (Sun, 24 May 2020) $
     $LastChangedRevision: 28734 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/sitl/bss/mms_get_roi.pro $

(See projects/mms/sitl/bss/mms_get_roi.pro)