This page was created by the IDL library routine mk_html_help2.

Last modified: Tue May 7 11:36:21 2013.


Directory Listing of Routines


Routine Descriptions

THM_GUI_ERROR

[Next Routine] [List of Routines]
NAME:
thm_gui_error
PURPOSE:
 A widget to display, edit and save the file 'thm_gui_error.txt' error

$LastChangedBy: nikos $
$LastChangedDate: 2012-10-10 12:51:34 -0700 (Wed, 10 Oct 2012) $
$LastChangedRevision: 10974 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_gui_error.pro $

(See themis/thm_ui_new/panels/thm_gui_error.pro)


THM_GUI_HELP_ABOUT

[Previous Routine] [Next Routine] [List of Routines]
NAME:
thm_gui_help_about
PURPOSE:
 A widget to display About information (TDAS Version)

$LastChangedBy: $
$LastChangedDate:  $
$LastChangedRevision: $
$URL: $

(See themis/thm_ui_new/panels/thm_ui_help_about.pro)


THM_UI_AXIS_OPTIONS[1]

[Previous Routine] [Next Routine] [List of Routines]
NAME:
 thm_ui_axis_options
PURPOSE:
 User interface for modifying axis settings

CALLING SEQUENCE:
 thm_ui_axis, gui_id

INPUT:
 gui_id = the id number of the widget that calls this

OUTPUT:

HISTORY:

(lphilpott 07/2011) Reorganised code: removed widget ids from the state structure, these should now be found using find_by_uname. Removed
duplicate information eg panels, panelobjs from state structure. These can now be found using the helper methods thm_ui_axis_options_getpanelobjs etc.
(lphilpott 02/2012) QA: Changed labels to have number prefixed in combobox to avoid problems with identical labels on linux.
In the process removed the spaces that were added to empty labels to distinguish them under linux.
Also changed truncation to avoid problem with combobox arrow being pushed over if label became too long.
NB: This problem doesn't seem to happen with the panel title on Panel Options window.
If we could work out why the panel title combobox worked there it would be better to fix axis label title to match rather than truncating.

$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-18 08:09:55 -0700 (Thu, 18 Apr 2013) $
$LastChangedRevision: 12091 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_axis_options.pro $

(See themis/thm_ui_new/panels/thm_ui_axis_options.pro)


THM_UI_AXIS_OPTIONS[2]

[Previous Routine] [Next Routine] [List of Routines]
 set_minor
THM_UI_PROPAGATE_AXIS.PRO

Given STATE propagate the current AXISSETTINGS from the current panel to all other panels.

W.M.Feuerstein, 11/10/2008.

(See themis/thm_ui_new/panels/thm_ui_axis_options.pro)


THM_UI_AXIS_OPTIONS[2]

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

Procedure: thm_ui_update_axis_from_draw

Syntax:
  THM_UI_INIT_AXIS_WINDOW , [ tlb ] [ , state = state ]

After an update, this routine will update the fixed range of the axis objects
Using the output of the draw object.  This stops the draw object from having
to break abstraction.

It also updates the number of ticks.  As the number displayed may vary
from the number requested. (Only update is not using aesthetic ticks - lphilpott 26-june-2012)

(aaflores 2013-2-7)
Major ticks: If ticks by number is set then the ticks by interval option
             should be updated to draw similarly spaced ticks, and vice versa.
Minor ticks: Unsure... leaving them as is.

(See themis/thm_ui_new/panels/thm_ui_axis_options.pro)


THM_UI_AXIS_OPTIONS[3]

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

THM_UI_INIT_AXIS_WINDOW.PRO

Given the top level base when running THM_UI_AXIS_OPTIONS, update all axis attributes from settings.

The widget ID of the top level base should be the first parameter (this is when the program unit calling this routine
does not have the STATE structure).  Otherwise, STATE should be passed by keyword and the first parameter should not be passed.

Syntax:
  THM_UI_INIT_AXIS_WINDOW , [ tlb ] [ , state = state ]

W.M.Feuerstein, 11/7/2008.

(See themis/thm_ui_new/panels/thm_ui_axis_options.pro)


THM_UI_CALCULATE

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

PURPOSE:
 A widget interface for selecting data

