Directory: spedas/gui/objects/

Contents

.pro files

spd_qf_list__define.pro

NAME: spd_qf_list__definePURPOSE: Defines an object for quality flag listsCALLING SEQUENCE: qf = Obj_New("spd_qf_list", t_start=t_start, t_end=t_end, qf_bits=qf_bits)INPUT: noneKEYWORDS: t_start t_end qf_bitsOUTPUT: quality flag list object referenceMETHODS: qf_merge(qf) returns an spd_qf_list which is a merge of self with qf qf_time_slice(tstart, tend) returns an spd_qf_list for times between tstart and tend get_qf(t) returns the quality flag for scalar time t qf_print() prints the values of the three arraysNOTES: 1.

spd_ui_axis_settings__define.pro

NAME: spd_ui_axis_settings__definePURPOSE: axis properties is an object that holds all of the settings necessary for plotting a axis as specified in the Trace Properties Line panelCALLING SEQUENCE: axisSettings = Obj_New("SPD_UI_AXIS_SETTINGS")INPUT: noneATTRIBUTES: rangeOption range options (auto, floating, fixed) touchedRangeOption has the user modified the rangeOption field scaling axis scaling (linear, log10, natural) touchedScaling has the user modified the scaling field equalXYScaling flag set if equal X & Y axis scaled isTimeAxis flag set if axis is time based touchedIsTimeAxis has the user modified the isTimeAxis field rangeMargin if auto - range margin boundScaling flag set if auto scaling is bound boundfloating flag set if bounded floating range is used minFixedRange min range value if fixed scaling touchedMinFixedRange has the user modified the minFixedRange maxFixedRange max range value if fixed scaling touchedMaxFixedRange has the user modified the maxFixedRange minFloatRange min range bound if floating range maxFloatRange max range bound if floating range minBoundRange min range bound if using bounded autoscaling maxBoundRange max range bound if using bounded autoscaling floatingSpan value of span if floating floatingCenter floating center options (mean, median, appr.

spd_ui_calculate_settings__define.pro

NAME: spd_ui_calculate_settings__definePURPOSE: Keeps track of state for calculate panel when closed.

spd_ui_call_sequence__define.pro

NAME: spd_ui_call_sequence__definePURPOSE: Stores the sequence of procedure calls that was used to load data.

spd_ui_configuration_settings__define.pro

NAME: spd_ui_configuration_settings__definePURPOSE: generic object for configuration settingsCALLING SEQUENCE: configSettings = Obj_New("SPD_UI_CONFIGURATION_SETTINGS")INPUT: noneATTRIBUTES:localdatadir name of directory to get local dataremotedatadir name of directory to get remote datadownloaddata download data 0=Automatically, 1=Use local data onlyupdatefiles update files 0=if newer, 1=use local onlyloaddata loading data 0=download and load, 1=download onlyloadstatedata load state data 0=automatically, 1=on request onlyverbose debug settings 0-6, 6 being the most debug messagesOUTPUT: configuration settings object referenceMETHODS: GetProperty GetAll SetPropertyNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_coordinate_systems__define.pro

NAME: spd_ui_coordinate_systems PURPOSE: This object exists for two purposes: 1) Maintain the list of coordinate systems used throughout SPEDAS in a single location 2) Encapsulate the methods that produce coordinate system lists for different contexts, e.g., the verify data panel, load data panel, data processing panel, etc.

spd_ui_data__define.pro

NAME: spd_ui_data__definePURPOSE: This is a data object that contains names ids (self, group, and parent)CALLING SEQUENCE: To Create: myDataObj = Obj_New("SPD_UI_DATA") To Use: data = myDataObj->GetData()OUTPUT: reference to a data objectATTRIBUTES: name name of data timeName name of the time component of this data dataPtr ptr to the data component of this data yaxisName name of the yaxis component of this data indepName name of variable to use on indep axis instead of time limitPtr ptr to the limit struct from the tplot variable that it originated dlimitPtr ptr to the dlimit struct from the tplot variable that it originated id unique identifier for this data object groupName group name fileName data file name isTime this boolean indicates whether a data object represents time isSpect flag set when data is spectrographic mission the mission the data is for observatory spacecraft or groundstation of the data coordSys coordinate system of the data, if applicable instrument instrument of the data units the units for this data qunatity yaxisunits the units of the yaxis for this quantity(not important internally, but when we are passing around metadata during a tplot operation, it becomes more important) suffix the suffix of the quantity(if applicable) settings object representing the default data settingsOUTPUT: data objectMETHODS: getName getDataPtr getRange Copy SetProperty GetProperty GetAllNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_data_group__define.pro

