This page was created by the IDL library routine
mk_html_help2.
Last modified: Thu Aug 6 12:53:14 2020.
NAME: spd_gui_error PURPOSE: A widget to display, edit and save the file 'spd_gui_error.txt' error $LastChangedBy: egrimes $ $LastChangedDate: 2019-08-27 12:32:12 -0700 (Tue, 27 Aug 2019) $ $LastChangedRevision: 27676 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_gui_error.pro $
(See spedas_gui/panels/spd_gui_error.pro)
Function:
spd_ui_add_variable
Purpose:
Widget for selecting a variable in the GUI
Input:
guiId: standard ID of the master widget
loadedData: object containing loadedData
guiTree: pointer to the widget tree
historywin: history window object
statusBar: status bar object
Output:
Returns an array of strings containing the selected data
Keywords:
multi: allow multple selections
control: no interpolation; match the selected data to the control variable point-by-point
leafonly: only allow the user to select a leaf
treemode: selection mode for the tree widget. See the header of the spd_ui_widget_tree object
for details
windowtitle: override the default window title
$LastChangedBy: jimm $
$LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
$LastChangedRevision: 14326 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_add_variable.pro $
(See spedas_gui/panels/spd_ui_add_variable.pro)
NAME: spd_ui_axis_options PURPOSE: User interface for modifying axis settings CALLING SEQUENCE: spd_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 spd_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: nikos $ $LastChangedDate: 2017-10-03 14:12:59 -0700 (Tue, 03 Oct 2017) $ $LastChangedRevision: 24103 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_axis_options.pro $
(See spedas_gui/panels/spd_ui_axis_options.pro)
set_minor SPD_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 spedas_gui/panels/spd_ui_axis_options.pro)
Procedure: spd_ui_update_axis_from_draw
Syntax:
SPD_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 spedas_gui/panels/spd_ui_axis_options.pro)
SPD_UI_INIT_AXIS_WINDOW.PRO Given the top level base when running SPD_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: SPD_UI_INIT_AXIS_WINDOW , [ tlb ] [ , state = state ] W.M.Feuerstein, 11/7/2008.
(See spedas_gui/panels/spd_ui_axis_options.pro)
NAME: spd_ui_calculate PURPOSE: A widget interface for selecting data CALLING SEQUENCE: spd_ui_calculate, master_widget_id INPUT: master_widget_id = the id number of the widget that calls this program OUTPUT: none HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2015-01-05 17:01:57 -0800 (Mon, 05 Jan 2015) $ $LastChangedRevision: 16596 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_calculate.pro $
(See spedas_gui/panels/spd_ui_calculate.pro)
NAME: spd_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: spd_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 24-apr-2015, af, event handler uses uname instead of uvalue $LastChangedBy: aaflores $ $LastChangedDate: 2015-04-24 18:45:02 -0700 (Fri, 24 Apr 2015) $ $LastChangedRevision: 17429 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_dproc_panel.pro $
(See spedas_gui/panels/spd_ui_dproc_panel.pro)
NAME: spd_ui_export_marker PURPOSE: This routine creates and handles the panel for exporting marker data CALLING SEQUENCE: spd_ui_marker_options INPUT: gui_id: id for the master base widget (tlb) OUTPUT: HISTORY: $LastChangedBy: jimm $ $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $ $LastChangedRevision: 14326 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_export_markers.pro $
(See spedas_gui/panels/spd_ui_export_markers.pro)
Name:
spd_ui_field_models
Purpose:
Panel for producing magnetic field models in SPEDAS
$LastChangedBy: nikos $
$LastChangedDate: 2018-06-19 12:03:48 -0700 (Tue, 19 Jun 2018) $
$LastChangedRevision: 25372 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_field_models.pro $
(See spedas_gui/panels/spd_ui_field_models.pro)
NAME: spd_ui_help_about PURPOSE: A widget to display About information (SPEDAS Version) $LastChangedBy: nikos $ $LastChangedDate: 2018-10-29 09:47:11 -0700 (Mon, 29 Oct 2018) $ $LastChangedRevision: 26022 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_help_about.pro $
(See spedas_gui/panels/spd_ui_help_about.pro)
NAME: spd_ui_help_window PURPOSE: A widget to display the file 'spd_gui.txt' help $LastChangedBy: nikos $ $LastChangedDate: 2016-10-20 14:45:33 -0700 (Thu, 20 Oct 2016) $ $LastChangedRevision: 22170 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_help_window.pro $
(See spedas_gui/panels/spd_ui_help_window.pro)
NAME:
spd_ui_image_export
PURPOSE:
This window allows the user to pick the filename/type for image export
CALLING SEQUENCE:
spd_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: 2018-10-11 14:29:36 -0700 (Thu, 11 Oct 2018) $
$LastChangedRevision: 25961 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_image_export.pro $
(See spedas_gui/panels/spd_ui_image_export.pro)
NAME:
spd_ui_image_export_options
PURPOSE:
This window allows the selection of file export options
for various formats.
CALLING SEQUENCE:
spd_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: jimm $
$LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
$LastChangedRevision: 14326 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_image_export_options.pro $
(See spedas_gui/panels/spd_ui_image_export_options.pro)
NAME:
spd_ui_init_load_window
PURPOSE:
Sets up the window and tab widgets for loading data into the SPEDAS GUI.
CALLING SEQUENCE:
spd_ui_init_load_window, gui_id, windowStorage, loadedData, historyWin, $
timerange, treeCopyPtr, loadDataTabs
INPUT:
gui_id: The id of the main GUI window.
windowStorage: The windowStorage object.
loadedData: The loadedData object.
historyWin: The history window object.
timerange: The GUI timerange object.
treeCopyPtr: Pointer variable to a copy of the load widget tree.
loadDataTabs: an array of structures containing the "Load Data" panels, loaded via pluginManager->getLoadDataPanels()
KEYWORDS:
none
OUTPUT:
none
HISTORY:
$LastChangedBy: egrimes $
$LastChangedDate: 2015-05-22 10:59:17 -0700 (Fri, 22 May 2015) $
$LastChangedRevision: 17673 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_init_load_window.pro $
(See spedas_gui/panels/spd_ui_init_load_window.pro)
NAME: spd_ui_jump PURPOSE: small window that allows the user to enter a new start time for the x axis CALLING SEQUENCE: spd_ui_jump INPUT: gui_id id of the top level base widget that is calling this routine OUTPUT: HISTORY: $LastChangedBy: jimm $ $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $ $LastChangedRevision: 14326 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_jump.pro $
(See spedas_gui/panels/spd_ui_jump.pro)
NAME: spd_ui_legend_options PURPOSE: A widget interface for changing legend settings CALLING SEQUENCE: spd_ui_legend_options, info INPUT: info: info structure from spd_gui KEYWORDS: panel_select: pointer to current panel $LastChangedBy: nikos $ $LastChangedDate: 2017-10-03 14:12:59 -0700 (Tue, 03 Oct 2017) $ $LastChangedRevision: 24103 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_legend_options.pro $
(See spedas_gui/panels/spd_ui_legend_options.pro)
NAME: spd_ui_load_hapi PURPOSE: Load data from a HAPI server $LastChangedBy: egrimes $ $LastChangedDate: 2019-08-27 11:53:41 -0700 (Tue, 27 Aug 2019) $ $LastChangedRevision: 27673 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_load_hapi.pro $
(See spedas_gui/panels/spd_ui_load_hapi.pro)
NAME:
spd_ui_manage_data
PURPOSE:
panel which allows user to import and export tplot data
CALLING SEQUENCE:
spd_ui_manage_data,gui_id
INPUT:
gui_id: id of top level base widget from calling program
OUTPUT:
HISTORY:
$LastChangedBy: nikos $
$LastChangedDate: 2018-10-11 13:55:48 -0700 (Thu, 11 Oct 2018) $
$LastChangedRevision: 25960 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_manage_data.pro $
(See spedas_gui/panels/spd_ui_manage_data.pro)
NAME: spd_ui_marker_options PURPOSE: This routine creates a window for the user to set options for markers CALLING SEQUENCE: spd_ui_marker_options INPUT: gui_id: id for the master base widget (tlb) OUTPUT: HISTORY: $LastChangedBy: jimm $ $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $ $LastChangedRevision: 14326 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_marker_options.pro $
(See spedas_gui/panels/spd_ui_marker_options.pro)
NAME:
spd_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:
spd_ui_marker_title, gui_id
INPUT:
gui_id id of top level base widget from calling program
OUTPUT:
HISTORY:
$LastChangedBy: jimm $
$LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
$LastChangedRevision: 14326 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_marker_title.pro $
(See spedas_gui/panels/spd_ui_marker_title.pro)
Name:
spd_ui_mdd_help
Purpose:
Additional information for the MDD GUI
$LastChangedBy: egrimes $
$LastChangedDate: 2014-08-21 12:21:00 -0700 (Thu, 21 Aug 2014) $
$LastChangedRevision: 15698 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/panels/spd_ui_neutral_sheet_help.pro $
(See spedas_gui/panels/spd_ui_mdd_help.pro)
NAME: spd_ui_mdd_std PURPOSE: Generates the GUI for minimum variance analysis. HISTORY: $LastChangedBy: egrimes $ $LastChangedDate: 2015-04-15 15:14:31 -0700 (Wed, 15 Apr 2015) $ $LastChangedRevision: 17332 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/ace/spedas_plugin/ace_ui_load_data.pro $
(See spedas_gui/panels/spd_ui_mdd_std.pro)
NAME: spd_ui_mva PURPOSE: Generates the GUI for minimum variance analysis. HISTORY: $LastChangedBy: egrimes $ $LastChangedDate: 2015-04-15 15:14:31 -0700 (Wed, 15 Apr 2015) $ $LastChangedRevision: 17332 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/ace/spedas_plugin/ace_ui_load_data.pro $
(See spedas_gui/panels/spd_ui_mva.pro)
Name:
spd_ui_mva_help
Purpose:
Additional information for the MVA GUI
$LastChangedBy: egrimes $
$LastChangedDate: 2014-08-21 12:21:00 -0700 (Thu, 21 Aug 2014) $
$LastChangedRevision: 15698 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/panels/spd_ui_neutral_sheet_help.pro $
(See spedas_gui/panels/spd_ui_mva_help.pro)
Name:
spd_ui_neutral_sheet_help
Purpose:
Panel for producing magnetic neutral sheet models in SPEDAS
$LastChangedBy: egrimes $
$LastChangedDate: 2014-08-21 12:21:00 -0700 (Thu, 21 Aug 2014) $
$LastChangedRevision: 15698 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/panels/spd_ui_neutral_sheet_help.pro $
(See spedas_gui/panels/spd_ui_neutral_sheet_help.pro)
Name:
spd_ui_neutral_sheet_models
Purpose:
Panel for producing magnetic neutral sheet models in SPEDAS
$LastChangedBy: egrimes $
$LastChangedDate: 2014-08-21 12:21:00 -0700 (Thu, 21 Aug 2014) $
$LastChangedRevision: 15698 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/panels/spd_ui_neutral_sheet_models.pro $
(See spedas_gui/panels/spd_ui_neutral_sheet_models.pro)
NAME: spd_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: spd_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: jimm $ $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $ $LastChangedRevision: 14326 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_nudge_options.pro $
(See spedas_gui/panels/spd_ui_nudge_options.pro)
NAME:
spd_ui_overplot_key
PURPOSE:
Pops up a window that displays an overview plot key (the same one that's on the website).
CALLING SEQUENCE:
spd_ui_overplot_key, gui_id, historyWin, modal=modal, goes=goes
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
goes: display the GOES overview plot key.
If this is set, it should be set to the GOES spacecraft #,
as GOES 8-12 and GOES 13-15 have different overview plots
OUTPUT:
none
$LastChangedBy: crussell $
$LastChangedDate: 2017-07-19 14:37:28 -0700 (Wed, 19 Jul 2017) $
$LastChangedRevision: 23669 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_overplot_key.pro $
(See spedas_gui/panels/spd_ui_overplot_key.pro)
NAME: spd_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 spd_ui_page_set_value which is applicable to a single page
(See spedas_gui/panels/spd_ui_page_options.pro)
NAME:
spd_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 spedas_gui/panels/spd_ui_page_options.pro)
NAME:
spd_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 spedas_gui/panels/spd_ui_page_options.pro)
NAME:
spd_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 spedas_gui/panels/spd_ui_page_options.pro)
NAME:
spd_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 spedas_gui/panels/spd_ui_page_options.pro)
NAME: spd_ui_page_options PURPOSE: user interface panel that allows user to change page parameters CALLING SEQUENCE: spd_ui_page_options, gui_id INPUT: gui_id = the id number of the widget that calls this OUTPUT: HISTORY: $LastChangedBy: nikos $ $LastChangedDate: 2017-10-03 14:12:59 -0700 (Tue, 03 Oct 2017) $ $LastChangedRevision: 24103 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_page_options.pro $
(See spedas_gui/panels/spd_ui_page_options.pro)
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 SPD_UI_PAGE_OPTIONS_EVENT.PRO. W.M.Feuerstein, September 24, 2008. Function not currently in use.
(See spedas_gui/panels/spd_ui_page_options.pro)
NAME:
spd_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 spedas_gui/panels/spd_ui_page_options.pro)
NAME:
spd_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 spedas_gui/panels/spd_ui_page_options.pro)
NAME:
spd_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 spedas_gui/panels/spd_ui_page_options.pro)
NAME: spd_ui_panel_options PURPOSE: A widget interface for selecting data CALLING SEQUENCE: spd_uifile, 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: nikos $ $LastChangedDate: 2018-03-15 14:14:59 -0700 (Thu, 15 Mar 2018) $ $LastChangedRevision: 24892 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_panel_options.pro $
(See spedas_gui/panels/spd_ui_panel_options.pro)
NAME:
spd_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:
spd_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: jimm $
$LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
$LastChangedRevision: 14326 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_rename_variable.pro $
This is copied largely from spd_ui_verify_data
(See spedas_gui/panels/spd_ui_rename_variable.pro)
NAME: spd_ui_save_data PURPOSE: user interface panel for user to select whether to save data with the SPEDAS GUI Document along with the other settings that are saved in the file CALLING SEQUENCE: result = spd_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: jimm $ $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $ $LastChangedRevision: 14326 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_save_data.pro $
(See spedas_gui/panels/spd_ui_save_data.pro)
Gets all dataview descriptions.
@private
@param cdas {in} {required} {type=SpdfCdas}
the Coordinated Data Analysis System.
@returns objarr containing SpdfDataviewDescription objects for all
cdaweb dataviews.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Responds to an event requesting the retrieval of the data
specified by the users previous selections.
@param event {in} {type=widget_button}
event triggering the execution of this procedure.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Responds to an event
@param event {in} {type=widget_button}
event triggering the execution of this procedure.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Provides a GUI for choosing and retrieving data from
<a href="http://cdaweb.gsfc.nasa.gov/">CDAWeb</a>.
@keyword GROUP_LEADER {in} {type=int}
The widget ID of the group leader for this window. If
no value is provided, the resulting window will not
belong to a group and will be non-blocking.
@keyword historyWin {in} {type=int}
The widget ID of history of the main window
@keyword statusBar {in} {type=int}
The widget ID of statusBar of the main window
@keyword timeRangeObj {in} {type=obj}
Object reference for the GUI time range. (Allows webChooser to maintain time range state when panel is opened and closed)
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
NAME: spd_ui_spdfcdawebchooser PURPOSE: This procedure opens a GUI that can download CDF files from CDAWEB. CATEGORY: Widgets CALLING SEQUENCE: spd_ui_spdfcdawebchooser INPUTS: OPTIONAL INPUTS: KEYWORD PARAMETERS: GROUP_LEADER: This is the id of the calling widget, required to show as a modal window. HISTORYWIN: The history window of SPEDAS. Required for the calendar widget. STATUSBAR: The main bar of the main window of SPEDAS. Required for the calendar widget. OUTPUTS: This function returns a CDF file. Also, it stores the values into variable spd_spdfdata. If there is no data read, it shows a message to the user. EXAMPLE: spd_ui_spdfcdawebchooser, historyWin=info.historyWin, statusBar=info.statusBar, GROUP_LEADER = info.master NOTES:; This window was adapted from the file spdfCdawebChooser.pro of spdfcdas http://cdaweb.gsfc.nasa.gov/WebServices MODIFICATION HISTORY: $LastChangedBy: nikos $ $LastChangedDate: 2018-06-01 11:07:18 -0700 (Fri, 01 Jun 2018) $ $LastChangedRevision: 25311 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_spdfcdawebchooser.pro $
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Deletes DEPEND_TIME attributes for SPEDAS and ARTEMIS CDF files.
The problem is that CDA web creates CDF files with twice as many time points
but the EPOCH time points are correct. So we delete the DEPEND_TIME which points
to Unix times and then cdf2tplot will use EPOCH times.
This problem exists only for spedas and artemis.
@param cdffile {in} {type=string}
CDF filename (full path)
@returns new string
The same file without DEPEND_TIME attributes
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Gives a time string in the format used by spdf.
@param time {in} {type=string}
time in the SPEDAS format 2007-03-23/00:00:00.
@returns new string
time in the SPDF format 2007/03/23 00:00:00.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Responds to an event that initiates a termination of this program.
@param event {in} {type=widget_button}
event triggering the execution of this procedure.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Selects a dataview.
@param tlb {in} {type=int}
widget id of top level base.
@param dvList {in} {type=int}
widget id of dataview list widget.
@param dvIndex {in} {type=int}
index of dataview to select
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Executes the the operation to retrieve the specified data into this
IDL environment.
@param state {in} {type=struct}
widget program's state.
@param timeInterval {in} {type=SpdfTimeInterval}
time range of data to get.
@param datasetId {in} {type=string}
dataset identifier.
@param varNames {in} {type=strarr}
names of variables containing the desired data.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Gets the dataset and variable selection values.
@param datasetTree {in} {type=int}
id of dataset tree widget.
@param selectedDatasetId {out} {type=string}
id of selected dataset.
@param selectedVarNames {out} {type=strarr}
names of selected variables.
@returns 1 if a valid selections was made. 0 if the selection
was invalid.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Determines if the given string is a valid date/time value.
@param value {in} {type=string}
value to be tested.
@returns true if the given string is a valid date/time value.
Otherwise false.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Gets the specified time interval.
@param startTimeWidget {in} {type=int}
id of start time widget.
@param stopTimeWidget {in} {type=int}
id of stop time widget.
@returns specifed time interval or null object reference if an
invalid value was specified.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
Responds to an event requesting the retrieval of the data
specified by the users previous selections.
@param event {in} {type=widget_button}
event triggering the execution of this procedure.
(See spedas_gui/panels/spd_ui_spdfcdawebchooser.pro)
spd_ui_variable_options W.M.Feuerstein, 10/14/2008. Rewritten pcruce@igpp.ucla.edu 9/10/2009
(See spedas_gui/panels/spd_ui_variable_options.pro)
NAME: spd_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: spd_ui_variable_options, gui_id INPUT: gui_id: id for the master base widget (tlb) OUTPUT: HISTORY: $LastChangedBy: egrimes $ $LastChangedDate: 2019-08-29 10:55:26 -0700 (Thu, 29 Aug 2019) $ $LastChangedRevision: 27697 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_variable_options.pro $
(See spedas_gui/panels/spd_ui_variable_options.pro)
NAME:
spd_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:
spd_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: aaflores $
$LastChangedDate: 2015-04-24 18:45:02 -0700 (Fri, 24 Apr 2015) $
$LastChangedRevision: 17429 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_verify_data.pro $
(See spedas_gui/panels/spd_ui_verify_data.pro)
NAME:
spd_ui_widget_template
PURPOSE:
template that contains repeated code in widget creation
CALLING SEQUENCE:
spd_ui_widget_template,gui_id
INPUT:
gui_id: id of top level base widget from calling program
OUTPUT:
HISTORY:
$LastChangedBy: jimm $
$LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
$LastChangedRevision: 14326 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_widget_template.pro $
(See spedas_gui/panels/spd_ui_widget_template.pro)
NAME:
spd_ui_widget_tree_test
PURPOSE:
tests the tree widget
CALLING SEQUENCE:
spd_ui_widget_tree_test,gui_id
INPUT:
gui_id: id of top level base widget from calling program
OUTPUT:
HISTORY:
$LastChangedBy: jimm $
$LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
$LastChangedRevision: 14326 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_widget_tree_test.pro $
(See spedas_gui/panels/spd_ui_widget_tree_test.pro)
NAME:
Thm_ui_dproc_reset_act_data
PURPOSE:
helper function to reset the active data window in dproc panel
CALLING SEQUENCE:
spd_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: jimm $
$LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
$LastChangedRevision: 14326 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/spedas_gui/panels/spd_ui_dproc_reset_act_data.pro $
(See spedas_gui/panels/spd_ui_dproc_reset_act_data.pro)