This page was created by the IDL library routine mk_html_help2.

Last modified: Wed May 14 01:32:11 2008.


Directory Listing of Routines


Routine Descriptions

THM_ASI_CREATE_MOSAIC

[Next Routine] [List of Routines]
of yyyy-mm-dd hh:mm:ss.xxxx if there
 is only 1 digit in the day or hour or second, etc.
 Will also return an error message, if the months, days, hours,
 seconds are not valid
$LastChangedBy$
$LastChangedDate$
$LastChangedRevision$
$URL$
unction thm_ui_timefix, time_in, progobj = progobj, _extra = _extra
 Calls the thm_tselect widget, returns the value..
16-jul-2007, jmm added the init_time input
$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-01-26 15:52:34 -0800 (Fri, 26 Jan 2007) $
$LastChangedRevision: 241 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/thm_ui_tselect_fn.pro $

NAME:
 thm_ui_tselect
PURPOSE:
 A list widget for time selection, this is a blocking widget, it must
 be exited for anything to happen
CALLING SEQUENCE:
 thm_ui_teslect
INPUT:
 none
OUTPUT:
 the selected time is held in the common block saved_time_sel
HISTORY:
 sep-2006,  jmm,  jimm@ssl.berkeley.edu

$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-01-26 15:52:34 -0800 (Fri, 26 Jan 2007) $
$LastChangedRevision: 241 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/thm_ui_tselect.pro $

NAME:
 thm_ui_update_data_all
PURPOSE:
 Calls thm_ui_set_data_id, thm_ui_set_active_dset and
 thm_ui_update_data_display in one procedure, 
CALLING SEQUENCE:
 thm_ui_update_data_all, gui_id, active_vnames
INPUT:
 gui_id = a widget id for the gui
OUTPUT:
 none
HISTORY:
 5-jun-2007, jmm, jimm@ssl.berkeley.edu
 7-may-2008, jmm, sort and uniq functionality is handled by tnames
                  call. This is now a short program....
$LastChangedBy$
$LastChangedDate$
$LastChangedRevision$
$URL$
NAME:
 thm_ui_update_data_display
PURPOSE:
 update the loaded-data display for the themis_w widget
CALLIMG SEQUENCE:
 thm_ui_update_data_display, widget_id
INPUT:
 widget_id = the id number of the widget
HISTORY:
 dec-2006, jmm jimm@ssl.berkeley.edu
 18-jun-2007, jmm, changed to access 'active data' widget
 16-jul-2007, jmm, changed to add coordinate system to display
$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-01-26 15:52:34 -0800 (Fri, 26 Jan 2007) $
$LastChangedRevision: 241 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/thm_ui_update_data_display.pro $

NAME:
 thm_ui_update_history
PURPOSE:
 Adds the string input to the state structure history array

(See themis/ground/thm_asi_create_mosaic.pro)


THM_ASI_STATIONS.PRO

[Previous Routine] [Next Routine] [List of Routines]
L: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/thm_ui_update_data_display.pro $

NAME:
 thm_ui_update_history
PURPOSE:
 Adds the string input to the state structure history array
INPUT:
 string = a string to add to the history array. Note that this is
 returned undefined, if it is passed in by reference, i/e/, if it's a
 named variable.
OUTPUT:
 state.history is updated
HISTORY:
 sep-2006, jmm, jimm@ssl.berkeley.edu
 26-feb-2007, jmm, fixed problem with multiple lines when choosing
                   multiple probes, datatypes, sataiotns, etc...
 8-may-2007, jmm, changed so that the thm_gui widget id is now passed
                  in, since the history widget is now on the main
                  widget, removed some error checking, if things are
                  undefined in here i want to know

$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-01-26 15:52:34 -0800 (Fri, 26 Jan 2007) $
$LastChangedRevision: 241 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/thm_ui_update_history.pro $

NAME:
 thm_ui_update_progress
PURPOSE:
 Write a string into the progress widget for the THEMIS GUI
CALLING SEQUENCE:
 thm_ui_update_progress, gui_id, input_string
INPUT:
 gui_id = the widget_id for the GUI
 input_string = a string to be displayed
OUTPUT:
 None
KEYWORDS:
 message_wid = id for any other message widgets that you might like
                to display the messages
HISTORY:
 jmm, 9-may-2007, jimm@ssl.berkeley.edu
 jmm, 5-mar-2008, added multiple lines, and the ability to show in
                  multiple message widgets.
$LastChangedBy$
$LastChangedDate$
$LastChangedRevision$
$URL$
NAME:
 thm_ui_userdef
