This page was created by the IDL library routine mk_html_help2.

Last modified: Tue Apr 28 10:29:18 2009.


Directory Listing of Routines


Routine Descriptions

THM_UI_AXIS_SETTINGS__DEFINE

[Next Routine] [List of Routines]
NAME: 
 thm_ui_axis_settings__define

PURPOSE:  
 axis properties is an object that holds all of the settings necessary for 
 plotting a axis as specified in the Trace Properties Line panel

CALLING SEQUENCE:
 axisSettings = Obj_New("THM_UI_AXIS_SETTINGS")

INPUT:
 none

ATTRIBUTES:
 rangeOption           range options (auto, floating, fixed)
 scaling               axis scaling (linear, log10, natural)
 equalXYScaling        flag set if equal X & Y axis scaled 
 isTimeAxis            flag set if axis is time based
 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
 maxFixedRange         max range value if fixed scaling
 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. mean/median)
 majorTickEvery        display major ticks every 
 minorTickEvery        display major ticks every 
 majorTickUnits        major tick units (sec, hr, min, day, none)
 minorTickUnits        major tick units (sec, hr, min, day, none)
 majorTickAuto         set to automatically figure out major ticks
 minorTickAuto         set to automatically figure out minor ticks
 firstTickAuto         set to automatically figure out first tick
 numMajorTicks         number of major ticks
 numMinorTicks         number of major ticks
 firstTickAt           value where first tick should be
 firstTickUnits        first tick unit (sec, hr, min, day, none)
 tickStyle             style (inside, outside, both)
 bottomPlacement       flag set if ticks should be on bottom axis
 topPlacement          flag set if ticks should be on top axis
 majorLength           length of major tick
 minorLength           length of minor tick
 lineAtZero            flag set if line is drawn at zero
 showdate              flag set if date strings are shown
 dateString1           string format of date for line 1
 dateString2           string format of date for line 1                                         
 dateFormat1           format of date string for annotation - line 1
 dateFormat2           format of date string for annotation - line 2
                       format options include 'Time', 'Date', 'Year', 'Mon', 'Day', 
                       'Hours', 'Minutes', 'Seconds', 'Day of Year'
                       respective commands are '%time', '%date', '%year', '%mon', 
                       '%day', '%hours', '%minutes', '%seconds', '%doy'
 annotateAxis          flag set to annotate along axis                         
 placeAnnotation       placement of annotation (bottom or top)
 annotateMajorTicks    set flag if major ticks are annotated
 annotateEvery         value where annotations occur
 annotateUnits         units for annotation value (sec, min, hr, day,none)
 firstAnnotation       value where annotation of first major tick occurs
 firstAnnotateUnits    units for major tick value (sec, min, hr, day,none)
 annotateFirstTick     set flag to annotate first tick  
 annotateLastTick     set flag to annotate last tick  
 annotateStyle         format style of tick 
                       if IsTime
                       ['date', 'date:doy' , 'date:doy:h:m', 'date:doy:h:m:s', 'date:doy:h:m:s.ms', $
                        'h:m', 'h:m:s', 'h:m:s.ms', 'mo:day', 'mo:day:h:m', 'doy', 'doy:h:m', $
                        'doy:h:m:s', 'doy:h:m:s.ms', 'year:doy', 'year:doy:h:m', 'year:doy:h:m:s', $
                        'year:doy:h:m:s.ms']
                       otherwise
                       ['d(1234)', 'f0(1234)' , 'f1(123.4)', 'f2(12.34)', 'f3(1.234)', 'f4(0.1234)', $
                        'f5(0.01234)', 'f6(0.001234)', 'e0(123e4)', 'e1(12.3e4)', 'e2(1.23e4)', 'e2(0.123e4)', $
                        'e2(0.0123e4)', 'e2(0.00123e4)', 'e2(0.000123e4)']

 annotateOrientation   The orientation of the annotations: 0(horizontal) & 1(vertical)
 annotateTextObject    Text object that represents that textual style of annotations
 annotateExponent      Flag indicates whether to force annotations into an exponential format.  0: default behavior, 1: Always exponential, 2: Never exponential
 majorGrid=majorgrid   linestyle object of major grid 
 minorGrid=minorgrid   linestyle object of minor grid 
 orientation           orientation of labels 0=Horizontal, 1=Vertical
 margin                number of points for label margins
 showLabels            flag for whether or not labels are displayed
 labels                A container object that stores the text objects which represent each label
 stackLabels           A flag to determine whether labels should be stacked 
 blackLabels           A flag to determine whether label colors are all black 
  

OUTPUT:
 axis property object reference

