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

Last modified: Tue Sep 2 18:17:29 2025.

# Directory Listing of Routines

# projects/themis/spedas_plugin/load_data

- THM_UI_LOAD_DATA2OBJ
  A widget interface to load CDF data for whatever instrument
- THM_UI_LOAD_DATA_FILE
  A widget interface for loading THEMIS data into the SPEDAS GUI
- THM_UI_LOAD_DATA_FILE_COORD_SEL.PRO
  Controls actions that occur when Output Coordinates menu is selected. Called
- THM_UI_LOAD_DATA_FILE_DEL.PRO
  Controls deleting of loaded data from "Loaded Data" list. Called by
- THM_UI_LOAD_DATA_FILE_ITYPE_SEL.PRO
  Controls actions that occur when Instrument Type menu is selected. Called by
- THM_UI_LOAD_DATA_FILE_L1_SEL.PRO
  Controls actions that occur when selecting items in Level 1 box. Called by
- THM_UI_LOAD_DATA_FILE_L2_SEL.PRO
  Controls actions that occur when selecting items in Level 2 box. Called by
- THM_UI_LOAD_DATA_FILE_LOAD.PRO
  Loads SPEDAS data by calling spd_ui_load_data_fn. Called by
- THM_UI_LOAD_DATA_FILE_LOADLIST.PRO
  ROUTINE IS DEPRECATED. WAS MAINTAINING COPIES OF SELECTION THAT WERE ALREADY MAINTAINED ELSEWHERE.
- THM_UI_LOAD_DATA_FILE_OBS_SEL.PRO
  Controls actions that occur when selecting items in probe/station box. Called
- THM_UI_VALID_DATATYPE
  get valid datatype names from thm_load_* routines, using the

# Routine Descriptions

## THM_UI_LOAD_DATA2OBJ

[Next Routine] [List of Routines]

    NAME:
      thm_ui_load_data2obj

    PURPOSE:
      A widget interface to load CDF data for whatever instrument

    CALLING SEQUENCE:
      thm_ui_load_data2obj, st_time, en_time, $
                                  dtype = dtype, $
                                  observ = observ, $
                                  scm_cal = scm_cal, $
                                  outcoord = outcoord, $
                                  loadedData = loadedData, $
                                  historyWin=historyWin, $
                                  statusText=statusText, $
                                  state_gui_id=state_gui_id
    INPUT:
      st_time, en_time = start and end times in seconds from
                       1-jan-1970 0:00
    KEYWORDS:
      dtype =  the type of data, a string, of form 'instrument/datatype/datalevel',
               the default is 'gmag/mag/l2'
      observ = the probe or ground station requested (string array) (this replaces
               the station, astation, and probe keywords).
      scm_cal = a structure containing calibration parameters
      outcoord = requested output coordinates as set in spd_ui THEMIS: Load Data
                 panel
      loadedData = loaded data object
      historyWin = history window object
      statusText = status bar object
      state_gui_id = gui_id of main gui window

    OUTPUT:
      none

    HISTORY:
      07-sep-2008, bck  begin modification for use in spd_gui from spd_ui_load_data_fn

    $LastChangedBy: jwl $
    $LastChangedDate: 2021-12-09 14:46:31 -0800 (Thu, 09 Dec 2021) $
    $LastChangedRevision: 30458 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data2obj.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data2obj.pro)

## THM_UI_LOAD_DATA_FILE

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

    NAME:
      thm_ui_load_data_file

    PURPOSE:
      A widget interface for loading THEMIS data into the SPEDAS GUI

    CALLING SEQUENCE:
      thm_ui_load_data_file, tab_id, loadedData, historyWin, statusText, $
                             treeCopyPtr, trObj, callSequence, $
                             loadTree=loadList, timeWidget=timeid

    INPUT:
      tab_id:  The widget id of the tab.
      loadedData:  The loadedData object.
      historyWin:  The history window object.
      statusText:  The status bar object for the main Load window.
      treeCopyPtr:  Pointer variable to a copy of the load widget tree.
      trObj:  The GUI timerange object.
      callSequence:  Reference to GUI call sequence object

    OUTPUT:
      loadTree = The Load widget tree.
      timeWidget = The time widget object.

    NOTES:

    $LastChangedBy: jwl $
    $LastChangedDate: 2022-03-01 16:32:46 -0800 (Tue, 01 Mar 2022) $
    $LastChangedRevision: 30638 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file.pro)

