![[attach.png]](../../../idldoc-resources/attach.png)
Directory: spedas/gui/utilities/
Contents
.pro files
- cdf_version_test.pro
Procedure: cdf_version_test Purpose: Check that the patched version the CDF library (3.4+) is installed Note: The crash due to an unpatched CDF library is usually due to a change in the number of arguments of the function CDF_EPOCH_COMPARE.
- centertlb.pro
NAME: CENTERTLB PURPOSE: This is a utility routine to position a widget program on the display at an arbitrary location.
- check_dround.pro
- check_eround.pro
- colorbar.pro
NAME: COLORBAR PURPOSE: The purpose of this routine is to add a color bar to the current graphics window.
- error_message.pro
NAME: ERROR_MESSAGE PURPOSE: The purpose of this function is to have a device-independent error messaging function.
- example_data.pro
- formatannotation.pro
FUNCTION: formatannotationPURPOSE: This routine is used as a callback for axis labeling by IDLgrAxis Because it is a callback routine, IDL requires it to have this specific form.
- formatdate.pro
- fsc_color.pro
NAME: FSC_COLOR PURPOSE: The purpose of this function is to obtain drawing colors by name and in a device/decomposition independent way.
- fsc_field.pro
NAME: FSC_FIELD PURPOSE: The purpose of this compound widget is to provide an alternative to the CW_FIELD widget offered in the IDL distribution.
- get_intro_dir.pro
Call this function to return the absolute file path to the introduction directory (used to store files for the Introduction to IDL class) on your computer.
- get_max_memblock.pro
NAME: get_max_memblock.proPURPOSE: Returns size of largest contiguous block of memory available to IDL in megabytes.
- get_max_memblock2.pro
NAME: get_max_memblock2.proPURPOSE: Returns size of largest contiguous block of memory available to IDL in megabytes.
- get_thm_palette.pro
NAME: get_thm_palettePURPOSE: returns an IDLgrPalette object that has emulates spedas colors, so the settings can be properly read out of dlimits.
- getctpath.pro
NAME: getctpathPURPOSE: gets the path of the color table on the file systemCALLING SEQUENCE: getctpath,color_table_pathOUTPUT: color_table_path: the path to the color table$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/trunk/spedas/gui/utilities/getctpath.pro $
- gethelppath.pro
NAME: gethelppathPURPOSE: gets the path of the help directory in a cross platform wayCALLING SEQUENCE: gethelppath,pathOUTPUT: path: the path to the resource directory$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/trunk/spedas/gui/utilities/gethelppath.pro $
- getresourcepath.pro
NAME: getresourcepathPURPOSE: gets the path of the resource directory in a cross platform wayCALLING SEQUENCE: getresourcepath,pathOUTPUT: path: the path to the resource directory$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/trunk/spedas/gui/utilities/getresourcepath.pro $
- load_data.pro
A program for loading data files used in the ITT VIS course Introduction to IDL.
- loaddata.pro
NAME: LOADDATA PURPOSE: The purpose of this function is to read a selection of standard data sets that are found in the normal IDL distribution in the subdirectory $IDL_DIR/examples/data.
- makecolortable.pro
NAME: makecolortablePURPOSE: makes the color table file for the spedas guiCALLING SEQUENCE: makecolortableEFFECTS: overwrites the file spedas/spd_ui/utilities/spd_gui_colors.tbl$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/trunk/spedas/gui/utilities/makecolortable.pro $
- open_spedas_document.pro
PRO: open_spedas_documentPURPOSE: opens a spedas documentInputs: info: info struct from main gui event handler filename:name of the file nodelete:indicates that preexisting data should not be deleted during readOutputs: statuscode: negative value indicates failure, 0 indicates success statusmsg: a message to be returned in the event of an error$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/trunk/spedas/gui/utilities/open_spedas_document.pro $
- open_spedas_template.pro
PRO: open_spedas_templatePURPOSE: opens a spedas templateInputs: filename:name of the fileOutputs: statuscode: negative value indicates failure, 0 indicates success statusmsg: a message to be returned in the event of an error template: the template object$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/trunk/spedas/gui/utilities/open_spedas_template.pro $
- pickcolor.pro
NAME: PICKCOLOR PURPOSE: A modal dialog widget allowing the user to select the RGB color triple specifying a color.
- pickcolorname.pro
NAME: PICKCOLORNAME PURPOSE: The purpose of this program is to provide a blocking or modal widget interface for selecting a color "name".
- progressbar__define.pro
NAME: PROGRESSBAR__DEFINE PURPOSE: Creates a simple progress bar for indicating the progess of a looping operation in IDL.
- save_document.pro
PRO: save_documentPURPOSE: saves a spedas documentInputs: windowstorage: windowstorage object storing the draw tree to be save filename:name of the fileOutputs: statuscode: negative value indicates failure, 0 indicates success statusmsg: a message to be returned in the event of an error$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/trunk/spedas/gui/utilities/save_document.pro $
- save_spedas_template.pro
PRO: save_spedas_templatePURPOSE: saves a spedas templateInputs: template:the template object to be saved filename:name of the fileOutputs: statuscode: negative value indicates failure, 0 indicates success statusmsg: a message to be returned in the event of an error$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/trunk/spedas/gui/utilities/save_spedas_template.pro $
- saveas_ascii.pro
NAME: saveas_ascii.proPURPOSE: Saves SPEDAS Loaded Data variables in ASCII format.
- saveas_upper_flatfile.pro
- sourcepath.pro
This procedure returns the directory path associated with the routine calling this function.
- sourceroot.pro
The SOURCEROOT function, in combination with FILEPATH, allows a program to locate other files within a routine source file's related directory tree.
- spd_find_file.pro
Procedure: spd_find_filePurpose: Check for the existence of a file in the current path.
- spd_gui_init.pro
NAME: spd_gui_initPURPOSE:the very beginnings of global configuration infofor spd_guiCALLING SEQUENCE: spedas_gui_new_initINPUT: noneOUTPUT: noneHISTORY:$LastChangedBy: pcruce $$LastChangedDate: 2014-02-11 14:17:27 -0800 (Tue, 11 Feb 2014) $$LastChangedRevision: 14333 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/utilities/spd_gui_init.pro $
- spd_ui_calendar.pro
NAME: spd_ui_calendar.proPURPOSE: Calendar selection widget for the GUICALLING SEQUENCE: spd_ui_calendar,title, otime, gui_id, startyearINPUT: title: Title of the calendar window otime: Time object gui_id: Widget ID of the widget that called the calendar startyear: Start year in 'Year' listHISTORY: $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
- spd_ui_call_plugin.pro
Procedure: spd_ui_call_pluginPurpose: Opens specified GUI plugin window.
- spd_ui_check_overlap.pro
NAME: spd_ui_check_overlapPURPOSE: Determins if any panels on the current page are overlapping.
- spd_ui_check_overwrite_data.pro
Name: spd_ui_check_overwrite_data Purpose: Used to check if data is already loaded in the GUI and queries the user to see if they want to overwrite data if it is already loaded.
- spd_ui_cleanup_tplot.pro
NAME: spd_ui_cleanup_tplotPURPOSE: Abstracts the oft-repeated operation which identifies new tplot variables, and identifies variables that should be deletedCALLING SEQUENCE: tnames_before = tnames('*',create_time=cn_before) thm_load_state ;some operation spd_ui_cleanup_tplot,tnames_before,create_time_before=cn_before,del_vars=del_vars,new_vars=new_varsInputs: tnames_before: a list of tplot names from before the operation in questionKeywords: create_time_before(optional,input): This is an array of the create times associated with tnames_before This argument is only required if you want the list of new_vars new_vars(output): This will output an array of new tplot variable names, if create_time_before was specified del_vars(output): This will output an array of tplot variable names to delete.
- spd_ui_combobox.pro
NAME: SPD_UI_COMBOBOX PURPOSE: IDL combobox doesn't actually support null strings('') as entries in the combobox.
- spd_ui_data_minmax.pro
NAME: spd_ui_data_minmaxPURPOSE: Returns a two-element array containing the mininum and maximum values contained in the loadedData quantity specified by the NAME positional parameter.
- spd_ui_dialog_pickfile_save_wrapper.pro
Name: SPD_UI_DIALOG_PICKFILE_SAVE_WRAPPER Purpose: Wrapper for the IDL routine dialog_pickfile.
- spd_ui_do_nudge.pro
NAME: spd_ui_do_nudgePURPOSE: Abstracted nudge data operationCALLING SEQUENCE: spd_ui_do_nudge,INPUT: gui_id = widget id of the widget that called this program info = the info structure of the Main GUIOUTPUT: fail=failHISTORY:$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/trunk/spedas/gui/utilities/spd_ui_do_nudge.pro $
- spd_ui_dproc.pro
- spd_ui_fix_performance.pro
NAME: spd_ui_fix_performancePURPOSE: This fixes issue IDL-68782: in Linux, some drawing operations are very slow for IDL 8.3 another solution would be win = obj_new("idlgrwindow", LINE_QUALITY=0) it might be useful for windows, tooHISTORY:$LastChangedBy: $$LastChangedDate: $$LastChangedRevision: $$URL: $
- spd_ui_get_combobox_select.pro
Purpose: Return the index of specified combobox widget's current selection.
- spd_ui_get_panels.pro
NAME: spd_ui_get_panelsPURPOSE: Generic GUI function for returning the panel names and panel objects given a windowCALLING SEQUENCE: panel_names = spd_ui_get_panels(window, panelObjs = panelObjs)INPUT: window: current active window, see the following example:EXAMPLE: window = windowStorage->getActive() panel_names = spd_ui_get_panels(window, panelObjs=panelObjs)OUTPUT: names of the panels on the current page, or a single element array with 'No Panels' if there aren't any panels on the current page$LastChangedBy: egrimes $$LastChangedDate: 2014-07-24 12:19:29 -0700 (Thu, 24 Jul 2014) $$LastChangedRevision: 15603 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/utilities/spd_ui_get_panels.pro $
- spd_ui_getlengthvars.pro
FUNCTION: spd_ui_getlengthvarsPURPOSE: helper function for formatannotationInputs:Example:$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/trunk/spedas/gui/utilities/spd_ui_getlengthvars.pro $
- spd_ui_interpolate.pro
NAME: spd_ui_interpolatePURPOSE: Interpolates over x-axis of active data and adds new data to loaded data object.
- spd_ui_match_background.pro
A procedure to match the background color of a bitmap to that of the OS GUI.
- spd_ui_message.pro
Procedure: spd_ui_messagePurpose: Output messages to the history window, status bar, and/or dialog message pop-up.
- spd_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 spedas_w_event routine$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/trunk/spedas/gui/utilities/spd_ui_multichoice_history.pro $
- spd_ui_open_url.pro
NAME: spd_ui_open_urlPURPOSE: Open an url in the default web browser.
- spd_ui_overplot.pro
Purpose: To make mission overview plots of all instruments Inputs: PROBES: spacecraft ('a','b','c','d','e') DATE: the date string or seconds since 1970 ('2007-03-23') DUR: duration (default units are days) DAYS: redundant keyword to set the units of duration (but its comforting to have) HOURS: keyword to make the duration be in units of hours DEVICE: sets the device (x or z) (default is x) MAKEPNG: keyword to generate 5 png files DIRECTORY: sets the directory where the above pngs are placed (default is './') DONT_DELETE_DATA: keyword to not delete all existing tplot variables before loading data in for the overview plot (sometimes old variables can interfere with overview plot) ERROR: Tells the calling routine whether an error that prevented overplot completion occured.
- spd_ui_part_getspec_replay.pro
Purpose: Wrapper to thm_part_products, to be called during replay by spd_ui_call_sequence Modularizes some operations.
- spd_ui_plugin_menu.pro
Procedure: spd_ui_plugin_menuPurpose: Searches for and adds plugin items to the GUI plugin menu.
- spd_ui_plugin_replay.pro
Procedure: spd_ui_plugin_replayPurpose: Replays data modification operations performed by GUI plugins when loading GUI documents.
- spd_ui_prompt_widget.pro
NAME: spd_ui_prompt_widget.proPURPOSE: Simple standardized popup, for yes/no,yes_to_all,no_to_all,cancel Like dialog_message, but allows additional options, and automatically logs/promptsCALLING SEQUENCE: result = spd_ui_prompt_widget(parent,statusbar,historywin,"Continue?")INPUT: parent: Widget Id of parent widget(Note that if parent is invalid, it will block until a response is received.
- spd_ui_pwrspc.pro
NAME: spd_ui_pwrspcPURPOSE: Creates power spectra from GUI variables that are active in the Process Data window and loads the spectra into the loadedData object.
- spd_ui_req_slp.pro
NAME: spd_ui_req_slpPURPOSE: Determines availablity of solar/lunar ephemeris data.
- spd_ui_req_spin.pro
NAME: spd_ui_req_spinPURPOSE: Determines availability of parameters for spin model.
- spd_ui_run_calc.pro
NAME: spd_ui_run_calcPURPOSE: Function that interprets program for spd_ui_calculateCALLING SEQUENCE: spd_ui_run_calc,programtext,loadeddata,historywin,statusbar,error=errorINPUT: programText: array of strings, text of program loadeddata: the loaded data object historywin: the historywin object statusbar: the statusbar objectOUTPUT: error=error: set to named variable, will be 0 on success, will be set to error struct returned by calc.pro on failureHISTORY:$LastChangedBy: pcruce $$LastChangedDate: 2014-05-27 16:29:10 -0700 (Tue, 27 May 2014) $$LastChangedRevision: 15236 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/utilities/spd_ui_run_calc.pro $
- spd_ui_sbar_hwin_update.pro
Name spd_ui_sbar_hwin_update Purpose: Wrapper routine for updating the status bar and history window objects also handles dialog messages from error handlers Arguments: state: state structure from the top level widget, contains the history window and status bar objects message: string or array of strings to write to the history window and status bar objects /nohistoryWin: flag to turn off updating the history window object /nostatusBar: flag to turn off updating the status bar object /error: flag indicating an error sent us here err_msgbox_title: title to be displayed in the error msgbox$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/trunk/spedas/gui/utilities/spd_ui_sbar_hwin_update.pro $
- spd_ui_set_cursor.pro
NAME: spd_ui_set_cursorPURPOSE: Replaces the cursor on non-windows machinesCALLING SEQUENCE: spd_ui_set_cursor,winINPUT: win: an IDLgrWindowOUTPUT: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/trunk/spedas/gui/utilities/spd_ui_set_cursor.pro $
- spd_ui_spdf_replay.pro
spdfcdawebchooser GUI load code is structured in such a way that it would be very difficult to abstract.
- spd_ui_spinner.pro
NAME: SPD_UI_SPINNER PURPOSE: A compound 'spinner' widget for editing numerical values.
- spd_ui_time_widget.pro
NAME: spd_ui_time_widget.proPURPOSE: Compound widget used to generate standardized time selection ui, for all tabs in the load data window.
- spd_ui_timefix.pro
NAME: spd_ui_timefixPURPOSE: Will fix an input time string of yyyy-mm-dd hh:mm:ss.xxxx if there is only 1 digit in the day or hour or second, etc.
- spd_ui_track_one.pro
Procedure: spd_ui_track_onePurpose: Switches on single-panel tracking by setting the appropriate flags in the GUI's main storage structure.
- spd_ui_update_progress.pro
NAME: spd_ui_update_progressPURPOSE: Write a string into the progress widget for the THEMIS GUICALLING SEQUENCE: spd_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.
- spd_ui_update_range.pro
- spd_ui_usingexponent.pro
FUNCTION: spd_ui_usingexponentPURPOSE: Used to determine if any of a set of inputs will be put into exponential notationInputs:The data struct is an input to format annotationdata.exponent values:0: autoformat1: decimal2: scientific3: base^x4: hexadecimalOutputs:Determine format type:
- spd_ui_validate_file.pro
PRO: spd_ui_validate_filePURPOSE: Verifies file read/write permissions and file availabilityInputs: filename:name of the fileOutputs: statuscode: negative value indicates failure, 0 indicates success statusmsg: a message to be returned in the event of an errorKeywords: write: validate for save$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/trunk/spedas/gui/utilities/spd_ui_validate_file.pro $
- spd_ui_wavelet.pro
NAME: spd_ui_waveletPURPOSE: wavelet transform of the input tplot variables, fist calls split_vec to split up any multi-component vectors.
- stringisnum.pro
Function: stringIsNumPurpose: Determines if a given string is a number or not.
- transparent_polygon.pro
- tvimage.pro
NAME: TVIMAGE PURPOSE: This purpose of TVIMAGE is to enable the TV command in IDL to be a completely device-independent and color-decomposition- state independent command.
- tvread.pro
NAME: TVREAD PURPOSE: To get accurate screen dumps with the IDL command TVRD on 24-bit PC and Macintosh computers, you have to be sure to set color decomposition on.