METHODS:
 SetProperty    procedure to set keywords 
 GetProperty    procedure to get keywords 
 GetAll         returns the entire structure

 GetUnits        returns string array of unit options
 GetUnit         returns name of unit given an index
 GetOrientations returns string array of plot options
 GetOrientation  returns name of plot option given an index
 GetPlacements   returns string array of plot options
 GetPlacement    returns name of plot option given an index
 GetRangeOptions returns string array of plot options
 GetRangeOption  returns name of plot option given an index
 GetStyles       returns string array of plot options
 GetStyle        returns name of plot option given an index
 GetScalings     returns string array of plot options
 GetScaling      returns name of plot option given an index
 GetDateFormats  returns string array of date format options
 GetDateFormat   returns the name of the date format given an index
 GetDateCommands returns array of commands for date formats
 GetDateCommand  returns a string with the date command
 GetDateString   returns a string with the actual date formatted
                 given an index. if a time object is provided it
                 will format the time object, otherwise it will
                 default to the current date.

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/templates/thm_ui_axis_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_axis_settings__define.pro)


THM_UI_CALCULATE_SETTINGS__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_calculate_settings__define

PURPOSE:  
  Keeps track of state for calculate panel when closed.

CALLING SEQUENCE:
 calcSettings = Obj_New("THM_UI_CALCULATE_SETTINGS")

INPUT:
 none

ATTRIBUTES:

  path:  string, path to the calculate file
  name: string,name of the calculate file
  text: string array, containing text of the buffer

OUTPUT:
  calculate settings object reference

METHODS:
   
  GetProperty
  SetProperty

HISTORY:

$LastChangedBy: pcruce $
$LastChangedDate: 2008-11-25 10:08:55 -0800 (Tue, 25 Nov 2008) $
$LastChangedRevision: 4057 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/templates/thm_ui_calculate_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_calculate_settings__define.pro)


THM_UI_CONFIGURATION_SETTINGS__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_configuration_settings__define

PURPOSE:  
 generic object for configuration settings

CALLING SEQUENCE:
 configSettings = Obj_New("THM_UI_CONFIGURATION_SETTINGS")

INPUT:
 none

ATTRIBUTES:
localdatadir    name of directory to get local data
remotedatadir   name of directory to get remote data 
downloaddata    download data 0=Automatically, 1=Use local data only
updatefiles     update files 0=if newer, 1=use local only
loaddata        loading data 0=download and load, 1=download only
loadstatedata   load state data 0=automatically, 1=on request only 
verbose         debug settings 0-6, 6 being the most debug messages

OUTPUT:
 configuration settings object reference

METHODS:
 GetProperty
 GetAll
 SetProperty

HISTORY:

$LastChangedBy: cgoethel $
$LastChangedDate: 2008-09-23 09:45:30 -0700 (Tue, 23 Sep 2008) $
$LastChangedRevision: 3546 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/templates/thm_ui_configuration_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_configuration_settings__define.pro)


THM_UI_HIGHLIGHT_SETTINGS__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_highlight_settings__define

PURPOSE:  
 highlight properties is an object that holds all parameters associated with
 theh Trace Properties Highlight panel

CALLING SEQUENCE:
 highlightProperties = Obj_New("THM_UI_HIGHLIGHT_SETTINGS")

INPUT:
 none

KEYWORDS:
 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 ..
 whenEveryEquals  y value to mark
 setBackground     flag to set background
 backgroundWhenY   droplist of logical operators
 backgroundYValue  value for logical operator
 backgroundColor   r,g,b color for background

OUTPUT:
 highlight property object reference

METHODS:
 SetProperty   procedure to set keywords 
 GetProperty   procedure to get keywords 
 GetAll        returns the entire structure
 GetPlacements returns a string array with placement options
 GetPlacement  return a string with placement option of given index
 GetOperators  returns a string array with operator options ['<','<=', ...]
 GetOperator   return a string with placement option of given index

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/templates/thm_ui_highlight_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_highlight_settings__define.pro)


THM_UI_LINE_SETTINGS__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_line_settings__define

PURPOSE:  
 line properties is an object that holds all of the settings necessary for 
 plotting a line as specified in the Trace Properties Line panel

CALLING SEQUENCE:
 lineSettings = Obj_New("THM_UI_LINE_SETTINGS")

INPUT:
 none

KEYWORDS:
 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 debug 

OUTPUT:
 line property object reference

METHODS:
 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 index

HISTORY:

$LastChangedBy: bckerr $
$LastChangedDate: 2009-01-23 10:10:07 -0800 (Fri, 23 Jan 2009) $
$LastChangedRevision: 4605 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/templates/thm_ui_line_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_line_settings__define.pro)


THM_UI_MARKER_SETTINGS__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_marker_settings__define

PURPOSE:  
 Marker Settings object - used for the marker options panel, this object holds the
 settings used for markers

CALLING SEQUENCE:
 marker = Obj_New("THM_UI_MARKER_SETTINGS")

INPUT:
 none

ATTRIBUTES:
label             marker title text object
vertPlacement     vertical placement of marker label 
fillColor         color used to shade marked area
lineStyle         line style object for start/end points
drawOpaque        opacity of the marker(floating pt between 0 & 1])

OUTPUT:
 marker setting 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/templates/thm_ui_marker_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_marker_settings__define.pro)


THM_UI_MARKER_WIZARD__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_marker_wizard__define

PURPOSE:  
 Marker Settings object - used for the marker options panel, this object holds the
 wizard used for markers

