This page was created by the IDL library routine
mk_html_help2.
Last modified: Tue May 7 11:36:21 2013.
NAME:
thm_ui_clean_spikes_options
PURPOSE:
Front end interface allowing the user to select options for cleaning spikes from data.
CALLING SEQUENCE:
return_values = thm_ui_clean_spikes_options(gui_id, statusbar, historywindow)
INPUT:
gui_id: widget id of group leader
statusbar: status bar object ref.
historywindow: history window object ref.
OUTPUT:
return values: anonymous structure containing input parameters for dproc routine
{
thresh: Threshold for determining spikes (see clean_spikes.pro)
swidth: Width of smoothing window, see IDL documentation on smooth() for more info
suffix: Suffix for new variable
ok: Flag indicating success
}
NOTES:
(See themis/thm_ui_new/panels/dproc/thm_ui_clean_spikes_options.pro)
NAME:
thm_ui_clip_data_options
PURPOSE:
Front end interface allowing the user to select options for clipping data.
CALLING SEQUENCE:
return_values = thm_ui_clip_data_options(gui_id, statusbar, historywindow)
INPUT:
gui_id: widget id of group leader
statusbar: status bar object ref.
historywindow: history window object ref.
OUTPUT:
return values: anonymous structure containing input parameters for dproc routine
{
maxc: maximum value for clipping
minc: minimum value for clipping
opts: Array of flags determining extra options
[clip adjacent points, insert user-specified flag (instead of NaNs)]
flag: user-specified flag, a double to be insterted where values are clipped
suffix: Suffix for new variable
ok: Flag indicating success
}
NOTES:
(See themis/thm_ui_new/panels/dproc/thm_ui_clip_data_options.pro)
NAME:
thm_ui_interpol_options
PURPOSE:
Front end window allowing user to select options for interpolation.
CALLING SEQUENCE:
result = thm_ui_interpol_options, gui_ID, historywin, statusbar, datap
INPUT:
gui_id: group leader widget
historywin: history window object
statusbar: status bar object
datap: pointer to loaded data object
ptree: pointer to tree copy
OUTPUT:
values = {num, type, matchto, extrap, suffix, ok}
num: number of points passed to interpol function
type: type on interpolation (0=linear, 1=quad, 2=lst sqr qd, 3=spline, 4= nearest neighbor)
matchto: pointer to copy of returned struct from loaded data obj,
specifies the selected quantity to match, null string if
none selected
extrap: type of extrapolation for matching (0=none, 1=nan)
suffix: optional suffix for new data quantity
ok: flag indicating whether to procede with interpolation
NOTES:
(See themis/thm_ui_new/panels/dproc/thm_ui_interpol_options.pro)
NAME:
thm_ui_join_variables_options
PURPOSE:
Front end interface allowing the user to select options for joining separate variables.
CALLING SEQUENCE:
return_values = thm_ui_join_variables_options(gui_id, statusbar, historywindow)
INPUT:
gui_id: widget id of group leader
statusbar: status bar object ref.
historywindow: history window object ref.
OUTPUT:
return values: anonymous structure containing input parameters for dproc routine
{
new_name: new_name for new variable
ok: Flag indicating success
}
NOTES:
(See themis/thm_ui_new/panels/dproc/thm_ui_join_variables_options.pro)
NAME:
thm_ui_pwrspc_options
PURPOSE:
A widget used to set keyword options for creating power spectra. This
widget returns an anonymous structure of keyword settings that is passed
through the OPTIONS positional parameter of THM_UI_NEW_PWRSPC. Intended to
be called from THM_UI_NEW_DPROC.
CALLING SEQUENCE:
opt_struct = thm_ui_pwrspc_options(gui_id, trObj, historyWin, statusBar)
INPUT:
gui_id: The GUI id that should be the top level id of the Data Processing
window.
trObj: The timerange object that is created in THM_GUI_NEW.
historyWin: The history window object.
statusBar: The status bar object for the Data Processing window.
KEYWORDS:
none
OUTPUT:
opt_struct: The anonymous structure contain options and keyword settings for
THM_UI_NEW_PWRSPC.
(See themis/thm_ui_new/panels/dproc/thm_ui_pwrspc_options.pro)
NAME:
thm_ui_smooth_data_options
PURPOSE:
Front end interface allowing the user to select high pass filter options.
CALLING SEQUENCE:
return_values = thm_ui_high_pass_options(gui_id, statusbar, historywindow)
INPUT:
gui_id: widget id of group leader
statusbar: status bar object ref.
historywindow: history window object ref.
OUTPUT:
return values: anonymous structure containing input parameters for dproc routine
{
dt: Time Resolution for smoothing
icad: Interpolation cadence (not used by default)
setICad: Flag to use interpolation cadence
suffix: Suffix for new variable
ok: Flag indicating success
}
NOTES:
Options for the high pass filter are only used by smooth_in_time.pro to get
the running average for calculation. Since the call to smooth_in_time
contains specific keywords some smoothing options are not available.
(See themis/thm_ui_new/panels/dproc/thm_ui_high_pass_options.pro)
NAME:
thm_ui_smooth_data_options
PURPOSE:
Front end interface allowing the user to select options for smoothing data.
CALLING SEQUENCE:
return_values = thm_ui_smooth_data_options(gui_id, statusbar, historywindow)
INPUT:
gui_id: widget id of group leader
statusbar: status bar object ref.
historywindow: history window object ref.
OUTPUT:
return values: anonymous structure containing input parameters for dproc routine
{
dt: Time Resolution for smoothing
icad: Interpolation cadence (not used by default)
setICad: Flag to use interpolation cadence
dttype: Array of flags determining how smoothing is applied [default,forward,backward]
opts: Array of flags determining extra options [no_time_intrp,true_t_integtration,smooth_nans]
suffix: Suffix for new variable
ok: Flag indicating success
}
NOTES:
(See themis/thm_ui_new/panels/dproc/thm_ui_smooth_data_options.pro)
NAME:
thm_ui_time_derivative_options
PURPOSE:
Front end interface allowing the user to select options for performing time derivatives on data.
CALLING SEQUENCE:
return_values = thm_ui_time_derivative_options(gui_id, statusbar, historywindow)
INPUT:
gui_id: widget id of group leader
statusbar: status bar object ref.
historywindow: history window object ref.
OUTPUT:
return values: anonymous structure containing input parameters for dproc routine
{
swidth: Width of smoothing window, see IDL documentation on smooth() for more info
setswidth: Flag indicating whether data is to be smoothed
suffix: Suffix for new variable
ok: Flag indicating success
}
NOTES:
(See themis/thm_ui_new/panels/dproc/thm_ui_time_derivative_options.pro)