NAME: spd_ui_data_groupPurpose: This object represents a group of data objects, as a means of simplifying the logic of the loaded data objectMETHODS: addDataObject: This method takes a dataObject, extracts the name & active flag Then passes those into the add method add: This is the generic add method, takes a name, an object, and an optional active flag remove: This method removes an object with a particular name from the data structure It returns 1 on success and 0 upon failure.

spd_ui_data_range__define.pro

NAME: spd_ui_data_range__definePURPOSE: data range objectCALLING SEQUENCE: dataRange = Obj_New("SPD_UI_DATA_RANGE")INPUT: noneKEYWORDS: startData start data endData end dataOUTPUT: data range object referenceMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetStartData returns the start data (default format is double) GetStopData returns the stop data (default format is double) GetDuration returns duration in secondsNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_data_settings__define.pro

NAME: spd_ui_data_settingsPURPOSE: represents the default plot settings for a trace, and digests the original tplot settingsCALLING SEQUENCE: dsettings = obj_new('spd_ui_data_settings',limit,dlimit,element)HISTORY:NOTES: 1.

spd_ui_document__define.pro

spd_ui_dprint_display__define.pro

NAME: spd_ui_dprint_displayPURPOSE: Object to handle error reporting from ssl_general routines that use dprintCALLING SEQUENCE: spd_ui_display = Obj_New("SPD_UI_DPRINT_DISPLAY")METHODS: GetProperty SetProperty PrintHISTORY:$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/objects/spd_ui_dprint_display__define.pro $

spd_ui_dproc_par__define.pro

NAME: spd_ui_dproc_par__definePURPOSE: generic object to hold a pointer to a structure holding parameters for a data processing task.

spd_ui_fieldmodels_settings__define.pro

NAME: spd_ui_fieldmodels_settings__define PURPOSE: Settings object for the field models panel CALLING SEQUENCE: fieldmodels = obj_new('SPD_UI_FIELDMODELS_SETTINGS') INPUT: none KEYWORDS: pos_tvar: variable containing position data, in km imf_by_tvar: variable containing IMF By data, in nT imf_bz_tvar: variable containing IMF Bz data, in nT sw_density_tvar: variable containing solar wind proton density, in #/cc sw_speed_tvar: variable containing solar wind proton speed, in km/s dst_tvar: variable containing Dst (or Sym-H) data, in nT w_coeff_tvar: variable containing W coefficients for the TS04 model g_coeff_tvar: variable containing G coefficients for the T01 model t89_kp: iopt for the Kp index, for the T89 model t89_set_tilt: user supplied tilt angle for the T89 model t89_add_tilt: user supplied angle to add to the model tilt angle for T89 output_options: models to run - [model at position, equatorial footprint, ionospheric footprint]$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/objects/spd_ui_fieldmodels_settings__define.pro $

spd_ui_getset__define.pro

NAME: spd_ui_getsetPURPOSE: Superclass to automatically provide common gui methods: "GetAll","SetAll","GetProperty","SetProperty"METHODS: GetProperty SetProperty GetAll SetAllHISTORY:NOTES: This object differs from other gui objects with respect to its getProperty,setProperty,getAll,setAll methods.

spd_ui_highlight_settings__define.pro

NAME: spd_ui_highlight_settings__definePURPOSE: highlight properties is an object that holds all parameters associated with theh Trace Properties Highlight panelCALLING SEQUENCE: highlightProperties = Obj_New("SPD_UI_HIGHLIGHT_SETTINGS")INPUT: noneKEYWORDS: markVertical flag to mark vertical lineStyle line style object symbol symbol object placement droplistfor placement of symbol top, bottom, both top and bottom labelWith 0=No label, 1=X value, 2=Y value format numeric format for label markWhenY flag to mark y value whenYEquals y value to mark markEvery flag to mark every y value ..