CALLING SEQUENCE:
 thm_ui_calculate, master_widget_id

INPUT:
 master_widget_id = the id number of the widget that calls this program

OUTPUT:
 none

HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-17 13:14:21 -0700 (Wed, 17 Apr 2013) $
$LastChangedRevision: 12087 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_calculate.pro $

(See themis/thm_ui_new/panels/thm_ui_calculate.pro)


THM_UI_COTRANS_NEW

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

PURPOSE:
 A performs the coordinate transformations

CALLING SEQUENCE:
 thm_ui_cotrans_new, value,info

INPUT:
 value:  a string storing the destination coordinate system
 active: the set of variables to be transformed
 loadedData: the loadedData object
 sobj: the status bar object to which messages should be sent
 callSequence:  the object that tracks data processing operations so that they can be replayed in THEMIS documents.
 replay(optional): This keyword determines whether operations are pushed onto the call sequence and whether popups are displayed
 tvar_overwrite_selections(optional): Set this keyword when the replay keyword is set.  It will contain an array of what overwrite selection was made for each processed variable
 load_support_selections(optional): Set this keyword when the replay keyword is set.  It will contain an array of what support load selection was made for each processed variable
 load_slp_selections(optional): Set this keyword when the replay keyword is set.  It will contain an array of what slp load selection was made for each processed variable
OUTPUT:
 none
 
 SIDE EFFECT: New active variable for each prior active stored in loaded data
   and transformed into the new coordinate system with suffix added/changed

HISTORY:
$LastChangedBy: nikos $
$LastChangedDate: 2013-04-11 15:56:42 -0700 (Thu, 11 Apr 2013) $
$LastChangedRevision: 12019 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_cotrans_new.pro $

(See themis/thm_ui_new/panels/thm_ui_cotrans_new.pro)


THM_UI_DPROC_PANEL

[Previous Routine] [Next Routine] [List of Routines]
NAME:
 thm_ui_dproc_panel
PURPOSE:
 A widget interface that can be used to set the active data variables
 and perform various data analysis tasks.
CALLING SEQURNCE:
 thm_ui_dproc_panel, gui_id
INPUT:
 gui_id = the id of the calling widget
OUTPUT:
 No explicit output, processes are done
HISTORY:
 21-nov-2008, jmm, jimm@ssl.berkeley.edu
$LastChangedBy: nikos $
$LastChangedDate: 2013-04-09 15:41:49 -0700 (Tue, 09 Apr 2013) $
$LastChangedRevision: 12001 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_dproc_panel.pro $

(See themis/thm_ui_new/panels/thm_ui_dproc_panel.pro)


THM_UI_DPROC_PAR::CHOOSE

[Previous Routine] [Next Routine] [List of Routines]
NAME:
 thm_ui_dproc_par::choose
PURPOSE:
 Simple widget that allows user to input and/or choose parameter values
CALLING SEQUENCE:
 new_value = thm_ui_dproc_par_choose(pars_object, label_xsize = label_xsize, $
                                     button_xsize = button_xsize, $
                                     title = title, buttons_on_top=buttons_on_top)
INPUT:
 pars_object = an object of the type thm_ui_dproc_par the widget and
 values are set up using the parameters in the dp_struct structure
 for the object. While there are no constraints on what is contained
 in the structure when defining the object -- here the following tags
 are used in the structure:
          plabel: parameter names (for widget labels), for N parameters
          pvalue: string values of parameters, for N parameters, all
                  of the i/o here returns string values
          radio_array: an array of button values, can be 2d,
                       row of values corresponds to a row of
                       buttons on the widget, one choice is possible
                       for each row. No buttons are shown for null
                       values.
          radio_value: A valid value for a choice for each row of
                       radio buttons (n_elements(radio_array[*,0]))
          radio_label: A valid value for a choice for each row of
                       radio buttons (n_elements(radio_array[*,0]))
OUTPUT:
 new_value = the output value of the parameters, a string array of values,
             e.g., ['4.67', '3.0', ...n]
             radio buttons were used the last elements of  the array
             will contain the radio button selection,
             e.g., ['4.67', '3.0', ..., 'inches', 'p']
