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

Last modified: Mon Aug 25 17:13:29 2025.

# Directory Listing of Routines

# projects/mms/common/gui

- MMS_GUI_DATA_PRODUCTS
  Returns list of tplot variables to be loaded into the GUI
- MMS_GUI_DATARATES
  Returns list of valid data rates for a given instrument
- MMS_GUI_DATATYPES
  Returns list of valid datatypes for a given instrument, data rate and level
- MMS_GUI_LEVELS
  Returns list of valid levels for a given instrument
- MMS_OVERVIEW_PLOT
- MMS_UI_FILECONFIG
  A widget that allows the user to set some of the !mms environmental variables. The user
- MMS_UI_GEN_OVERPLOT
  Widget wrapper for mms_overview_plot used to create MMS overview plots in the GUI
- MMS_UI_LOAD_DATA[1]
  The SPEDAS Load Data plugin for the MMS mission
- MMS_UI_LOAD_DATA[2]
- MMS_UI_LOAD_DATA[2]
- MMS_UI_LOAD_DATA[3]
- MMS_UI_LOAD_DATA[4]
- MMS_UI_LOAD_DATA_IMPORT
  This routine acts as a wrapper around the load data

# Routine Descriptions

## MMS_GUI_DATARATES

[Next Routine] [List of Routines]

     FUNCTION:
         mms_gui_datarates

     PURPOSE:
         Returns list of valid data rates for a given instrument
          (for populating the data rate listbox in the GUI)

     $LastChangedBy: egrimes $
     $LastChangedDate: 2017-07-13 07:42:47 -0700 (Thu, 13 Jul 2017) $
     $LastChangedRevision: 23599 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_gui_datarates.pro $

(See projects/mms/common/gui/mms_gui_datarates.pro)

## MMS_GUI_DATATYPES

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

     FUNCTION:
         mms_gui_datatypes

     PURPOSE:
         Returns list of valid datatypes for a given instrument, data rate and level
          (for populating the datatype listbox in the GUI)

     $LastChangedBy: egrimes $
     $LastChangedDate: 2016-07-29 09:01:51 -0700 (Fri, 29 Jul 2016) $
     $LastChangedRevision: 21571 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_gui_datatypes.pro $

(See projects/mms/common/gui/mms_gui_datatypes.pro)

## MMS_GUI_DATA_PRODUCTS

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

     FUNCTION:
         mms_gui_data_products

     PURPOSE:
         Returns list of tplot variables to be loaded into the GUI

     NOTES:
         This routine will need to be updated when:
         1) variable names change
         2) adding new levels or data rates to the GUI

     $LastChangedBy: egrimes $
     $LastChangedDate: 2018-04-16 08:53:47 -0700 (Mon, 16 Apr 2018) $
     $LastChangedRevision: 25049 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_gui_data_products.pro $

(See projects/mms/common/gui/mms_gui_data_products.pro)

## MMS_GUI_LEVELS

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

     FUNCTION:
         mms_gui_levels

     PURPOSE:
         Returns list of valid levels for a given instrument
          (for populating the level listbox in the GUI)

     $LastChangedBy: egrimes $
     $LastChangedDate: 2016-06-28 08:28:42 -0700 (Tue, 28 Jun 2016) $
     $LastChangedRevision: 21380 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_gui_levels.pro $

(See projects/mms/common/gui/mms_gui_levels.pro)