spd_ui_history__define.pro

NAME:spd_ui_historyPURPOSE: A widget to display the all messages generated during this session$LastChangedBy: aaflores $$LastChangedDate: 2014-05-29 12:47:11 -0700 (Thu, 29 May 2014) $$LastChangedRevision: 15259 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_history__define.pro $+NAME: spd_ui_history__definePURPOSE: This is a history window object used to display textual information for the user (such as a status bar for current states, message bar, or informational bar)CALLING SEQUENCE: To Create: myHistory = Obj_New("SPD_UI_HISTORY") To Use: myHistory->Update, 'This is a test' Or: result = myHistory->GetState()INPUT:KEYWORDS: name: optional name state: set this to one to display value: text to be displayed in the bar xSize: size of bar in x direction ySize: size of bar in y direction debug: set this value to one for debuggingOUTPUT: message bar object referenceMETHODS: Draw creates/displays the bar (automatically called by INIT) Delete removes bar from display (object persists) Update updates bar with new message SetProperty procedure to set keywords GetProperty procedure to get keywords GetState returns the current state of the bar (on/off) (this is a function)HISTORY:$LastChangedBy: aaflores $$LastChangedDate: 2014-05-29 12:47:11 -0700 (Thu, 29 May 2014) $$LastChangedRevision: 15259 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_history__define.pro $

spd_ui_legend__define.pro

spd_ui_line_settings__define.pro

NAME: spd_ui_line_settings__definePURPOSE: line properties is an object that holds all of the settings necessary for plotting a line as specified in the Trace Properties Line panelCALLING SEQUENCE: lineSettings = Obj_New("SPD_UI_LINE_SETTINGS")INPUT: noneKEYWORDS: dataX string naming X component of line dataY string naming Y component of line mirrorLine flag to mirror line lineStyle line style object drawBetweenPts flag set if separation attributes should be used(ie NOT drawBetweenpts) separatedBy number of point separation separatedUnits 0=sec, 1=min, 2=hrs, 3=days symbol symbol object plotPoints, all,1st/Last,1st,Last,MajorTick,EveryN everyOther number for every N points positiveEndPt variable name for positive endPt negativeEndPt variable name for negative endPt positiveEndRel flag if relative to line negativeEndRel flag if relative to line barLine bar line style object MarkSymbol mark symbol object debug=debug set to debugOUTPUT: line property object referenceMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetPlotOptions returns string array of plot options GetPlotOption returns name of plot option given an index GetUnits returns string array of unit options GetUnit returns name of unit given an indexNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_line_style__define.pro

NAME: spd_ui_line_style__definePURPOSE: generic object for IDL line stylesCALLING SEQUENCE: lineStyle = Obj_New("SPD_UI_LINE_STYLE")INPUT: noneKEYWORDS: name name of line style (solid, dotted, dashed, dashdot, dashdotdot,long dashes) id IDL line style value (0-5) show set this to display line (default = 1) color name of the color for this line (default is black) rgb [r, g, b] value for the color for this line thickness thickness of the line (default = 1) opacity the opacity of the lineOUTPUT: line style object referenceMETHODS: GetProperty GetAll SetProperty GetLineStyleName GetLineStyleId GetLineStyle CopyNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_loaded_data__define.pro

NAME: spd_ui_loaded_data__definePURPOSE: This is an array of data objects and represents all the data that has been loaded for this session.

spd_ui_loaded_data__dproc.pro

spd_ui_lock_axes__define.pro

NAME: spd_ui_lock_axes__definePURPOSE: Object just organizes the locking routines.

spd_ui_marker__define.pro

NAME: spd_ui_marker__definePURPOSE: Marker object, displayed whenever user ctrl-click-drags to highlight an areaCALLING SEQUENCE: marker = Obj_New("SPD_UI_MARKER")INPUT: noneKEYWORDS: name name for this marker range start and stop value of marker (data coords) settings property settings of the marker isSelected flag set if marker is currently selected filename filename, if savedOUTPUT: marker object referenceMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structureNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_marker_list__define.pro

spd_ui_marker_settings__define.pro