## THM_UI_LOAD_DATA_FILE_COORD_SEL.PRO

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

    NAME:
     thm_ui_load_data_file_coord_sel.pro

    PURPOSE:
     Controls actions that occur when Output Coordinates menu is selected.  Called
     by thm_ui_load_data_file event handler.

    CALLING SEQUENCE:
     thm_ui_load_data_file_coord_sel, state

    INPUT:
     state     State structure

    OUTPUT:
     None

    HISTORY:
    $LastChangedBy: egrimes $
    $LastChangedDate: 2015-04-09 14:56:06 -0700 (Thu, 09 Apr 2015) $
    $LastChangedRevision: 17278 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_coord_sel.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_coord_sel.pro)

## THM_UI_LOAD_DATA_FILE_DEL.PRO

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

    NAME:
     thm_ui_load_data_file_del.pro

    PURPOSE:
     Controls deleting of loaded data from "Loaded Data" list.  Called by
     thm_ui_load_data_file event handler.

    CALLING SEQUENCE:
     thm_ui_load_data_file_del, state

    INPUT:
     state     State structure

    OUTPUT:
     None

    $LastChangedBy: egrimes $
    $LastChangedDate: 2015-04-09 13:39:19 -0700 (Thu, 09 Apr 2015) $
    $LastChangedRevision: 17268 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_del.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_del.pro)

## THM_UI_LOAD_DATA_FILE_ITYPE_SEL.PRO

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

    NAME:
     thm_ui_load_data_file_itype_sel.pro

    PURPOSE:
     Controls actions that occur when Instrument Type menu is selected.  Called by
     thm_ui_load_data_file event handler.

    CALLING SEQUENCE:
     thm_ui_load_data_file_itype_sel, state

    INPUT:
     state     State structure

    OUTPUT:
     None

    $LastChangedBy: crussell $
    $LastChangedDate: 2021-04-02 10:57:42 -0700 (Fri, 02 Apr 2021) $
    $LastChangedRevision: 29845 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_itype_sel.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_itype_sel.pro)

## THM_UI_LOAD_DATA_FILE_L1_SEL.PRO

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

    NAME:
     thm_ui_load_data_file_l1_sel.pro

    PURPOSE:
     Controls actions that occur when selecting items in Level 1 box.  Called by
     thm_ui_load_data_file event handler.

    CALLING SEQUENCE:
     thm_ui_load_data_file_l1_sel, state

    INPUT:
     state     State structure

    OUTPUT:
     None

    HISTORY:

    $LastChangedBy: nikos $
    $LastChangedDate: 2015-11-05 10:38:06 -0800 (Thu, 05 Nov 2015) $
    $LastChangedRevision: 19267 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_l1_sel.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_l1_sel.pro)

## THM_UI_LOAD_DATA_FILE_L2_SEL.PRO

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

    NAME:
     thm_ui_load_data_file_l2_sel.pro

    PURPOSE:
     Controls actions that occur when selecting items in Level 2 box.  Called by
     thm_ui_load_data_file event handler.

    CALLING SEQUENCE:
     thm_ui_load_data_file_l2_sel, state

    INPUT:
     state     State structure

    OUTPUT:
     None

    HISTORY:

    $LastChangedBy: egrimes $
    $LastChangedDate: 2015-04-09 14:56:06 -0700 (Thu, 09 Apr 2015) $
    $LastChangedRevision: 17278 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_l2_sel.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_l2_sel.pro)

