Directory: projects/themis/deprecated/thm_ui/

Contents

.pro files

thm_gui_original.pro

NAME: thm_gui_originalPURPOSE: GUI for THEMIS data analysisCALLING SEQUENCE: thm_gui_originalINPUT: noneOUTPUT: noneHISTORY: Version 2.0 jmm, jimm@ssl.berkeley.edu 25-apr-2007 jmm, 21-may-2007, Currently Only Loads data jmm, 7-jun-2007, all buttons are now defined jmm, 31-jul-2007, added warning for too long time ranges jmm, 2-aug-2007, added widget_kill_request block so that the pointers and progobj are cleaned up when you click the 'x' jmm, 11-sep-2007, added this comment jmm, 25-oct-2007, Now holds plot parameters (wondow number,etc) in state structure jmm, 4-mar-2008, put in this comment to test email notifications cg, 1-apr-2008, added ps_size and ps_units to pstate structure (needed to store user inputs for postscript file size) cg, 29-may-2008, added a new structure that defines the SCM calibration parameters.

thm_ui_call_tplot.pro

thm_ui_check4spin.pro

NAME: thm_ui_check4spinPURPOSE: given a THEMIS tplot variable name, check to see if spin period and phase exist, for coordinate transformations, If they do not, load the state data for the appropriate time periodCALLING SEQUENCE: thm_ui_check4spin, vname, vname_spin1, vname_spin2, history_outINPUT: vname = tplot variable nameOUTPUT: vname_spin1 = the tplot variable containing the spin period.

thm_ui_choose_dtype.pro

thm_ui_cotrans.pro

thm_ui_dproc.pro

thm_ui_error.pro

thm_ui_help.pro

thm_ui_load_data_fn.pro

NAME:thm_ui_load_data_fnPURPOSE:A widget interface to load CDF data for whatever instrumentCALLING SEQUENCE:varnames = thm_ui_load_data_fn(st_time, en_time, $ dtype = dtype, $ station = station, $ astation = astation, $ probe = probe)INPUT:st_time, en_time = start and end times in seconds from 1-jan-1970 0:00KEYWORDS:dtype, the type of data, a string, of form 'instrument/datatype/datalevel', the default is 'gmag/mag/l2'station, the ground station of the gmag data, default is '*', for allastation, the ground station of the asi data, default is '*', for allprobe = one or more of ['a','b','c','d','e'], default is ['a','b','c','d','e']scm_cal = a structure containing calibration parametersOUTPUT:varnames = an array of tplot variable names, to pass into tplotHISTORY: 22-sep-2006, jmm, jimm@ssl.berkeley.edu 23-oct-2006, jmm, changed to call cdf2tplot 30-oct-2006, jmm, changed again, to call load_thg_mag, also added dtype and station as inputs 13-nov-2006, jmm, changed the argument list, now the output is a data id string, added a check for start time > end time 08-dec-2006, krb, changed load_thg_mag to thm_load_gmag 13-dec-2006, jmm, Added call to cdf2tplot for data for which there is no load program...

thm_ui_multichoice_history.pro

This program creates a string for the history array when multiple datatypes, spacecraft or stations are chosen, for use in the themis_w_event routine$LastChangedBy: cgoethel $$LastChangedDate: 2008-07-08 08:41:22 -0700 (Tue, 08 Jul 2008) $$LastChangedRevision: 3261 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/deprecated/thm_ui/thm_ui_multichoice_history.pro $

thm_ui_npar.pro