## MMS_OVERVIEW_PLOT

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

     Procedure:
             mms_overview_plot

     Purpose:
             Generates overview plots for MMS data

     Keywords:
             date: start date for the overview plot
             duration: duration of the overview plot, in days; defaults to 1-day
             directory: local directory to save the overview plots to (should end with '/' or '\')
             device: change the plot device for cron plotting (for cron use device = 'z')
             geopack_lshell: calculate L-shell by tracing field lines
                 to the equator instead of using the dipole assumption
             skip_ae_idx: set this keyword to skip downloading/plotting AE data
             error: 1 indicates an error, 0 for no error

        * Keywords specific to creating overview plots in the GUI:
             gui_overplot: overview plot was created in the GUI
             oplot_calls: pointer to an int for tracking calls to overview plots - for
                 avoiding overwriting tplot data already loaded during this session
              import_only: Used to make this routine import the data into the gui, but not plot it.

     Notes:

     $LastChangedBy: nikos $
     $LastChangedDate: 2023-11-27 09:29:13 -0800 (Mon, 27 Nov 2023) $
     $LastChangedRevision: 32257 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_overview_plot.pro $

(See projects/mms/common/gui/mms_overview_plot.pro)

## MMS_UI_FILECONFIG

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

    NAME:
     mms_ui_fileconfig

    PURPOSE:
     A widget that allows the user to set some of the !mms environmental variables. The user
     can save the changes permanently to file, reset to default values, or cancel any changes
     made since the panel was displayed.

    HISTORY:

    $LastChangedBy: jwl $
    $LastChangedDate: 2022-03-01 13:51:02 -0800 (Tue, 01 Mar 2022) $
    $LastChangedRevision: 30635 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_ui_fileconfig.pro $

(See projects/mms/common/gui/mms_ui_fileconfig.pro)

## MMS_UI_GEN_OVERPLOT

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

     NAME:
      mms_ui_gen_overplot

     PURPOSE:
      Widget wrapper for mms_overview_plot used to create MMS overview plots in the GUI

     CALLING SEQUENCE:
      success = mms_ui_gen_overplot(gui_id, historyWin, oplot_calls, callSequence,$
                                    windowStorage, windowMenus, loadedData, drawObject)

     INPUT:
      gui_id:  The id of the main GUI window.
      historyWin:  The history window object.
      oplot_calls:  The number calls to mms_ui_gen_overplot
      callSequence: object that stores sequence of procedure calls that was used to load data
      windowStorage: standard windowStorage object
      windowMenus: standard menu object
      loadedData: standard loadedData object
      drawObject: standard drawObject object

     OUTPUT:
      none

    $LastChangedBy: jwl $
    $LastChangedDate: 2022-03-04 13:45:18 -0800 (Fri, 04 Mar 2022) $
    $LastChangedRevision: 30651 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_ui_gen_overplot.pro $

(See projects/mms/common/gui/mms_ui_gen_overplot.pro)

## MMS_UI_LOAD_DATA[1]

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

    NAME:
          mms_ui_load_data

    PURPOSE:
          The SPEDAS Load Data plugin for the MMS mission

     NOTES:
          Need to add multiple select capabilities to probes and types
          mms_load_state can handle '*' for probes rates and types
          mms_load_data may not yet have this implemented

    HISTORY:
    $LastChangedBy: egrimes $
    $LastChangedDate: 2018-03-02 10:00:15 -0800 (Fri, 02 Mar 2018) $
    $LastChangedRevision: 24821 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_ui_load_data.pro $

(See projects/mms/common/gui/mms_ui_load_data.pro)

## MMS_UI_LOAD_DATA[2]

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

    Purpose:
      Dynamically populate rate, level, and datatypes widgets
      for science instruments.

    Keywords:
      rate: force rate widget to be updated
      level: force level widget to be updated

    Usage:
      Called by mms_ui_load_data_update_widgets

(See projects/mms/common/gui/mms_ui_load_data.pro)

## MMS_UI_LOAD_DATA[2]

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

    Purpose:
      Update rate, level, and datatype widgets when state is selected.

    Usage:
      Called by mms_ui_load_data_update_widgets

(See projects/mms/common/gui/mms_ui_load_data.pro)

## MMS_UI_LOAD_DATA[3]

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

    Purpose:
      Dynamically update rate, level, and datatype widgets as needed
      based on instrument and any rate and level selections.

    Calling Sequence:
      mms_ui_load_data_update_widgets, state, [,/rate] [,/level] [,/set_state]

    Usage:
      This should be called any time the instrument, rate, or level
      widgets are updated.

      Widgets with valid selections will be queried for input and
      those without will be populated. Datatype will always be
      populated.

      Widget with valid selections can be forced to repopulate via
      the corresponding keyword.

    Notes:
      Science instruments are populated dynamically, state is static
      and has its own special case.

(See projects/mms/common/gui/mms_ui_load_data.pro)

## MMS_UI_LOAD_DATA[4]

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

    Purpose:
      Widget event handler for mms_ui_load_data.

(See projects/mms/common/gui/mms_ui_load_data.pro)

## MMS_UI_LOAD_DATA_IMPORT

[Previous Routine] [List of Routines]

    NAME:
      mms_ui_load_data_import

    PURPOSE:
      This routine acts as a wrapper around the load data
          routine for MMS, mms_load_data. It is called by the
          SPEDAS plugin mms_ui_load_data, and imports the data
          loaded by mms_load_data into the SPEDAS GUI

    HISTORY:

    ;$LastChangedBy: egrimes $
    $LastChangedDate: 2019-08-27 15:31:14 -0700 (Tue, 27 Aug 2019) $
    $LastChangedRevision: 27684 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/mms/common/gui/mms_ui_load_data_import.pro $

(See projects/mms/common/gui/mms_ui_load_data_import.pro)