This page was created by the IDL library routine mk_html_help2.

Last modified: Fri Nov 30 11:49:33 2012.


Directory Listing of Routines


Routine Descriptions

GUI_ACKNOWLEDGEMENT

[Next Routine] [List of Routines]
 NAME: 
   gui_acknowledgement

 PURPOSE:
   Show data policy for IUGONET data on GUI

 EXAMPLE:
   gui_acknowledgement, instrument=instrument, $
                        datatype=datatype, $
                        site_or_param=site_or_param, $
                        par_names=par_names

 Written by: Y.-M. Tanaka, May 11, 2012 (ytanaka at nipr.ac.jp)

(See iugonet/gui/gui_acknowledgement.pro)


IUG_INIT

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE iug_init
 
 :DESCRIPTION:
    Initialize the environment for loading IUGONET data 

 :NOTE:
    This procedure is called automatically on executing most of 
    iugonet_*.pro.   
 
 :Examples:
 
 iug_init
 
 if !iugonet.data_policy.ear then iug_load_ear, ..... 
 
 if ~(iugonet.data_policy.sdfit) then begin
   print, 'Data is not loaded unless you acknowledge the data policy!'
   return
 endif 
 
 :AUTHOR: 
   Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)
 :HISTORY: 
   2011/12/21: Created
 

(See iugonet/gui/iug_init.pro)


SHOW_ACKNOWLEDGEMENT

[Previous Routine] [Next Routine] [List of Routines]
NAME:
  show_acknowledgement

PURPOSE:
  Show data usage policy for each observation data.

EXAMPLE:
  Answer=show_acknowledgement(instrument=instrument, datatype=datatype, $
	par_names=par_names)

Code:
  A. Shinbori, 13/01/2011.
  
Modifications:
  Y.-M. Tanaka, 11/05/2012

(See iugonet/gui/show_acknowledgement.pro)


STR2ARR_MAXLET

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE: STR2ARR_MAXLET
   str2arr_maxlet, str, maxlet, str_arr

 PURPOSE:
   Divide a long string and insert it to a string array.
   str : string or string array
   maxlet : The maximum number of letters in one line.
            The default value is 80.
   strarr : output string array

 EXAMPLE:
   gatt = cdf_var_atts(cdffilename)
   print_str_maxlet, gatt.TEXT, 100

 Written by Y.-M. Tanaka, April 27, 2012 (ytanaka at nipr.ac.jp)

(See iugonet/gui/str2arr_maxlet.pro)


THM_GUI_NEW

[Previous Routine] [Next Routine] [List of Routines]
NAME:
 thm_gui_new

PURPOSE:
 GUI for THEMIS data analysis, including setup of the IUGONET environment variables.

CALLING SEQUENCE:
 themis_gui_new

INPUT:
 none
 
 Keywords:
   Reset - If set will reset all internal settings.  
           Otherwise, it will try to load the state of the previous call.
   template_filename - The file name of a previously saved themis template document,
                   can be used to store user preferences and defaults.

OUTPUT:
 none

HISTORY:

$LastChangedBy: aaflores $
$LastChangedDate: 2012-03-14 11:25:43 -0700 (Wed, 14 Mar 2012) $
$LastChangedRevision: 10090 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_7_00/idl/themis/thm_ui_new/thm_gui_new.pro $

(See iugonet/gui/thm_gui_new.pro)


THM_UI_CALL_SEQUENCE__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME:
  thm_ui_call_sequence__define

PURPOSE:
  Stores the sequence of procedure calls that was used to load data.


CALLING SEQUENCE:
 obj = obj_new('thm_ui_call_sequence',loadeddata)
 
Methods:
  addloadcall: This method should be called in load themis data, every time 
               'thm_ui_new_load_data2obj' is called
  getCalls:  This method returns the list of stored function calls as an
             array of pointers to structs
  setCalls: This method stores an array of pointers to structs that represent
             function/procedure calls
  reCall: This method will re-execute the sequence of stored function calls
  
  merge: This method will combine two call sequence objects.  It attempts to guarantee that
          the correct data quantities are generated, while preventing duplication of effort. 

  getDomElement: serializes this class into an XML Dom object
  BuildFromDomElement:  deserializes this class from an XML Dom Object

NOTE:  1.  This object is designed in such a way that it should be straightforward
       to ingest calls from other types of routines. For example: calls to delete data
       or calls to load data from non-themis sources.  The public interface
       is set up in such a way that it should ease these types of extensions 
       in the future.
       
       2.  Right now, it cannot guarantee that *all* the data that was saved will
       be present when reCalled, because it does not keep track of custom tplot variables,
       or data processing calls. 
 
HISTORY:
$LastChangedBy: pcruce $
$LastChangedDate: 2011-05-26 15:14:36 -0700 (Thu, 26 May 2011) $
$LastChangedRevision: 8707 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_7_00/idl/themis/thm_ui_new/objects/thm_ui_call_sequence__define.pro $

(See iugonet/gui/thm_ui_call_sequence__define.pro)


THM_UI_INIT_LOAD_WINDOW

[Previous Routine] [Next Routine] [List of Routines]
NAME:
  thm_ui_init_load_window

PURPOSE:
  Sets up the window and tab widgets for loading data into the THEMIS GUI.

CALLING SEQUENCE:
  thm_ui_init_load_window, gui_id, windowStorage, loadedData, historyWin, $
                           dataFlag, dataButtons, timerange, treeCopyPtr

INPUT:
  gui_id:  The id of the main GUI window.
  windowStorage:  The windowStorage object.
  loadedData:  The loadedData object.
  historyWin:  The history window object.
  dataFlag: 
  dataButtons: 
  timerange:  The GUI timerange object.
  treeCopyPtr:  Pointer variable to a copy of the load widget tree.
  
KEYWORDS:
  none

OUTPUT:
  none

(See iugonet/gui/thm_ui_init_load_window.pro)


THM_UI_LOAD_IUGONET_DATA

[Previous Routine] [Next Routine] [List of Routines]
NAME:
  thm_ui_load_iugonet_data

PURPOSE:
  Generates the tab that loads iugonet data for the gui.

HISTORY:
$LastChangedBy: Y.Tanaka $
$LastChangedDate: 2010-04-20 $

Modifications:
A. Shinbori, 02/05/2011
A. Shinbori, 11/05/2012
A. Shinbori, 12/06/2012
A. Shinbori, 05/10/2012


(See iugonet/gui/thm_ui_load_iugonet_data.pro)


THM_UI_LOAD_IUGONET_DATA_LOAD_PRO

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

PURPOSE:
  Modularized gui iugonet data loader

Modifications:
Y.-M. Tanaka,20/04/2010
A. Shinbori, 12/05/2010
A. Shinbori, 10/07/2010
A. Shinbori, 25/11/2010
A. Shinbori, 01/11/2011
A. Shinbori, 01/02/2012
A. Shinbori, 04/02/2012
A. Shinbori, 06/03/2012
A. Shinbori, 12/04/2012
Y.-M. Tanaka,15/06/2012
A. Shinbori, 05/10/2012

(See iugonet/gui/thm_ui_load_iugonet_data_load_pro.pro)