NAME: spd_ui_marker_settings__definePURPOSE: Marker Settings object - used for the marker options panel, this object holds the settings used for markersCALLING SEQUENCE: marker = Obj_New("SPD_UI_MARKER_SETTINGS")INPUT: noneATTRIBUTES:label marker title text objectvertPlacement vertical placement of marker labelfillColor color used to shade marked arealineStyle line style object for start/end pointsdrawOpaque opacity of the marker(floating pt between 0 & 1])OUTPUT: marker setting object referenceMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structureNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_marker_title__define.pro

NAME: spd_ui_marker_title__definePURPOSE: Marker object, displayed whenever user ctrl-click-drags to highlight an areaCALLING SEQUENCE: markerTitle = Obj_New("SPD_UI_MARKER_TITLE")INPUT: noneKEYWORDS: name name for this marker useDefault flag set if using default name defaultName default name for marker cancelled flag set if window cancelledOUTPUT: marker object referenceMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structureNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_marker_wizard__define.pro

NAME: spd_ui_marker_wizard__definePURPOSE: Marker Settings object - used for the marker options panel, this object holds the wizard used for markersCALLING SEQUENCE: marker = Obj_New("SPD_UI_MARKER_WIZARD")INPUT: noneKEYWORDS:useVarName variable name to use to marking datawhenVarName mark data when this variable equalswhenRelOp relative operator to use for markingwhenValue mark data when variable value is thishighlightColor color to use when shading marked arealineStyle line style object for marker linestitle title or marker nameminTimeSpan don’t mark if less than minimum timeOUTPUT: marker setting object referenceMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structureHISTORY:$LastChangedBy: nikos $$LastChangedDate: 2014-07-07 12:19:43 -0700 (Mon, 07 Jul 2014) $$LastChangedRevision: 15520 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_marker_wizard__define.pro $

spd_ui_message_bar__define.pro

NAME: spd_ui_message_bar__definePURPOSE: This is a text bar object used to display textual information for the user (such as a status bar for current states, message bar, or informational bar)CALLING SEQUENCE: To Create: myStatusBar = Obj_New("SPD_UI_MESSAGE_BAR", myWidgetBase) To Use: myStatusBar->Update, 'This is a test' Or: result = myStatusBar->GetState()INPUT: parent: id for the parent widget (must be a base)KEYWORDS: name: optional name state: set this to one to display value: text to be displayed in the bar xSize: size of bar in x direction ySize: size of bar in y direction debug: set this value to one for debuggingOUTPUT: message bar object referenceMETHODS: Draw creates/displays the bar (automatically called by INIT) Delete removes bar from display (object persists) Update updates bar with new message SetProperty procedure to set keywords GetProperty procedure to get keywords GetState returns the current state of the bar (on/off) (this is a function) WARNINGS: You should avoid calling the update method on this object before the widget is realized.

spd_ui_page_settings__define.pro

NAME: spd_ui_page_settings__definePURPOSE: Page Settings object - holds the settings for page text, layout and dataCALLING SEQUENCE: page = Obj_New("SPD_UI_PAGE_SETTINGS")INPUT: noneOUTPUT: page setting object referenceATTRIBUTES: title text object for title labels text object for labels variables text object for variables footer text object for footer marker text object for markers token droplist index for title token ifootertoken droplist index for footer token defMarkerTitle default value for marker titles maintainRead flag to maintain readability ShowTraceNames flag to display trace names xPanelSpacing horizontal spacing between panel(pts) yPanelSpacing vertical spacing between panel(pts) heightProp flag to maintain prop.

spd_ui_panel__define.pro

NAME: spd_ui_panel__definePURPOSE: generic object for a panelCALLING SEQUENCE: panel = Obj_New("SPD_UI_PANEL")INPUT: noneATTRIBUTES:traceSettings IDL_Container object storing trace settings for each set of data quantities to be plottedwindowID ID for parent window (defaults to -1)name name for this panelid unique identifier for this panelsettings property object for this panelxAxis x axis properties objectyAxis y axis properties objectzAxis z axis properties objecttracking flag set if tracking is onisActive flag set if panel is displayedsyncflag flag set if label and trace colors are syncedvariables idl container of variable objectsshowvariables flag indicates whether variables should be displayed or notmarkers idl container of marker objectsOUTPUT: panel object referenceMETHODS: GetProperty GetAll GetLayoutStructure SetLayoutStructure SetPropertyNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_panel_settings__define.pro

