Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

spedas/gui/objects/

spd_ui_loaded_data__dproc.pro


Routines

Routines from spd_ui_loaded_data__dproc.pro

result = wv_memory_test(t, jv)

estimate of memory used by a wavelet transform.

dproc_status_update, msg, sbar, hwin, _extra=_extra

NAME: dproc_status_updatePURPOSE: Outputs messages to history window, status bar, or IDL consoleCALLING SEQUENCE: dproc_status_update, 'There was an error', sbar, hwin dproc_status_update, 'There was an error', hwin dproc_status_update, 'There was an error', sbarINPUT: msg: string or string array containing message sbar: obj reference for status bar hwin: obj reference for history windowNOTES: Messages will be printed to the IDL console if the history window reference is missing or invalid.

result = spd_ui_loaded_data::dproc(dp_task, dp_pars, callSequence=callSequence, replay=replay, in_vars=in_vars, names_out=names_out, no_setactive=no_setactive, hwin=hwin, sbar=sbar, gui_id=gui_id, overwrite_selections=overwrite_selections, degap_selections=degap_selections, blkavg_selections=blkavg_selections, smooth_selections=smooth_selections, hpf_selections=hpf_selections, _extra=_extra)

NAME: spd_ui_loaded_data::dprocPURPOSE: extracts tplot variables from active data, performs data processing tasks, creates new variables, optionally sets those variables to active variablesCALLING SEQUENCE: success = loaded_data_obj -> dproc(dp_task, dp_pars,callSequence, names_out=names_out, no_setactive=no_setactive)INPUT: dp_task = a string variable specifying the task to be carried out.

Routine details

top source wv_memory_test

result = wv_memory_test(t, jv)

estimate of memory used by a wavelet transform. The estimated memory use is 36.26*n_elements(transformed_data.y). The factor of 36 comes from testing different transforms for different types of data, for fgm (FGH and FGS) data, 2009-01-14, for ESA L2 density data 2007-07-07, and for GMAG data for both of those days. Note that this is currently only useful for default inputs. 10-jun-2009, jmm, added jv output to test for a reasonable number of wavelets later, jv must be GT 1 for the wavelet2 routine to work.

Parameters

t
jv

top source dproc_status_update

dproc_status_update, msg, sbar, hwin, _extra=_extra

NAME: dproc_status_update PURPOSE: Outputs messages to history window, status bar, or IDL console CALLING SEQUENCE: dproc_status_update, 'There was an error', sbar, hwin dproc_status_update, 'There was an error', hwin dproc_status_update, 'There was an error', sbar INPUT: msg: string or string array containing message sbar: obj reference for status bar hwin: obj reference for history window NOTES: Messages will be printed to the IDL console if the history window reference is missing or invalid. The order in which the history window and status bar refernces are passed in should be irrelevant.

Parameters

msg
sbar
hwin

Keywords

_extra

top source spd_ui_loaded_data::dproc

result = spd_ui_loaded_data::dproc(dp_task, dp_pars, callSequence=callSequence, replay=replay, in_vars=in_vars, names_out=names_out, no_setactive=no_setactive, hwin=hwin, sbar=sbar, gui_id=gui_id, overwrite_selections=overwrite_selections, degap_selections=degap_selections, blkavg_selections=blkavg_selections, smooth_selections=smooth_selections, hpf_selections=hpf_selections, _extra=_extra)

NAME: spd_ui_loaded_data::dproc PURPOSE: extracts tplot variables from active data, performs data processing tasks, creates new variables, optionally sets those variables to active variables CALLING SEQUENCE: success = loaded_data_obj -> dproc(dp_task, dp_pars,callSequence, names_out=names_out, no_setactive=no_setactive) INPUT: dp_task = a string variable specifying the task to be carried out. The options are ['subavg', 'submed', 'smooth', 'blkavg','clip','deflag','degap','spike','deriv', 'pwrspc','wave','hpfilt'] dp_pars = an anonymous structure containing the input parameters for the task, this will be unpacked in this routine and the parameters are passed through. Note that, since this is only called from the thm_GUI_new routine, there is no error checking for content, it is expected that the calling routine passes through the proper parameters in each case. callSequence = Object to store previous dproc operations for replay OUTPUT: success = a byte, 0b if the process was unsuccessful or cancelled, 1b if the process was completed KEYWORDS: names_out = the tplot names of the created data variables no_setactive = if set, the new variables will no be set to active at the end of the process. hwin, sbar = history window and status bar objects for updates gui_id = the id of the calling widget - to pass into warning pop-ups HISTORY: 16-oct-2008, jmm, jimm@ssl.berkeley.edu switched output from message to byte, 29-oct-2008,jmm 12-Dec-2008,prc Fixed bug where dproc was not reading data stored in loaded data,but instead was reading non-gui-data. Fixed bug where data produced by dproc was not inheriting any meta-data. 23-jan-2009, jmm, deletes any tplot variables that are created during processing, added catch, so that deletion of tplot variables is done if an error bonks a process. 10-Feb-2009, jmm, Added hwin, sbar keywords $LastChangedBy: pcruce $ $LastChangedDate: 2014-07-10 14:54:38 -0700 (Thu, 10 Jul 2014) $ $LastChangedRevision: 15552 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_loaded_data__dproc.pro $

Parameters

dp_task
dp_pars

Keywords

callSequence
replay
in_vars
names_out
no_setactive
hwin
sbar
gui_id
overwrite_selections
degap_selections
blkavg_selections
smooth_selections
hpf_selections
_extra

File attributes

Modification date: Tue Oct 21 13:53:42 2014
Lines: 437