This page was created by the IDL library routine
mk_html_help2
.
Last modified: Tue Apr 28 10:29:18 2009.
NAME: thm_ui_call_sequence__define PURPOSE: Stores the sequence of procedure calls that was used to load data. CALLING SEQUENCE: obj = obj_new('thm_ui_call_sequence',loadeddata) Methods: addloadcall: This method should be called in load themis data, every time 'thm_ui_new_load_data2obj' is called getCalls: This method returns the list of stored function calls as an array of pointers to structs setCalls: This method stores an array of pointers to structs that represent function/procedure calls reCall: This method will re-execute the sequence of stored function calls merge: This method will combine two call sequence objects. It attempts to guarantee that the correct data quantities are generated, while preventing duplication of effort. getDomElement: serializes this class into an XML Dom object BuildFromDomElement: deserializes this class from an XML Dom Object NOTE: 1. This object is designed in such a way that it should be straightforward to ingest calls from other types of routines. For example: calls to delete data or calls to load data from non-themis sources. The public interface is set up in such a way that it should ease these types of extensions in the future. 2. Right now, it cannot guarantee that *all* the data that was saved will be present when reCalled, because it does not keep track of custom tplot variables, or data processing calls. HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2009-02-12 14:43:36 -0800 (Thu, 12 Feb 2009) $ $LastChangedRevision: 4990 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_call_sequence__define.pro $
(See themis/thm_ui_new/objects/thm_ui_call_sequence__define.pro)
NAME: thm_ui_data_group Purpose: This object represents a group of data objects, as a means of simplifying the logic of the loaded data object METHODS: 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. Optional keyword nodelete, stops data from being deleted when data Object removed. removeall: this method removes all objects from the group. It returns 1 on success and 0 upon failure. Optional keyword nodelete, stops data from being deleted when data Object removed. hasChild: this method determines if the group has a child with a particular name returns 1 for yes and 0 for no hasActive: this method returns 1 if the group has an active object with a particular name and 0 otherwise setActive: this method sets an object with a particular name to active If the name provided is the groupname, the whole group will become active clearActive: this method will deactivate the object with the provided name If the name provided is the groupname, the whole group will become inactive clearAllActive: this method will deactive the group and all its members getActiveChildren: this method returns the names of all active members or 0 if there are no active members(or no members at all) getChildren: this method returns the names of all members getTimeObject: this method returns the timeobject in the group getDataObjects: this method returns the dataobjects in the group getObject: this method returns an object with a particular name or 0 if it is not stored in this object getObjects: this method returns all objects stored in the group or 0 if it contains no objects getActive: this method returns the active flag for the group getName: this method returns the group name setName: this method sets the group name getDataNames: returns the names of children BUT time setTimeName: set the name of the time object in this group getTimeName: get the name of the time object in this group setYaxisName: set the name of the yaxis group for this group getYaxisName: get the name of the yaxis group for this group getSize: this method returns the number of objects stored in the group getTimeRange: this method returns the start and stop time strings the time object of this group init: has two optional keywords. name,active NOTES: As the data_group object is part of loaded data and data management, destroying this object or removing from this object will result in the contained objects being destroyed and their memory being freed $LastChangedBy: pcruce $ $LastChangedDate: 2009-01-08 14:12:55 -0800 (Thu, 08 Jan 2009) $ $LastChangedRevision: 4365 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_data_group__define.pro $
(See themis/thm_ui_new/objects/thm_ui_data_group__define.pro)
NAME: thm_ui_data_range__define PURPOSE: data range object CALLING SEQUENCE: dataRange = Obj_New("THM_UI_DATA_RANGE") INPUT: none KEYWORDS: startData start data endData end data OUTPUT: data range object reference METHODS: 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 seconds HISTORY: $LastChangedBy: cgoethel $ $LastChangedDate: 2008-10-21 12:57:40 -0700 (Tue, 21 Oct 2008) $ $LastChangedRevision: 3772 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_data_range__define.pro $
(See themis/thm_ui_new/objects/thm_ui_data_range__define.pro)
NAME: thm_ui_data__define PURPOSE: This is a data object that contains names ids (self, group, and parent) CALLING SEQUENCE: To Create: myDataObj = Obj_New("THM_UI_DATA") To Use: data = myDataObj->GetData() OUTPUT: reference to a data object ATTRIBUTES: 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 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) OUTPUT: data object METHODS: getName getDataPtr getRange Copy SetProperty GetProperty GetAll HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2009-01-22 12:41:33 -0800 (Thu, 22 Jan 2009) $ $LastChangedRevision: 4591 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_data__define.pro $
(See themis/thm_ui_new/objects/thm_ui_data__define.pro)
NAME: thm_ui_dproc_par__define PURPOSE: generic object to hold a pointer to a structure holding parameters for a data processing task. CALLING SEQUENCE: axis = Obj_New('thm_ui_dproc_par', dp_struct=dp_struct, dp_string=dp_string) INPUT: none KEYWORDS: dp_struct = 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. dp_string = a string variable that describes the process, e.g., 'smooth' for smoothing OUTPUT: dp_struct object reference METHODS: init: initializes object cleanup: cleans up object SetProperty procedure to set keywords GetProperty procedure to get keywords HISTORY: 21-oct-2008, jmm, jimm@ssl.berkeley.edu $LastChangedBy: jimm $ $LastChangedDate: 2008-10-23 16:57:35 -0700 (Thu, 23 Oct 2008) $ $LastChangedRevision: 3795 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_dproc_par__define.pro $
(See themis/thm_ui_new/objects/thm_ui_dproc_par__define.pro)
NAME: thm_ui_history PURPOSE: A widget to display the all messages generated during this session $LastChangedBy: pcruce $ $LastChangedDate: 2009-03-02 12:51:33 -0800 (Mon, 02 Mar 2009) $ $LastChangedRevision: 5194 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_history__define.pro $ + NAME: thm_ui_history__define PURPOSE: 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("THM_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 debugging OUTPUT: message bar object reference METHODS: 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: pcruce $ $LastChangedDate: 2009-03-02 12:51:33 -0800 (Mon, 02 Mar 2009) $ $LastChangedRevision: 5194 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_history__define.pro $
(See themis/thm_ui_new/objects/thm_ui_history__define.pro)
NAME: thm_ui_line_style__define PURPOSE: generic object for IDL line styles CALLING SEQUENCE: lineStyle = Obj_New("THM_UI_LINE_STYLE") INPUT: none KEYWORDS: 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 line OUTPUT: line style object reference METHODS: GetProperty GetAll SetProperty GetLineStyleName GetLineStyleId GetLineStyle Copy HISTORY: $LastChangedBy: mfeuerstein $ $LastChangedDate: 2009-02-03 12:10:09 -0800 (Tue, 03 Feb 2009) $ $LastChangedRevision: 4749 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_line_style__define.pro $
(See themis/thm_ui_new/objects/thm_ui_line_style__define.pro)
NAME: thm_ui_loaded_data__define PURPOSE: This is an array of data objects and represents all the data that has been loaded for this session. CALLING SEQUENCE: OUTPUT: reference to data object array ATTRIBUTES: array of data objects METHODS: Add adds a new tplot variable to the loaded data object by tplot variable name AddTvarObject An add routine replaces an object that was returned by getTvarObject in this data structure Remove removes an object from the array by name or group name GetAll returns an array of all data names GetActive returns a list of all data that is currently displayed GetChildren returns a list of the children for a particular variable name SetActive makes a data object active given a tplot name IsActive Checks if a variable with a given name is active IsParent Checks if a variable with a given name is a parent IsChild Checks if a variable with a given name is a child ClearActive makes a data object inactive ClearAllActive clears all active data objects GetVarData gets the data component from a variable. For a group variable, the routine will need to compose the data first GetTvarData gets a tplot variable, For a group data structure it will construct a new tplot variable. GetTvarObject gets object with an assembled data component from getTvarData, but with the appropriate associated meta data GetObjects returns an array of all data objects, can also take a name or group name NOTE: 1. You should use 'getTvarData' or 'getTvarObject' to generate a tplot variable that has all the dimensions of the variable composed as a single entity. After you have modified the variable you should you 'add', to add the data back in to the data structure. 2. Note also, that you don't need to have separate rules to data process parents and children, if you use the same getTvarData/add workflow above for children variables, it will work fine. 3. INIT takes an argument, /autoload. If that is set, the load routine will load all the tplot variables in memory, but not all the metadata for the variables will be set correctly. HISTORY: $LastChangedBy: aaflores $ $LastChangedDate: 2009-04-21 11:40:12 -0700 (Tue, 21 Apr 2009) $ $LastChangedRevision: 5705 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_loaded_data__define.pro $
(See themis/thm_ui_new/objects/thm_ui_loaded_data__define.pro)
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.
(See themis/thm_ui_new/objects/thm_ui_loaded_data__dproc.pro)
NAME: thm_ui_lock_axes__define PURPOSE: Object just organizes the locking routines. It is more a way or co-locating some related methods, than a data structure Note that these methods are not guaranteed to work in the event that a panel spans multiple columns, yet other panels in its column do not. CALLING SEQUENCE: obj = obj_new('thm_ui_lock_axes',window_storage,draw_object) Methods: HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2009-02-19 16:28:08 -0800 (Thu, 19 Feb 2009) $ $LastChangedRevision: 5068 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_lock_axes__define.pro $
(See themis/thm_ui_new/objects/thm_ui_lock_axes__define.pro)
NAME: thm_ui_marker_title__define PURPOSE: Marker object, displayed whenever user ctrl-click-drags to highlight an area CALLING SEQUENCE: markerTitle = Obj_New("THM_UI_MARKER_TITLE") INPUT: none KEYWORDS: name name for this marker useDefault flag set if using default name defaultName default name for marker cancelled flag set if window cancelled doNotAsk flag set if user doesn't want to be asked each time OUTPUT: marker object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure HISTORY: $LastChangedBy: cgoethel $ $LastChangedDate: 2008-12-16 12:24:35 -0800 (Tue, 16 Dec 2008) $ $LastChangedRevision: 4212 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_marker_title__define.pro $
(See themis/thm_ui_new/objects/thm_ui_marker_title__define.pro)
NAME: thm_ui_marker__define PURPOSE: Marker object, displayed whenever user ctrl-click-drags to highlight an area CALLING SEQUENCE: marker = Obj_New("THM_UI_MARKER") INPUT: none KEYWORDS: 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 saved OUTPUT: marker object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2008-12-17 14:25:17 -0800 (Wed, 17 Dec 2008) $ $LastChangedRevision: 4233 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_marker__define.pro $
(See themis/thm_ui_new/objects/thm_ui_marker__define.pro)
NAME: thm_ui_message_bar__define PURPOSE: 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("THM_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 debugging OUTPUT: message bar object reference METHODS: 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: pcruce $ $LastChangedDate: 2008-11-05 13:25:13 -0800 (Wed, 05 Nov 2008) $ $LastChangedRevision: 3926 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_message_bar__define.pro $
(See themis/thm_ui_new/objects/thm_ui_message_bar__define.pro)
NAME: thm_ui_panel__define PURPOSE: generic object for a panel CALLING SEQUENCE: panel = Obj_New("THM_UI_PANEL") INPUT: none ATTRIBUTES: traceSettings IDL_Container object storing trace settings for each set of data quantities to be plotted windowID ID for parent window (defaults to -1) name name for this panel id unique identifier for this panel settings property object for this panel xAxis x axis properties object yAxis y axis properties object zAxis z axis properties object tracking flag set if tracking is on isActive flag set if panel is displayed syncflag flag set if label and trace colors are synced variables idl container of variable objects showvariables flag indicates whether variables should be displayed or not markers idl container of marker objects OUTPUT: panel object reference METHODS: GetProperty GetAll GetLayoutStructure SetLayoutStructure SetProperty HISTORY: $LastChangedBy: aaflores $ $LastChangedDate: 2009-03-11 15:28:37 -0700 (Wed, 11 Mar 2009) $ $LastChangedRevision: 5258 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_panel__define.pro $
(See themis/thm_ui_new/objects/thm_ui_panel__define.pro)
NAME: thm_ui_readwrite__define PURPOSE: Base class for object serialize/de-serialize methods. This class has no data members and should not be instantiated, only inherited from. It uses IDL's rudimentary reflection capabilities to figure out which fields need to be read/written, and what their types are. INPUT: none KEYWORDS: none OUTPUT: none METHODS: read Read an object from a file write Write an object to a file test Write an object, read it back into a new object, write new object HISTORY: $LastChangedBy: jwl $ $LastChangedDate: 2008-12-19 17:05:24 -0800 (Fri, 19 Dec 2008) $ $LastChangedRevision: 4271 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_readwrite__define.pro $
(See themis/thm_ui_new/objects/thm_ui_readwrite__define.pro)
NAME: thm_ui_symbol__define PURPOSE: generic object for IDL symbols CALLING SEQUENCE: symbol = Obj_New("THM_UI_SYMBOL") INPUT: none KEYWORDS: 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 psym value for symbol (0-5) 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 reference METHODS: GetProperty GetAll SetProperty GetSymbolName GetSymbolId GetSymbols HISTORY: $LastChangedBy: cgoethel_new $ $LastChangedDate: 2009-02-19 10:16:25 -0800 (Thu, 19 Feb 2009) $ $LastChangedRevision: 5047 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_symbol__define.pro $
(See themis/thm_ui_new/objects/thm_ui_symbol__define.pro)
NAME: thm_ui_text__define PURPOSE: generic object for character strings CALLING SEQUENCE: text = Obj_New("THM_UI_TEXT") INPUT: none KEYWORDS: value what's contained in the string font font names ('Time New Roman', etc...) format font formats ('bold', 'italic', etc..) color name of color for text size character size thickness character thickness show flag to display text OUTPUT: text object reference METHODS: GetProperty GetAll SetProperty GetFonts GetFont GetFontIndex GetFormats GetFormat GetFormatIndex HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2009-04-02 17:57:49 -0700 (Thu, 02 Apr 2009) $ $LastChangedRevision: 5532 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_text__define.pro $
(See themis/thm_ui_new/objects/thm_ui_text__define.pro)
NAME: thm_ui_time_range__define PURPOSE: time range object CALLING SEQUENCE: timeRange = Obj_New("THM_UI_TIME_RANGE") INPUT: none KEYWORDS: startTime start time endTime end time OUTPUT: time range object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetStartTime returns the start time (default format is double) GetStopTime returns the stop time (default format is double) GetDuration returns duration in seconds SetStartTime set start time SetEndTime set end time HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2008-12-17 14:25:17 -0800 (Wed, 17 Dec 2008) $ $LastChangedRevision: 4233 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_time_range__define.pro $
(See themis/thm_ui_new/objects/thm_ui_time_range__define.pro)
NAME: thm_ui_time__define PURPOSE: generic time object CALLING SEQUENCE: To Create: myTimeObj = Obj_New("THM_UI_TIME") To Use: data = myDataObj->GetAll() INPUT: optional - can provide a time value double, string, or epoch defaults to current time tDouble tString tEpoch OUTPUT: data object METHODS: UpdateStructure GetStructure GetAll SetProperty GetProperty HISTORY: $LastChangedBy: cgoethel $ $LastChangedDate: 2008-10-21 12:57:40 -0700 (Tue, 21 Oct 2008) $ $LastChangedRevision: 3772 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_time__define.pro $
(See themis/thm_ui_new/objects/thm_ui_time__define.pro)
NAME: thm_ui_variable__define PURPOSE: Variable object, displayed at bottom of window CALLING SEQUENCE: variable = Obj_New("THM_UI_VARIABLE") INPUT: none ATTRIBUTES: 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. 12.34, 1.23e4) minRange the minimum range for the variable maxRange the maximum range for the variable scaling the type of scaling used with the variable 0:Linear,1 Log10, 2:LogN useRange 0 = auto,1= user defined,2 = xrange from panel OUTPUT: variable object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetSymbols returns array symbol names GetSymbol returns a symbol name given an index Copy clone the object HISTORY: $LastChangedBy: aaflores $ $LastChangedDate: 2009-04-15 09:27:30 -0700 (Wed, 15 Apr 2009) $ $LastChangedRevision: 5623 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_variable__define.pro $
(See themis/thm_ui_new/objects/thm_ui_variable__define.pro)
NAME: thm_ui_widget_tree__define.pro PURPOSE: Object representing the loaded data tree compound widget. CALLING SEQUENCE: wt = obj_new('thm_ui_widget_tree',parentid,uvalue,loadedData,xsize=200,ysize=200,mode=1) Examples: 1. widget_control,event.id,get_value=val print, val->getvalue() 2. obj = obj_new('thm_ui_widget_tree,tlb,'TREE',loadedData,uname='TREE_NAME') id = widget_info(find_by_uname='TREE_NAME') widget_control,id,get_value=val print,val->getvalue() val->setProperty,multi=0 Attributes: uvalue: the user value that will be returned by event handler uname: the user name that can be used to identify the widget xsize: the x axis length of the tree viewing area(scrollbars will be added automatically) ysize: the y axis length of the tree viewing area(scrollbars will be added automatically) mode: the visualization/selection mode(see NOTES below) multi: whether multiple selections with ctrl/shift click are allowed leafonly: 1: indicates selection may be only made at the lowest level of the tree 0: indicates selections may be done at any point in the tree NOTES: There are 4-different selection modes for this widget. Each selection mode will be appropriate for different panels. Mode 0: tplot-layout selection, data-processing selection, loaded-data-selection Mode 1 : variable-selection, x-layout selection, y-lineplot-layout selection line-trace selection. save-data-as Mode 2 : y-spectra-layout selection z-spectra-layout selection (possibly data-processing) Mode 3 : Calculate Panel Possibly future versions of data analysis Mode Descriptions Mode 0 is a tplot-like selection. It provides access to only the groupname and doesn't let the user drill down into internal quantities. When values are returned from mode 0, an array of pointers to structs that store that names of the contained variables will be returned. (or 0 on fail) Mode 1 is a 1-D component selection. It allows the user to look at and select internal 1-d quantities, When values are returned from mode 1, an array of strings will be returned. (or 0 on fail) Mode 2 is a 2-D component selection. It allows the user to look at and select any 2-d quantities. In mode 2 yaxis-values will not be grouped inside their containing group, instead they will be grouped side-by-side with their containing group. Values returned from mode 2 will be an array of strings of groupnames. (or 0 on fail) Mode 3 allows selection of either group quantities('tha_state_pos') or components('tha_state_pos_x'), but does not allow branch selection. (ie Cannot grab themis and get all quantities.) Public Methods: update: Call this routine after loaded data has been changed by some other process getProperty: Use this to get the current widget_tree settings setProperty: Use this to change the current widget_tree settings getValue(): Use this to return a list of the current selections. The other methods should NOT be called by external code. Making code that uses them will make this code very difficult to maintain. So if you need a feature, just request that it be added instead. HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2009-04-02 09:37:05 -0700 (Thu, 02 Apr 2009) $ $LastChangedRevision: 5517 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_widget_tree__define.pro $
(See themis/thm_ui_new/objects/thm_ui_widget_tree__define.pro)
NAME: thm_ui_windows__define PURPOSE: This is an array of window objects and represents all the data that has been loaded for this session. CALLING SEQUENCE: OUTPUT: reference to window object array ATTRIBUTES: array of window objects METHODS: SetProperty GetProperty Add creates a new window object and adds it to the array GetActive returns active window object SetActive makes a window object active given a windowID GetSelected returns the selected window object SetSelected makes a window object selected NOTE: These 3 methods do not appear to exist GetDefaultTitle returns a title, if the user has provided a default one AskForTitle return 1=if user wants to be asked each time, 0=don't ask, use default ClearActive resets active windows to inactive (must provide a window ID) ClearAll clears either selected or active windows (must use a keyword) AddObject adds a new object to the array (method for internal use) RemoveObject removes an object from the array (routine for internal use) GetObjects returns an array of all data objects, can also take a name or group name (method for internal use) NOTE: Markers can be active and/or selected. ACTIVE: If a window is 'active' then it is currently displayed on a window. If the window is no longer active, then the window is no longer active and must be deactivated. To make a window inactive the user must provide a windowID. SELECTED: If a window is 'selected' then it is either a new window (which automatically by default, becomes the selected window) or the user has clicked on a specific window to select it. There can only be one 'selected' window at a time. HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2009-03-20 10:11:40 -0700 (Fri, 20 Mar 2009) $ $LastChangedRevision: 5338 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_windows__define.pro $
(See themis/thm_ui_new/objects/thm_ui_windows__define.pro)
NAME: thm_ui_window__define PURPOSE: window object, created each time a new window is opened CALLING SEQUENCE: window = Obj_New("THM_UI_WINDOW") INPUT: none ATTRIBUTES: 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 on OUTPUT: window object reference METHODS: GetProperty GetAll SetProperty Copy getMargins repack HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2009-04-16 09:33:14 -0700 (Thu, 16 Apr 2009) $ $LastChangedRevision: 5661 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/objects/thm_ui_window__define.pro $
(See themis/thm_ui_new/objects/thm_ui_window__define.pro)