NAME: spd_ui_panel_settings__definePURPOSE: Panel Settings object - holds the settings for panel traces, layout and gridCALLING SEQUENCE: panelTrace = Obj_New("SPD_UI_PANEL_SETTINGS")INPUT: noneOUTPUT: panel setting object referenceATTRIBUTES: panelNames list of panel names titleobj titleobj panel titleMargin the margin between the plot and the title in pts overlay set this flag to overlay title row current row col current column rSpan number of rows to span cSpan number of columns to span bottom flag indicating value was set by user bvalue value of bottom position bunit unit of position value 0=pt, 1=in, 2=cm, 3=mm left flag indicating value was set by user lValue value of left position lUnit unit of position value 0=pt, 1=in, 2=cm, 3=mm width flag indicating value was set by user wValue value of width position wUnit unit of position value 0=pt, 1=in, 2=cm, 3=mm height flag indicating value was set by user hValue value of height position hUnit unit of position value 0=pt, 1=in, 2=cm, 3=mm relVertSize relative size (percentage) backgroundColor background color framecolor frame color framethick framethicknessMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetUnitNames returns a string array of possible unit values GetUnitName returns a string containing the name of the unitNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_prompt_obj__define.pro

Name: spd_ui_prompt_obj Purpose: For encapsulating access to the prompt interface in the SPEDAS GUI Keywords: msg: message to display in the prompt gui_id: id of the parent (GUI) widget historyWin: history window object, for sending text to the history window statusBar: status bar object, for sending text to the status bar Output: reference to the new prompt object Methods: sendtoScreen: creates the prompt Examples: ; create the object gui_prompt_obj = obj_new('SPD_UI_PROMPT_OBJ', historyWin=historyWin, statusBar=statusBar) ; send the prompt to the user user_selection = gui_prompt_obj->sendtoScreen('Are you sure you would like to overwrite this data?', 'Overwrite Data?', gui_id = gui_id) ; check the option selected by the user ...

spd_ui_readwrite__define.pro

NAME: spd_ui_readwrite__definePURPOSE: Base class for object serialize/de-serialize methods.

spd_ui_scroll_bar__define.pro

NAME: spd_ui_scroll_bar__define.proPURPOSE: Object created for data slider widget.

spd_ui_spectra_settings__define.pro

NAME: spd_ui_spectra_settings__definePURPOSE: spectra properties is an object that holds all of the settings necessary for spectral data plotsCALLING SEQUENCE: spectraSettings = Obj_New("SPD_UI_SPECTRA_SETTINGS")INPUT: noneKEYWORDS: dataX string naming the x component of the spectral plot dataY string naming the y component of the spectral plot dataz string naming the z component of the spectral plotOUTPUT: spectra property object referenceMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetPlacements returns string array of placement options GetPlacement returns name of placement option given an index GetColorTables returns string array of color tables GetColorTable returns name of color table given an indexNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_symbol__define.pro