KEYWORDS:
 label_xsize = an xsize value for labels, allows for consistent
               alignment, the default is 0
 button_xsize = an xsize value for buttons, allows for consistent
                alignment
 title = a title for the widget
 buttons_on_top = If set, put the buttons on top
METHODS:
 thm_ui_dproc_par_choose_event - event handler for the window
                                 (handles parameter input, cancel/
                                 accept buttons, and window close 'X'
 thm_ui_dproc_par_rad_event - event handler for the radio buttons;
 thm_ui_dproc_par__choose - creates the window, widgets, and calls
                            the  xmanager
HISTORY:
 22-oct-2008, Hacked from thm_ui_npar_new, jmm, jimm@ssl.berkeley.edu
$LastChangedBy: lphilpott $
$LastChangedDate: 2012-02-09 16:41:58 -0800 (Thu, 09 Feb 2012) $
$LastChangedRevision: 9708 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_dproc_par_choose.pro $

(See themis/thm_ui_new/panels/thm_ui_dproc_par_choose.pro)


THM_UI_DPROC_RESET_ACT_DATA

[Previous Routine] [Next Routine] [List of Routines]
NAME:
 Thm_ui_dproc_reset_act_data
PURPOSE:
 helper function to reset the active data window in dproc panel
CALLING SEQUENCE:
 thm_ui_dproc_reset_act_data, dproc_id
INPUT:
 dproc_id = the widget_id for the dproc panel, or the state structure
OUTPUT:
 None explicit, the active data widget is updated
HISTORY:
 15-jan-2009, jmm, jimm@ssl.berkeley.edu
 23-jan-2009, jmm, uses the dproc_id to update so that part_getspec
                   options can update active data window correctly
 1-apr-2009, jmm, Added update_tree keyword
$LastChangedBy: aaflores $
$LastChangedDate: 2012-01-26 16:47:04 -0800 (Thu, 26 Jan 2012) $
$LastChangedRevision: 9627 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_dproc_reset_act_data.pro $

(See themis/thm_ui_new/panels/thm_ui_dproc_reset_act_data.pro)


THM_UI_EXPORT_MARKER

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

PURPOSE:
 This routine creates and handles the panel for exporting marker data 

CALLING SEQUENCE:
 thm_ui_marker_options

INPUT:
 gui_id:  id for the master base widget (tlb)

OUTPUT:

HISTORY:

$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_export_markers.pro $

(See themis/thm_ui_new/panels/thm_ui_export_markers.pro)


THM_UI_FILECONFIG

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

PURPOSE:
 A widget that allows the user to set some of the fields in the
 !themis system variable: Also allows the user to set the themis
 configuration text file, and save it

HISTORY:
 17-may-2007, jmm, jimm@ssl.berkeley.edu
 2-jul-2007, jmm, 'Add trailing slash to data directories, if necessary
 5-may-2008, cg, removed text boxes and replaced with radio buttons or 
                 pulldowns, fixed reset to default
 10-aug-2011, lphilpott, Added option to set a template to load on startup of gui. Changed layout of widgets
              slightly to make things line up in both windows and linux.

$LastChangedBy: jwl $
$LastChangedDate: 2013-04-17 15:24:55 -0700 (Wed, 17 Apr 2013) $
$LastChangedRevision: 12088 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_fileconfig.pro $

(See themis/thm_ui_new/panels/thm_ui_fileconfig.pro)


THM_UI_GEN_OVERPLOT

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

PURPOSE:
  Widget wrapper for thm_ui_overplot used to create Themis overview plots in
  the GUI.  If the overview plot is successfully created, this function returns
  the number 1.  Otherwise, a zero is returned.

CALLING SEQUENCE:
  success = thm_ui_gen_overplot(gui_id, historyWin, oplot_calls)

INPUT:
  gui_id:  The id of the main GUI window.
  historyWin:  The history window object.
  oplot_calls:  The number calls to thm_ui_gen_overplot.
  
KEYWORDS:
  none

OUTPUT:
  success: a 0-1 flag.
  
$LastChangedBy: nikos $
$LastChangedDate: 2013-04-03 17:31:00 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11954 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_gen_overplot.pro $

(See themis/thm_ui_new/panels/thm_ui_gen_overplot.pro)


THM_UI_HELP_WINDOW

[Previous Routine] [Next Routine] [List of Routines]
NAME:
thm_ui_help_window
PURPOSE:
 A widget to display the file 'thm_gui.txt' help

$LastChangedBy: nikos $
$LastChangedDate: 2013-04-11 17:00:45 -0700 (Thu, 11 Apr 2013) $
$LastChangedRevision: 12025 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_help_window.pro $

(See themis/thm_ui_new/panels/thm_ui_help_window.pro)


THM_UI_IMAGE_EXPORT

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

PURPOSE:
 This window allows the user to pick the filename/type for image export
    
CALLING SEQUENCE:
 thm_ui_image_export,gui_id,draw_save_object
 
INPUT:
 gui_id:  id of top level base widget from calling program
 draw_save_object: the object that does the actual output

OUTPUT:
 
HISTORY:
$LastChangedBy: nikos $
$LastChangedDate: 2012-10-22 11:02:24 -0700 (Mon, 22 Oct 2012) $
$LastChangedRevision: 11084 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_image_export.pro $

(See themis/thm_ui_new/panels/thm_ui_image_export.pro)


THM_UI_IMAGE_EXPORT_OPTIONS

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

PURPOSE:
  This window allows the selection of file export options 
  for various formats.
    
CALLING SEQUENCE:
 thm_ui_image_export,gui_id,draw_save_object
 
INPUT:
 gui_id:  id of top level base widget from calling program
 draw_save_object: the object that does the actual output

OUTPUT:
 
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_image_export_options.pro $

(See themis/thm_ui_new/panels/thm_ui_image_export_options.pro)


THM_UI_JUMP

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

PURPOSE:
 small window that allows the user to enter a new start time for the x axis
 
CALLING SEQUENCE:
 thm_ui_jump

INPUT:
 gui_id    id of the top level base widget that is calling this routine

OUTPUT:
 
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_jump.pro $

(See themis/thm_ui_new/panels/thm_ui_jump.pro)


THM_UI_LEGEND_OPTIONS

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

 PURPOSE:
  A widget interface for changing legend settings

 CALLING SEQUENCE:
  thm_ui_legend_options, info
 
 INPUT:
  info:   info structure from thm_gui_new
  
 KEYWORDS:
  panel_select:     pointer to current panel
 
$LastChangedBy: pcruce $
$LastChangedDate: 2013-04-04 14:07:28 -0700 (Thu, 04 Apr 2013) $
$LastChangedRevision: 11960 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_legend_options.pro $

(See themis/thm_ui_new/panels/thm_ui_legend_options.pro)


THM_UI_MANAGE_DATA

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

PURPOSE:
  panel which allows user to import and export tplot data
    
CALLING SEQUENCE:
 thm_ui_manage_data,gui_id
 
INPUT:
 gui_id:  id of top level base widget from calling program

OUTPUT:
 
HISTORY:
$LastChangedBy: aaflores $
$LastChangedDate: 2013-04-22 15:56:14 -0700 (Mon, 22 Apr 2013) $
$LastChangedRevision: 12129 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_manage_data.pro $

(See themis/thm_ui_new/panels/thm_ui_manage_data.pro)


THM_UI_MARKER_OPTIONS

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

PURPOSE:
 This routine creates a window for the user to set options for markers

CALLING SEQUENCE:
 thm_ui_marker_options

INPUT:
 gui_id:  id for the master base widget (tlb)

OUTPUT:

HISTORY:

$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_marker_options.pro $

(See themis/thm_ui_new/panels/thm_ui_marker_options.pro)


THM_UI_MARKER_TITLE

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

PURPOSE:
 this window is displayed whenever a user has marked an area
 the window handles marker information such as title
    
CALLING SEQUENCE:
 thm_ui_marker_title, gui_id
INPUT:
 gui_id     id of top level base widget from calling program

OUTPUT:
 
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_marker_title.pro $

(See themis/thm_ui_new/panels/thm_ui_marker_title.pro)


THM_UI_NUDGE_OPTIONS

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

PURPOSE:
 simple user interface window which allows the user to specify a new
 time array for a trace or spectrogram

CALLING SEQUENCE:
 thm_ui_nudge_options, gui_id, info

INPUT:
  gui_id = widget id of the widget that called this program
  info = the info structure of the Main GUI
OUTPUT:

HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_nudge_options.pro $

(See themis/thm_ui_new/panels/thm_ui_nudge_options.pro)


THM_UI_OVERPLOT_KEY

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

PURPOSE:
  Pops up a window that displays the Themis overview plot key (the same one
  that's on the website).

CALLING SEQUENCE:
  thm_ui_overplot_key, gui_id, historyWin, modal=modal

INPUT:
  gui_id:  The id of the main GUI window.
  historyWin:  The history window object.

KEYWORDS:
  modal = Flag to set the modal of the top level base

OUTPUT:
  none
  
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_overplot_key.pro $

(See themis/thm_ui_new/panels/thm_ui_overplot_key.pro)


THM_UI_PAGE_ALL_SET_VALUE

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

NAME:
  thm_ui_page_all_set_value

PURPOSE:
  this procedure is used to change values for all pages.

INPUTS:
  The top level base of the page window
  The state variable for the window

NOTES:
  This routine mimics thm_ui_page_set_value which is applicable to a single page

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_COLOR_EVENT

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

NAME:
  thm_ui_page_color_event

  PURPOSE:
    abstracts duplication in handling of color/palette events

  INPUTS:
    tlb:  the top level base for this window
    uname: the user name of the widget in question
    messagename: the name to be used in the output message

 NOTES:

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_COLOR_GET_VALUE

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

NAME:
  thm_ui_page_color_get_value

  PURPOSE:
    abstracts duplication in acquisition of font values

  INPUTS:
    tlb:  the top level base for this window
    uname: the user name of the widget in question

 NOTES:

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_FONT_GET_VALUE

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

NAME:
  thm_ui_page_font_get_value

  PURPOSE:
    abstracts duplication in acquisition of font values

  INPUTS:
    tlb:  the top level base for this window
    uname: the user name of the widget in question

 NOTES:

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_FOOTER_SET_VALUE

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

NAME:
  thm_ui_page_footer_set_value

  PURPOSE:
    Reads the footer settings out of the widgets and stores them in the appropriate location in the draw tree

  INPUTS:
    tlb:  the top level base for this window
    pagesettings: the page settings associated with the current window

 NOTES:

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_OPTIONS[1]

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

PURPOSE:
 user interface panel that allows user to change page parameters

CALLING SEQUENCE:
 thm_ui_page_options, gui_id

INPUT:
 gui_id = the id number of the widget that calls this

OUTPUT:

HISTORY:
$LastChangedBy: jwl $
$LastChangedDate: 2013-05-07 11:09:44 -0700 (Tue, 07 May 2013) $
$LastChangedRevision: 12294 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_page_options.pro $

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_OPTIONS[2]

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

Pro HANDLE_PAGETITLE_COMMAND updates the "titletext" widget, and the pagesettings object after a selection on one
of the subbuttons of the "Token" and "Format" buttons (Graph -> Page Options... Text [tab]).  For the format buttons,
the FORMAT kw must be set.  This routine reduces duplication in the case statement of THM_UI_PAGE_OPTIONS_EVENT.PRO.

W.M.Feuerstein, September 24, 2008.


Function not currently in use.

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_SET_VALUE

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

NAME:
  thm_ui_page_set_value

PURPOSE:
  this procedure is here to provide a framework for the incremental implementation
  of lazy event handling in the page window. Rather than store a value every time an event
  occurs, this procedure queries widget values, when they are needed('OK' or 'Apply').

  The advantages of this are:
    #1 Simplifies/Centralizes event handling code
    #2 Prevent routines from overwriting invalid user inputs when they are partially complete
    #3 Allows the window to perform more complex input validation(because it can be assumed that all inputs should be correct)

INPUTS:
  The top level base of the page window
  The state variable for the window(If the state were not taken off the tlb by the time this is called, we could eliminate this parameter)

NOTES:
  This routine is incomplete.  As software maintainence tasks are performed,
  programmers should move functions into this routine at their perogative.
  Right now the title and the footer are processed using the lazy event handling.

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_TITLE_SET_VALUE

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

NAME:
  thm_ui_page_title_set_value

  PURPOSE:
    Reads the title settings out of the widgets and stores them in the appropriate location in the draw tree

  INPUTS:
    tlb:  the top level base for this window
    pagesettings: the page settings associated with the current window

 NOTES:

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PAGE_UPDATE_CANVAS

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

NAME:
  thm_ui_page_update_canvas

  PURPOSE:
    helper function, updates canvas size values when
    switching between portrait and landscape modes

  INPUTS:
    state: the panel's state structure
    orient: flag for landscape(1)/portrait(0) modes

(See themis/thm_ui_new/panels/thm_ui_page_options.pro)


THM_UI_PANEL_OPTIONS

[Previous Routine] [Next Routine] [List of Routines]
NAME:
 thm_ui_panel_options
PURPOSE:
 A widget interface for selecting data
CALLING SEQUENCE:
 thm_ui_newfile, master_widget_id
INPUT:
 master_widget_id = the id number of the widget that calls this
OUTPUT:
 none, there are buttons to push for plotting, setting limits, not
 sure what else yet...
HISTORY:

(lphilpott 06/2011) Delayed the handling of spinner events until user clicks OK/APPLY/SET ALL or changes panel. Dialog messages
are issued for invalid entries. This avoids the issue of the text overwriting in spinners as the user types if values aren't valid.

$LastChangedBy: pcruce $
$LastChangedDate: 2013-04-04 14:07:28 -0700 (Thu, 04 Apr 2013) $
$LastChangedRevision: 11960 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_panel_options.pro $

(See themis/thm_ui_new/panels/thm_ui_panel_options.pro)


THM_UI_PART_GETSPEC_OPTIONS[1]

[Previous Routine] [Next Routine] [List of Routines]
 Purpose:
 Helper function to check if strings from user input 
 contain valid numbers.
  -returns 1 if widget contains a valid number, 0 otherwise
  -if the input is invalid or out of range then a pop-up
   message will be generated to notify the user
 
 Arguments:
   state: state data structure
   uname: uname of the widget to check
   namestring: string used to indentify quantity in the 
               error message, e.g "phi min", "maximum energy"
 
 Keywords (optional):
   min: the minimum valid value for the quantity in question
   max: the maximum valid value for the quantity in question
   value: set to names keyword to return the numeric value
          of the widget

(See themis/thm_ui_new/panels/thm_ui_part_getspec_options.pro)


THM_UI_PART_GETSPEC_OPTIONS[2]

[Previous Routine] [Next Routine] [List of Routines]
NAME:
  thm_ui_part_getspec_options
 
PURPOSE:
  A interface to THM_PART_GETSPEC.PRO for creating and loading THEMIS energy/
  angular particle spectra into the GUI.  Intended to be called from
  THM_UI_INIT_LOAD_WINDOW.PRO.
 
CALLING SEQUENCE:
  thm_ui_part_getspec_options, tab_id, loadedData, historyWin, statusText, $
                              trObj, timeWidget=timeWidget
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.
  trObj:  The GUI timerange object.
 
KEYWORDS:
  timeWidget = The time widget object.
 
OUTPUT:
 No explicit output, new variables are created. For a given data
 type, one or two spectra are created. One is the angular spectrum
 for the full energy range. If the energy spectrum option is chosen,
 then another spectrum is created which is the energy spectrum for
 the full angular range.
 
HISTORY:
 5-jan-2009, jmm, jimm@ssl.berkeley.edu
 14-jan-2009, jmm, added statusbar object
 15-jan-2009, jmm, added external_state, so that the active data
                   widget on the dproc panel can be updated.
 23-jan-2009, jmm, deletes tplot variables created during processing,
                   correctly updates active data
 13-may-2009, bck, moved code from Data Processing window to Load window
 16-jul-2012, aaf, rewrote error checking on input values to match the 
                   behavior of other GUI windows
 
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_part_getspec_options.pro $

(See themis/thm_ui_new/panels/thm_ui_part_getspec_options.pro)


THM_UI_RENAME_VARIABLE

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

PURPOSE:
  this window allows the user to rename a tplot variable as it is being imported to avoid a name conflict with existing variables
    
CALLING SEQUENCE:
 thm_ui_rename_variable, gui_id, names, loadedData, windowstorage, historywin,newnames=newnames,success=success,callSequence=callSequence
 
 Inputs:
   names:  The names to be changed
   loadedData: The loadedData object
   windowstorage: The windowStorage object
 
Keywords:
 gui_id:  id of top level base widget from calling program(not required if not used inside the gui)
 newnames:  This returns the set of datanames after any modifcations
 success: Returns 1 if the successful
  
OUTPUT:
 
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_rename_variable.pro $

 This is copied largely from thm_ui_verify_data

(See themis/thm_ui_new/panels/thm_ui_rename_variable.pro)


THM_UI_SAVE_DATA

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

PURPOSE:
 user interface panel for user to select whether to save data with the 
 THEMIS GUI Document along with the other settings that are saved in the file

CALLING SEQUENCE:
 result = thm_ui_data(gui_id)   where result 1=save w/data, 0=save settings only

INPUT:
 gui_id    widget id of calling program

OUTPUT:
 
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_save_data.pro $

(See themis/thm_ui_new/panels/thm_ui_save_data.pro)


THM_UI_VARIABLE_OPTIONS[1]

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

W.M.Feuerstein, 10/14/2008.
Rewritten pcruce@igpp.ucla.edu 9/10/2009

(See themis/thm_ui_new/panels/thm_ui_variable_options.pro)


THM_UI_VARIABLE_OPTIONS[2]

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

PURPOSE:
 This routine creates and handles the layout widget. The layout panel is
 used to create and control a panels settings

CALLING SEQUENCE:
 thm_ui_variable_options, gui_id

INPUT:
 gui_id:  id for the master base widget (tlb)

OUTPUT:

HISTORY:

$LastChangedBy: pcruce $
$LastChangedDate: 2013-04-04 14:07:28 -0700 (Thu, 04 Apr 2013) $
$LastChangedRevision: 11960 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_variable_options.pro $

(See themis/thm_ui_new/panels/thm_ui_variable_options.pro)


THM_UI_VERIFY_DATA

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

PURPOSE:
  this window allows the user to view and change the meta data associated with GUI data, either tplot variables 
  being imported or GUI data being exported.
    
CALLING SEQUENCE:
 thm_ui_verify_data,names,loadedData,windowStorage,gui_id=gui_id,edit=edit,newnames=newnames
 
 Inputs:
   names:  The names for which verification is done
   loadedData: The loadedData object
   windowstorage: The windowStorage object
 
Keywords:
 gui_id:  id of top level base widget from calling program(not required if not used inside the gui)
 edit:  Set this to indicate that this is only being used to edit metadata.  This means that data will not be deleted on failure/error
 newnames:  This returns the set of datanames after any modifcations
  
OUTPUT:
 
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_verify_data.pro $

(See themis/thm_ui_new/panels/thm_ui_verify_data.pro)


THM_UI_WIDGET_TEMPLATE

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

PURPOSE:
  template that contains repeated code in widget creation
    
CALLING SEQUENCE:
 thm_ui_widget_template,gui_id
 
INPUT:
 gui_id:  id of top level base widget from calling program

OUTPUT:
 
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_widget_template.pro $

(See themis/thm_ui_new/panels/thm_ui_widget_template.pro)


THM_UI_WIDGET_TREE_TEST

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

PURPOSE:
  tests the tree widget
    
CALLING SEQUENCE:
 thm_ui_widget_tree_test,gui_id
 
INPUT:
 gui_id:  id of top level base widget from calling program

OUTPUT:

 
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2013-04-03 14:18:44 -0700 (Wed, 03 Apr 2013) $
$LastChangedRevision: 11947 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/thm_ui_widget_tree_test.pro $

(See themis/thm_ui_new/panels/thm_ui_widget_tree_test.pro)


YESNO_WIDGET_FN

[Previous Routine] [List of Routines]
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: jimmpc $
$LastChangedDate: 2009-06-04 17:35:52 -0700 (Thu, 04 Jun 2009) $
$LastChangedRevision: 6050 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_8_00/idl/themis/thm_ui_new/panels/yesno_widget_fn.pro $

(See themis/thm_ui_new/panels/yesno_widget_fn.pro)