NAME: thm_ui_nparPURPOSE: Simple widget that allows user to change n parameter values and units (if units were specified)CALLING SEQUENCE: new_value = thm_ui_npar(name, init_value, [radio_array=radio_array], $ [radio_value=radio_value])INPUT: name = the name of the parameter, can be an array init_value = the initial value of the parameter, e.g., '1.0', must be a string array of the smae size as name radio_array = optional string array containing radio button names title=title = optional title for the panel radio_value = optional string containing the radio button to set initiallyOUTPUT: new_value = the output value of the parameters, a string array of values, e.g., ['4.67', '3.0', ...n] if optional radio buttons were used the last element of the array will contain the radio button selection, e.g., ['4.67', '3.0', ..., 'inches']METHODS: thm_ui_npar0 - creates the window, widgets, and calls the xmanager thm_ui_npar0_event - event handler for the window (handles parameter input, cancel/ accept buttons, and window close 'X' thm_ui_rad_event - event handler for the radio buttons; thm_ui_npar0 - creates the window, widgets, and calls the xmanagerHISTORY: 5-feb-2007, jmm, jimm@ssl.berkeley.edu 25-OCt-2007, jmm, added KILL_REQUEST block 15-may-2008, cg, added optional title for widget$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/spdsoft/trunk/projects/themis/deprecated/thm_ui/thm_ui_npar.pro $

thm_ui_npar_new.pro

NAME: thm_ui_npar_newPURPOSE: Simple widget that allows user to change n parameter values and units (if units were specified)CALLING SEQUENCE: new_value = thm_ui_npar_new(name, init_value, [radio_array=radio_array], $ [radio_value=radio_value])INPUT: name = the name of the parameter, can be an array init_value = the initial value of the parameter, e.g., '1.0', must be a string array of the smae size as name radio_array = optional string array containing radio button names title=title = optional title for the panel radio_value = optional string containing the radio button to set initiallyOUTPUT: new_value = the output value of the parameters, a string array of values, e.g., ['4.67', '3.0', ...n] if optional radio buttons were used the last element of the array will contain the radio button selection, e.g., ['4.67', '3.0', ..., 'inches']METHODS: thm_ui_npar_new0 - creates the window, widgets, and calls the xmanager thm_ui_npar_new0_event - event handler for the window (handles parameter input, cancel/ accept buttons, and window close 'X' thm_ui_rad_event - event handler for the radio buttons; thm_ui_npar_new0 - creates the window, widgets, and calls the xmanagerHISTORY: 5-feb-2007, jmm, jimm@ssl.berkeley.edu 25-OCt-2007, jmm, added KILL_REQUEST block 15-may-2008, cg, added optional title for widget 20-jan-2009, jmm, Testing SVN 20-jan-2009, jmm, Testing SVN again 20-jan-2009, jmm, And again$LastChangedBy: lphilpott $$LastChangedDate: 2012-06-18 14:37:32 -0700 (Mon, 18 Jun 2012) $$LastChangedRevision: 10578 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/deprecated/thm_ui/thm_ui_npar_new.pro $

thm_ui_only_trange.pro

NAME: thm_ui_only_trangePURPOSE: This program oprerates on the tplot data_quants to strip out data the is not in the input time range: start time, end time, and the subscripts of the appropriate data_quants structures are used, this is designed to be used in thm_ui_load_data_fn only...

thm_ui_par.pro

NAME: thm_ui_parPURPOSE: Simple widget that asks for a parameterCALLING SEQUENCE: new_value = thm_ui_par(name, init_value)INPUT: name = the name of the parameter, e.g., 'time_resolution' init_value = the initial value of the parameter, e.g., '1.0', must be a string.

thm_ui_progobj__define.pro

thm_ui_pwrspc.pro

NAME: tpwrspcPURPOSE: wapper for pwrspc.pro for calling from GUI, a split_vec is performed on the data if necessaryCALLING SEQUENCE: thm_ui_pwrspc, varnames, new_names, trange, history_ext, $ polar = polar, dynamic = dynamic, _extra = _extraINPUT: varnames = an array (or scalar) of tplot variable namesOutput new_names = the variable names of any new variablesHISTORY: 28-mar-2007, jmm, jimm.ssl.berkeley.edu 2-apr-2007, jmm, added the /dynamic keyword 5-jun-2007, jmm, no longer handles history$LastChangedBy: cgoethel $$LastChangedDate: 2008-07-08 08:41:22 -0700 (Tue, 08 Jul 2008) $$LastChangedRevision: 3261 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/deprecated/thm_ui/thm_ui_pwrspc.pro $

thm_ui_reset_common_block.pro

This puts the input data structure into the tplot common block as the data_quants structure, and undefines all of the other variables in the common block, using temporary, the original common block is saved in a different common block.

thm_ui_sclist.pro

NAME: thm_ui_sclistPURPOSE: creates an array for the different themis spacecraft, to be used in a list widgetCALLING SEQUENCE: sclist = thm_ui_sclist()INPUT: noneOUTPUT: sclist = ['THA', 'THB', 'THC', 'THD', 'THE']$LastChangedBy: cgoethel $$LastChangedDate: 2008-07-08 08:41:22 -0700 (Tue, 08 Jul 2008) $$LastChangedRevision: 3261 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/deprecated/thm_ui/thm_ui_sclist.pro $

thm_ui_scmcal.pro

NAME: thm_ui_scmcalPURPOSE: A widget for choosing data for the THEMIS data analysis GUI This was specifically built for SCM data and displays additional user inputs for configuration settingsCALLING SEQUENCE: thm_ui_scmcal, gui_id, instr_in0INPUT: gui_id - gui id number for the main panel instr_in0 - instrument nameOUTPUT: cal_params - structure of SCM calibration parametersHISTORY:AUTHOR: Cindy Goethel$LastChangedBy: lphilpott $$LastChangedDate: 2012-06-14 10:40:21 -0700 (Thu, 14 Jun 2012) $$LastChangedRevision: 10557 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/deprecated/thm_ui/thm_ui_scmcal.pro $ cal_base

thm_ui_scmcal_help.pro

thm_ui_set_active_dset.pro

NAME: thm_ui_set_active_dsetPURPOSE: sets active datasets in themis GUI to given tplot varnames, used in the call_tplot widget.

thm_ui_set_data_id.pro

NAME: thm_ui_set_data_idPURPOSE: This program sets the data_id values of the pointer in the thm_gui state structure, given the tplot common block:INPUT: state_or_id = thm_gui state structure, or gui_idHISTORY: 26-feb-2007, jmm, jimm@ssl.berkeley.edu 10-may-2007, jmm, allow for input of the gui_id instead of the state$LastChangedBy: pcruce $$LastChangedDate: 2013-09-19 11:51:11 -0700 (Thu, 19 Sep 2013) $$LastChangedRevision: 13087 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/deprecated/thm_ui/thm_ui_set_data_id.pro $

thm_ui_set_tlimits.pro

thm_ui_set_trange.pro

thm_ui_show_dlim.pro

Name:THM_UI_SHOW_DLIM.PROSyntax: THM_UI_SHOW_DLIM ,tplot_name, group=group where, tplot_name is the name string or index number of a single tplot variable.

thm_ui_summplot.pro

thm_ui_tselect.pro

thm_ui_tselect_fn.pro

Calls the thm_tselect widget, returns the value..

thm_ui_update_data_all.pro

NAME: thm_ui_update_data_allPURPOSE: 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_vnamesINPUT: gui_id = a widget id for the guiOUTPUT: noneHISTORY: 5-jun-2007, jmm, jimm@ssl.berkeley.edu 7-may-2008, jmm, sort and uniq functionality is handled by tnames call.

thm_ui_update_data_display.pro

NAME: thm_ui_update_data_displayPURPOSE: update the loaded-data display for the themis_w widgetCALLIMG SEQUENCE: thm_ui_update_data_display, widget_idINPUT: widget_id = the id number of the widgetHISTORY: 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: cgoethel $$LastChangedDate: 2008-07-08 08:41:22 -0700 (Tue, 08 Jul 2008) $$LastChangedRevision: 3261 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/deprecated/thm_ui/thm_ui_update_data_display.pro $

thm_ui_update_history.pro

NAME: thm_ui_update_historyPURPOSE: Adds the string input to the state structure history arrayINPUT: string = a string to add to the history array.

thm_ui_update_progress.pro

NAME: thm_ui_update_progressPURPOSE: Write a string into the progress widget for the THEMIS GUICALLING SEQUENCE: thm_ui_update_progress, gui_id, input_stringINPUT: gui_id = the widget_id for the GUI input_string = a string to be displayedOUTPUT: NoneKEYWORDS: message_wid = id for any other message widgets that you might like to display the messagesHISTORY: jmm, 9-may-2007, jimm@ssl.berkeley.edu jmm, 5-mar-2008, added multiple lines, and the ability to show in multiple message widgets.

thm_ui_userdef.pro

thm_ui_valid_dtype.pro

NAME: thm_ui_valid_dtypePURPOSE: 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.

yesno_widget_fn.pro

NAME: yesno_widget_fnPURPOSE: Simple widget that asks for a yes or noCALLING SEQUENCE: yn=yesno_widget_fn(title, list = list, _extra = _extra)INPUT: title = a title, or a questionOUTPUT: yn = 0 for no, 1 for yesKEYWORDS: list, a string array to put in the widget, as an aidHISTORY: 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..