NAME: spd_ui_symbol__definePURPOSE: generic object for IDL symbolsCALLING SEQUENCE: symbol = Obj_New("SPD_UI_SYMBOL")INPUT: noneKEYWORDS: name name of symbol 0 = No symbol 1 = Plus sign, `+' (default) 2 = Asterisk 3 = Period (Dot) 4 = Diamond 5 = Triangle 6 = Square 7 = X 8 = "Greater-than" Arrow Head (>) 9 = "Less-than" Arrow Head (<) id IDL graphics symbol index (0-9) show set this to display symbol (default = 1) color name of the color for this symbol (default is black) rgb [r, g, b] value for the color for this symbol fill set this to fill symbol (default = 0) size size of the symbol (default = 2)OUTPUT: symbol object referenceMETHODS: GetProperty GetAll SetProperty GetSymbolName GetSymbolId GetSymbolsNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_template__define.pro

NAME: spd_ui_templatePURPOSE: Top level object to manage the spedas gui settings template.

spd_ui_text__define.pro

NAME: spd_ui_text__definePURPOSE: generic object for character stringsCALLING SEQUENCE: text = Obj_New("SPD_UI_TEXT")INPUT: noneKEYWORDS:value what's contained in the stringfont font names ('Time New Roman', etc...)format font formats ('bold', 'italic', etc..)color name of color for textsize character sizethickness character thicknessshow flag to display textOUTPUT: text object referenceMETHODS: GetProperty GetAll SetProperty GetFonts GetFont GetFontIndex GetFormats GetFormat GetFormatIndexHISTORY:$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/objects/spd_ui_text__define.pro $

spd_ui_time__define.pro

NAME: spd_ui_time__definePURPOSE: generic time objectCALLING SEQUENCE: To Create: myTimeObj = Obj_New("SPD_UI_TIME") To Use: data = myDataObj->GetAll()INPUT: optional - can provide a time value double, string, or epoch defaults to current time tDouble tString tEpochOUTPUT: data objectMETHODS: UpdateStructure GetStructure GetAll SetProperty GetPropertyHISTORY:$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/objects/spd_ui_time__define.pro $

spd_ui_time_range__define.pro

NAME: spd_ui_time_range__definePURPOSE: time range objectCALLING SEQUENCE: timeRange = Obj_New("SPD_UI_TIME_RANGE")INPUT: noneKEYWORDS: startTime start time endTime end timeOUTPUT: time range object referenceMETHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetStartTime returns the start time (default format is double) GetEndTime returns the stop time (default format is double) GetDuration returns duration in seconds SetStartTime set start time SetEndTime set end timeHISTORY:$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/objects/spd_ui_time_range__define.pro $

spd_ui_variable__define.pro

NAME: spd_ui_variable__definePURPOSE: Variable object, displayed at bottom of windowCALLING SEQUENCE: variable = Obj_New("SPD_UI_VARIABLE")INPUT: noneATTRIBUTES: fieldName name of variable to be displayed controlName name of variable to be used for control text text object for this variable symbol numeric symbols 0=none, 1=degrees, 2=seconds, 3=minutes format numeric formatting style (e.g.

spd_ui_widget_tree__define.pro

NAME: spd_ui_widget_tree__define.proPURPOSE: Object representing the loaded data tree compound widget.

spd_ui_window__define.pro

NAME: spd_ui_window__definePURPOSE: window object, created each time a new window is openedCALLING SEQUENCE: window = Obj_New("SPD_UI_WINDOW")INPUT: noneATTRIBUTES: name name for this window id unique identifier for this window nRows number of rows nCols number of columns isActive flag set if window is displayed panels pointer to panel objects on this window settings A list of settings for this window panelId Current value of panelId tracking flag set if tracking is onOUTPUT: window object referenceMETHODS: GetProperty GetAll SetProperty Copy getMargins repackNOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset.

spd_ui_window_menus__define.pro

Name: SPD_UI_WINDOW_MENUS Purpose: Manages window menu$LastChangedBy: aaflores $$LastChangedDate: 2014-03-20 14:57:30 -0700 (Thu, 20 Mar 2014) $$LastChangedRevision: 14617 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_window_menus__define.pro $

spd_ui_windows__define.pro

NAME: spd_ui_windows__definePURPOSE: This is an array of window objects and represents all the data that has been loaded for this session.

spd_ui_zaxis_settings__define.pro

NAME: spd_ui_zaxis_settings__definePURPOSE: zaxis_settings is an object that holds all of the settings necessary for spectral data plots that are common to the entire panelCALLING SEQUENCE: zaxisSettings = Obj_New("SPD_UI_ZAXIS_SETTINGS")INPUT: noneKEYWORDS: xAxisIndex flag to index x axis yAxisIndex flag to index y axis colorTable droplist value of color tables minRange minimum range value maxRange maximum range value fixed flag to use fixed min/max values tickNum the number of z-axis ticks minorTickNum the number of minor ticks between majors logMinorTickType full-interval,first-magnitude,last-magnitude,even-spacing annotationStyle droplist value for annotation style annotateTextObject a text object to indicate the size,color,font,format of the annotation text annotationOrientation flag indicating horizontal or vertical annotations 0=horizontal, 1=vertical annotateExponent Flag indicates whether to force annotations into an exponential format.