PURPOSE:
 A widget that allows the user to define his own operator to be used
 on the data from a tplot variable, e.g., the user types in the
 string '2.0*!pi*q', and a temporary function is created which takes

(See themis/ground/thm_asi_stations.pro)


THM_GMAG_STACKPLOT.PRO

[Previous Routine] [Next Routine] [List of Routines]
 (Fri, 26 Jan 2007) $
$LastChangedRevision: 241 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/thm_ui_update_history.pro $

NAME:
 thm_ui_update_progress
PURPOSE:
 Write a string into the progress widget for the THEMIS GUI
CALLING SEQUENCE:
 thm_ui_update_progress, gui_id, input_string
INPUT:
 gui_id = the widget_id for the GUI
 input_string = a string to be displayed
OUTPUT:
 None
KEYWORDS:
 message_wid = id for any other message widgets that you might like
                to display the messages
HISTORY:
 jmm, 9-may-2007, jimm@ssl.berkeley.edu
 jmm, 5-mar-2008, added multiple lines, and the ability to show in
                  multiple message widgets.
$LastChangedBy$
$LastChangedDate$
$LastChangedRevision$
$URL$
NAME:
 thm_ui_userdef
PURPOSE:
 A widget that allows the user to define his own operator to be used
 on the data from a tplot variable, e.g., the user types in the
 string '2.0*!pi*q', and a temporary function is created which takes
 the data and does this multiplication. This is pretty experimental.
CALLING SEQUENCE:
 thm_ui_userdef, gui_id
INPUT:
 gui_id = the id of the main gui widget
OUTPUT:
 none explicit, hopefully new tplot variables are created
HISTORY:

(See themis/ground/thm_gmag_stackplot.pro)


THM_LOAD_ASI

[Previous Routine] [Next Routine] [List of Routines]
nsform
OUTPUT:
 new_names = new variable names generated by the process
KEYWORDS:
 polar = if set, passes the /polar keyword into the split_vec
         procedure, new variable names for 3-d data will be polar,
         and not '_x','_y','_z'
 gui_id = the main GUI widget ID, for messages
 messw_id = the dproc widget id, for messages
HISTORY:
 12-mar-2007, jmm, jimm@ssl.berkeley.edu
 5-jun-2007, jmm, no longer handles history
 7-may-2008, W. Michael Feuerstein, Test for >= 2 finite points.

$LastChangedBy$
$LastChangedDate$
$LastChangedRevision$
$URL$
function thm_valid_input
purpose:
  for thm_load routines to validate the input keyword and set it to a standard
  format ('l1', 'l2', etc.).  
parameters:
  input:  keyword input to be validated from thm_load routine: array or scalar
  label:  name of input keyword that is being validated
keywords:
  vinputs: a space-separated string, like 'l1 l2'
  definput: a string like 'l2'.  Required.
  include_all:  if set will accept multiple values on input, and include 'all'
                as a valid input. 'all' is equivalent to '*'
  verbose: to maintain control of verbosity 
  format: format to use to convert numerical input to string.  Numerical input
          disallowed if absent.  examples: "('l',I1)" or "('v', I02)"
 return value:
    a scalar string, e.g. 'l1'
    if /include_all: an array of strings
    on error: empty string: ''
example:
        lvl = thm_valid_input(level,'Level',vinputs='l1 l2',definput='l1',$
                               foramt="('l', I1)", verbose=verbose)
        if lvl eq '' then return                             

function thm_valid_level
purpose:
  for thm_load routines to validate the level keyword and set it to a standard
  format ('l1', 'l2', etc.).  Only a single level is allowed.
keywords:

(See themis/ground/thm_load_asi.pro)


THM_LOAD_ASI_CAL

[Previous Routine] [Next Routine] [List of Routines]
list = 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
$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-01-26 15:52:34 -0800 (Fri, 26 Jan 2007) $
$LastChangedRevision: 241 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/thm_ui_valid_dtype.pro $
NAME:
 thm_ui_wavelet
PURPOSE:
 wavelet transform of the input tplot variables, fist calls split_vec
 to split up any multi-component vectors.
CALLING SEQUENCE:
 thm_ui_wavelet, vnames, new_names, polar=polar,_extra=_extra
INPUT:
 vnames = the tplot variable names to transform
OUTPUT:
 new_names = new variable names generated by the process
KEYWORDS:
 polar = if set, passes the /polar keyword into the split_vec
         procedure, new variable names for 3-d data will be polar,
         and not '_x','_y','_z'
 gui_id = the main GUI widget ID, for messages
 messw_id = the dproc widget id, for messages