## THM_UI_LOAD_DATA_FILE_LOAD.PRO

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

    NAME:
     thm_ui_load_data_file_load.pro

    PURPOSE:
     Loads SPEDAS data by calling spd_ui_load_data_fn.  Called by
     thm_ui_load_data_file event handler.

    CALLING SEQUENCE:
     thm_ui_load_data_file_load, state, event

    INPUT:
     state     State structure
     event     Event structure

    OUTPUT:
     None

    HISTORY:

    $LastChangedBy: nikos $
    $LastChangedDate: 2016-08-19 10:13:30 -0700 (Fri, 19 Aug 2016) $
    $LastChangedRevision: 21680 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_load.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_load.pro)

## THM_UI_LOAD_DATA_FILE_LOADLIST.PRO

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

    NAME:
     thm_ui_load_data_file_loadlist.pro

    PURPOSE:
     ROUTINE IS DEPRECATED.  WAS MAINTAINING COPIES OF SELECTION THAT WERE ALREADY MAINTAINED ELSEWHERE.

     Controls selection of loaded data from "Loaded Data" list.  Called by
     thm_ui_load_data_file event handler.

    CALLING SEQUENCE:
     thm_ui_load_data_file_loadlist, state

    INPUT:
     state     State structure

    OUTPUT:
     None

    HISTORY:

    $LastChangedBy: egrimes $
    $LastChangedDate: 2015-04-09 14:56:06 -0700 (Thu, 09 Apr 2015) $
    $LastChangedRevision: 17278 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_loadlist.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_loadlist.pro)

## THM_UI_LOAD_DATA_FILE_OBS_SEL.PRO

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

    NAME:
     thm_ui_load_data_file_obs_sel.pro

    PURPOSE:
     Controls actions that occur when selecting items in probe/station box.  Called
     by thm_ui_load_data_file event handler.

    CALLING SEQUENCE:
     thm_ui_load_data_file_obs_sel, state

    INPUT:
     state     State structure

    OUTPUT:
     None

    HISTORY:

    $LastChangedBy: nikos $
    $LastChangedDate: 2015-11-05 10:38:06 -0800 (Thu, 05 Nov 2015) $
    $LastChangedRevision: 19267 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_obs_sel.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_load_data_file_obs_sel.pro)

## THM_UI_VALID_DATATYPE

[Previous Routine] [List of Routines]

    NAME:
     thm_ui_valid_datatype
    PURPOSE:
     get valid datatype names from thm_load_* routines, using the
     valid_names keyword and returns a list of data types that can be
     loaded for each instrument.
    CALLING SEQUENCE:
     datalist = thm_ui_valid_datatype(instrument, ilist, llist)
    INPUT:
     instr_in = three letter symbol of datatype.
    OUTPUT:
     datalist = a list of the datatypes that can be loaded
     instrument = the instrument responsible for this datatype
     ilist = a list of the input instrument replicated for each datalist
             element
     llist = the level of the data, some have 'l1', some have 'l2' some
             have one for each
    HISTORY:
     16-jan-2007, jmm, jimm@ssl.berkeley.edu
     29-jan-2007, jmm, various changes, now station isn't returned, gmag
     and asi output are hard-wired, other changes will ensue when load
     routines are standardized.
     4-feb-2007, jmm, Rewritten back to the old hard-wired version....
     5-jul-2007, jmm, Added level information
     11-apr-2008, jmm, now calls thm_data2load.pro, for 1 instrument
     16-sep-2008, bck, modified from thm_ui_valid_dtype
    $LastChangedBy: egrimes $
    $LastChangedDate: 2015-04-09 14:43:23 -0700 (Thu, 09 Apr 2015) $
    $LastChangedRevision: 17275 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spedas_plugin/load_data/thm_ui_valid_datatype.pro $

(See projects/themis/spedas_plugin/load_data/thm_ui_valid_datatype.pro)