CALLING SEQUENCE:
 marker = Obj_New("THM_UI_MARKER_WIZARD")

INPUT:
 none

KEYWORDS:
useVarName     variable name to use to marking data
whenVarName    mark data when this variable equals 
whenRelOp      relative operator to use for marking
whenValue      mark data when variable value is this
highlightColor color to use when shading marked area 
lineStyle      line style object for marker lines
title          title or marker name
minTimeSpan    don’t mark if less than minimum time 

OUTPUT:
 marker setting 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/templates/thm_ui_marker_wizard__define.pro $

(See themis/thm_ui_new/templates/thm_ui_marker_wizard__define.pro)


THM_UI_PAGE_SETTINGS__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_page_settings__define

PURPOSE:  
 Page Settings object - holds the settings for page text, layout and data

CALLING SEQUENCE:
 page = Obj_New("THM_UI_PAGE_SETTINGS")

INPUT:
 none

OUTPUT:
 page setting object reference

ATTRIBUTES:
 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. heights 
 gutterWidth           width size for gutter
 displayOnScreen       flag to display on screen
 altTopBottom          flag to alternate top and bottom
 offsetFirstPage       flag to offset first page
 orientation           0=portrait, 1=landscape
 backgroundColor       name of background color
 leftPrintMargin       size of left print margin (in.)
 rightPrintMargin      size of right print margin (in.)
 topPrintMargin        size of top print margin (in.)
 bottomPrintMargin     size of bottom print margin (in.)
 canvasSize            size of the page in inches
 overlapMajorTicks     flag to overlap major ticks
 showValues            set this flag to show values
 closerThanValue       show data if closer than this
 closerThanUnits       closer units (hr,min,sec,day)
 useSameYRange         flag to use the same y range 
 numMajorTicks         number of major ticks to use
 numMinorTicks         number of minor ticks to use
 skipBlanks            flag to skip blanks

METHODS:
 SetProperty   procedure to set keywords 
 GetProperty   procedure to get keywords 
 GetAll        returns the entire structure
 GetTokenNames returns all the token name options
 GetTokenName  return a token name given an index
 GetUnitNames  returns all closer than unit options
 GetUnitName   returns a unit name given an index
 SetTokenValue places the string value of the token into the text object
 
HISTORY:

$LastChangedBy: pcruce $
$LastChangedDate: 2009-02-24 18:41:42 -0800 (Tue, 24 Feb 2009) $
$LastChangedRevision: 5143 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/templates/thm_ui_page_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_page_settings__define.pro)


THM_UI_PANEL_SETTINGS__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_panel_settings__define

PURPOSE:  
 Panel Settings object - holds the settings for panel traces, layout and grid

CALLING SEQUENCE:
 panelTrace = Obj_New("THM_UI_PANEL_SETTINGS")

INPUT:
 none

OUTPUT:
 panel setting object reference

ATTRIBUTES:
 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         framethickness

METHODS:
 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 unit

HISTORY:

$LastChangedBy: pcruce $
$LastChangedDate: 2009-01-09 15:26:41 -0800 (Fri, 09 Jan 2009) $
$LastChangedRevision: 4396 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_5_00/idl/themis/thm_ui_new/templates/thm_ui_panel_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_panel_settings__define.pro)


THM_UI_SPECTRA_SETTINGS__DEFINE

[Previous Routine] [Next Routine] [List of Routines]
NAME: 
 thm_ui_spectra_settings__define

PURPOSE:  
 spectra properties is an object that holds all of the settings necessary for 
 spectral data plots

CALLING SEQUENCE:
 spectraSettings = Obj_New("THM_UI_SPECTRA_SETTINGS")

INPUT:
 none

KEYWORDS:
 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 plot

OUTPUT:
 spectra property object reference

METHODS:
 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 index

HISTORY:

$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/templates/thm_ui_spectra_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_spectra_settings__define.pro)


THM_UI_ZAXIS_SETTINGS__DEFINE

[Previous Routine] [List of Routines]
NAME: 
 thm_ui_zaxis_settings__define

PURPOSE:  
 zaxis_settings is an object that holds all of the settings necessary for 
 spectral data plots that are common to the entire panel

CALLING SEQUENCE:
 zaxisSettings = Obj_New("THM_UI_ZAXIS_SETTINGS")

INPUT:
 none

KEYWORDS:

 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
 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.  0: default behavior, 1: Always exponential, 2: Never exponential                   
 labelTextObject a text object to indicate the size,color,font,format of the label text
 labelOrientation flag indicating horizontal/vertical text
 labelMargin in number of pts 
 scaling            0=Linear, 1=Log10, 2= Natural Log
 placement          droplist value of placement location
 margin             number of points between plot & zaxis
 showFrequencies    flag to show frequencies
 frequencyMin       minimum value for showing frequencies 
 frequencyMax       maximum value for showing frequencies 

OUTPUT:
 spectra property object reference

METHODS:
 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 index

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/templates/thm_ui_zaxis_settings__define.pro $

(See themis/thm_ui_new/templates/thm_ui_zaxis_settings__define.pro)