HISTORY:
 12-mar-2007, jmm, jimm@ssl.berkeley.edu
 5-jun-2007, jmm, no longer handles history
 7-may-2008, W. Michael Feuerstein, Test for >= 2 finite points.

$LastChangedBy$

(See themis/ground/thm_load_asi_cal.pro)


THM_LOAD_ASK

[Previous Routine] [Next Routine] [List of Routines]
config file
CALLING SEQUENCE:
 thm_write_config, copy=copy
INPUT:
 none, the filename is hardcoded, 'thm_config.txt',and is s put in a
 folder given by the routine thm_config_filedir, that uses the IDL
 routine app_user_dir to create/obtain it: my linux example:
 /disks/ice/home/jimm/.idl/themis/thm_config-4-linux
OUTPUT:
 the file is written, and a copy of any old file is generated
KEYWORD:
 copy = if set, the file is read in and a copy with the !stime
        appended is written out
HISTORY:
 17-may-2007, jmm, jimm@ssl.berkeley.edu
$LastChangedBy$
$LastChangedDate$
$LastChangedRevision$
$URL$
Procedure: tKm2Re

Purpose: Converts a variable to RE or KM

Inputs: name: a string naming the tplot variable to be modified
              globbing may be used

Keywords:
          newname: set this keyword to a string to store the
                   output in(only works when globbing is not used)
          suffix:  set this keyword to a string indicating the
                   suffix to be appended to the input variable(s)
          /replace: set this option to replace the variable being modified
          /KM : converts to KM from RE rather than to RE from KM
 

  examples:
        tKm2Re,'thb_state_pos'
        tKm2Re,'thb_state_pos',/replace
        tKm2Re,'thb_state_pos',/KM
        tKm2Re,'thb_state_pos',newname='pos_in_re'
        tKm2Re,'th?_state_pos',suffix='_converted'

  NOTES: Uses conversion of 6374.4 KM/RE

(See themis/ground/thm_load_ask.pro)


THM_LOAD_GMAG

[Previous Routine] [List of Routines]
         suffix:  set this keyword to a string indicating the
                   suffix to be appended to the input variable(s)
          /replace: set this option to replace the variable being modified
          /KM : converts to KM from RE rather than to RE from KM
 

  examples:
        tKm2Re,'thb_state_pos'
        tKm2Re,'thb_state_pos',/replace
        tKm2Re,'thb_state_pos',/KM
        tKm2Re,'thb_state_pos',newname='pos_in_re'
        tKm2Re,'th?_state_pos',suffix='_converted'

  NOTES: Uses conversion of 6374.4 KM/RE
         By default output will be called: input_name+'_RE'


$LastChangedBy: pcruce $
$LastChangedDate: 2008-01-24 13:48:09 -0800 (Thu, 24 Jan 2008) $
$LastChangedRevision: 2312 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/misc/tvectot.pro $
NAME:
 yesno_widget_fn
PURPOSE:
 Simple widget that asks for a yes or no
CALLING SEQUENCE:
 yn=yesno_widget_fn(title, list = list, _extra = _extra)
INPUT:
 title = a title, or a question
OUTPUT:
 yn = 0 for no, 1 for yes
KEYWORDS:
 list, a string array to put in the widget, as an aid
HISTORY:
 27-nov-2006, jmm, jimm@ssl.berkeley.edu
 31-jul-2007, jmm, added /enable_yes_always button, default behavior
              is to not allow this sort of thing
 27-mar-2008, jmm, just added this comment to test SVN from my PC..
 27-mar-2008, jmm, another comment to test SVN from my PC..
 10-apr-2008, jmm, another test of SVN
 29-apr-2008, jmm, another test of SVN
$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-01-26 15:52:34 -0800 (Fri, 26 Jan 2007) $
$LastChangedRevision: 241 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/common/yesno_widget_fn.pro $

thm_crib_asi.pro
usage:
 .run thm_crib_asi


Written by Harald Frey
 $LastChangedBy: kenb-win2000 $
 $LastChangedDate: 2007-02-11 21:26:08 -0500 (Sun, 11 Feb 2007) $
 $LastChangedRevision: 379 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/examples/thm_crib_asi.pro $

	Batch File: THM_CRIB_EFI

	Purpose:  Demonstrate the loading, calibration, and plotting
		of THEMIS EFI data.

	Calling Sequence:
	.run thm_crib_fbk, or using cut-and-paste.

(See themis/ground/thm_load_gmag.pro)