Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: spedas/gui/display/draw_object/

Contents

.pro files

spd_ui_draw_object__addaxislabels.pro
spd_ui_draw_object__addaxistitle.pro
spd_ui_draw_object__addbackground.pro
spd_ui_draw_object__adddatestring.pro
spd_ui_draw_object__addlegend.pro
spd_ui_draw_object__addmarker.pro
spd_ui_draw_object__addvariables.pro
spd_ui_draw_object__aggregatespecplots.pro

spd_ui_draw_object method: aggregateSpecplotsA special kluge function to get around an IDL bug, that causes improper layering in epsGenerates a composite image from a series of spectral plots to preserve layering when exporting to epsInputs: spec_list(Object Ref): an IDL_Container with each spec_plot model panel_sz_pt(2 element numerical): The number of points to be used for the x and y dimensions of the output, respectively bg_color(3 element byte array): The background color for the panel, used to properly simulate transparencyOutputs: aggregated model$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/display/draw_object/spd_ui_draw_object__aggregatespecplots.pro $

spd_ui_draw_object__collatedata.pro

spd_ui_draw_object method: collateDatagets data from loadedData, collects into arrays and performs basic preprocessing.

spd_ui_draw_object__convertcolor.pro

spd_ui_draw_object method: convertColorthis routine converts between True color and indexed colordepending upon which color mode is set by the windowif keyword: backwards is set, the routine will return a 1x3 array,Which may be useful in some applications.

spd_ui_draw_object__createinstance.pro

spd_ui_draw_object method: createInstanceThis routine creates an instance of the static componentsof any display, it also leaves only the dynamic componentsunhidden after it is complete, so the draw object is readyfor instance based drawingSee IDL Help documentation on instances.

spd_ui_draw_object__draw.pro
spd_ui_draw_object__drawmarker.pro
spd_ui_draw_object__getclick.pro
spd_ui_draw_object__getdim.pro
spd_ui_draw_object__getlineplot.pro
spd_ui_draw_object__getmarkers.pro

spd_ui_draw_object method: GetMarkersReturns the marker or list of markers that were createdby the most recent markeron/markeroff callif no markers available, returns 0Output: an array of structs of the form{idx:0,marker:obj_new('spd_ui_marker')}idx is index of the panel the marker is on, this is the index into the list of panels in the IDL_Container on the window, not the ID field of the panelthe object is the marker, with correct default settings and range$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/display/draw_object/spd_ui_draw_object__getmarkers.pro $

spd_ui_draw_object__getpanelinfo.pro
spd_ui_draw_object__getpanellayouts.pro
spd_ui_draw_object__getpanelnumber.pro
spd_ui_draw_object__getpanelsize.pro
spd_ui_draw_object__getpaneltitlesize.pro
spd_ui_draw_object__getplotsize.pro
spd_ui_draw_object__getproperty.pro
spd_ui_draw_object__getrange.pro

spd_ui_draw_object method: getRangeCalculates the range of a sequence.

spd_ui_draw_object__getrowtextsizes.pro
spd_ui_draw_object__getrubberbandpos.pro
spd_ui_draw_object__getspecmodel.pro
spd_ui_draw_object__getspecref.pro

spd_ui_draw_object method: getSpecRefGenerates a gridded and fully clipped spectragram during the update function.

spd_ui_draw_object__gettextmodel.pro

spd_ui_draw_object method: getTextModelreturns a text model by digesting the settings on a spd_ui_text object.

spd_ui_draw_object__gettextobject.pro
spd_ui_draw_object__getvariablesize.pro

spd_ui_draw_object method: getVariablesSizeCalculates the maximum space that will be occupied, by any panel's x-axesName is because it used to only account for variablesInputs: panels(array of objects): List of spd_ui_panelsNOTES: consider returning an array of panel sizes and performing the max after the fact$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/display/draw_object/spd_ui_draw_object__getvariablesize.pro $

spd_ui_draw_object__getzoom.pro
spd_ui_draw_object__getzrange.pro
spd_ui_draw_object__goodticks.pro
spd_ui_draw_object__hbaroff.pro

spd_ui_draw_object method: hBarOffstop drawing the horizontal bar$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/display/draw_object/spd_ui_draw_object__hbaroff.pro $

spd_ui_draw_object__hbaron.pro

spd_ui_draw_object method: hBarOnstart drawing the horizontal bar all(boolean keyword): Set to turn on for all panels.

spd_ui_draw_object__huerotation.pro

spd_ui_draw_object method: hueRotationThis rotates the hue of of the input color by 120 degreesThe output is the rotated color$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/display/draw_object/spd_ui_draw_object__huerotation.pro $

spd_ui_draw_object__inbounds.pro
spd_ui_draw_object__indexmagic.pro
spd_ui_draw_object__legendoff.pro
spd_ui_draw_object__legendon.pro
spd_ui_draw_object__lockbottom.pro
spd_ui_draw_object__lockmiddle.pro
spd_ui_draw_object__locktop.pro

spd_ui_draw_object method: lockTopThis routine sets the locked settings for a top panel in a column of a layout.

spd_ui_draw_object__logfixticks.pro
spd_ui_draw_object__makelinereference.pro
spd_ui_draw_object__makeminorticks.pro
spd_ui_draw_object__makespec.pro

spd_ui_draw_object method: makeSpecPurpose: helper routine for draw object.

spd_ui_draw_object__makeview.pro

spd_ui_draw_object method: makeViewcreates the views for a panel,incorporates all the layout informationthat can effect this.

spd_ui_draw_object__makexyaxismodel.pro

spd_ui_draw_object method: makeXYAxisModelConstructs an X or Y axis model from a spd_ui_axis_settings objectInputs:dir = direction of the axis(0=x,1=y)xrange,yrange: data range of the panelscaling: scaling mode of the panel 0(linear),1(log10),2(logN)axisSettings: axis settings objectplotDim1: normalized length of the plot on the dimension perpendicual to the axisplotDim2: normalized length of the plot on the dimension parallel to the axiscolor: The color of the plot frame in RGBthick: The thickness of the plot frame/ticksuseIsTime: use this keyword to override the current isTime valueOutputsgridmodel: the model containing any axis gridsmodel: the axis model is returned in this keywordmajorTickValues:the major tickvalues are returned in this keywordnumMinorTicks: the number of minor ticks is returned in this keywordisTimeAxis: flag indicating whether the axis is time annotated or not returned in this keywordlabelPos: this keyword returns the most distant label position from the axisfail: 1 indicates failure, 0 success$LastChangedBy: pcruce $$LastChangedDate: 2014-06-25 17:47:00 -0700 (Wed, 25 Jun 2014) $$LastChangedRevision: 15444 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/display/draw_object/spd_ui_draw_object__makexyaxismodel.pro $

spd_ui_draw_object__makezaxismodel.pro
spd_ui_draw_object__markeroff.pro

spd_ui_draw_object method: markerOffstops drawing the marker$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/display/draw_object/spd_ui_draw_object__markeroff.pro $

spd_ui_draw_object__markeron.pro

spd_ui_draw_object method: markerOnstarts drawing a new marker at the current location'default' is a marker object from which the marker defaults will be copied'all' indicates that markers should be drawn on all panelsnote that markerOn can fail if the current location isn't within theboundaries of a panel.

spd_ui_draw_object__nicenum.pro

spd_ui_draw_object method: niceNumFunction adapted from Graphics Gems:Heckbert, Paul S., Nice Numbers for Graph Labels, Graphics Gems, p.

spd_ui_draw_object__nicenumtime.pro

spd_ui_draw_object method: niceNumTimeFunction adapted from Graphics Gems:Heckbert, Paul S., Nice Numbers for Graph Labels, Graphics Gems, p.

spd_ui_draw_object__norm2pt.pro
spd_ui_draw_object__nukedraw.pro
spd_ui_draw_object__placemajorticks.pro
spd_ui_draw_object__pt2norm.pro

spd_ui_draw_object method: pt2normConvert pts into draw area normal coordinates.

spd_ui_draw_object__removeinstance.pro
spd_ui_draw_object__rubberband.pro
spd_ui_draw_object__rubberbandoff.pro
spd_ui_draw_object__rubberbandon.pro

spd_ui_draw_object method: rubberBandOnStarts drawing the rubber band at the current location$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/display/draw_object/spd_ui_draw_object__rubberbandon.pro $

spd_ui_draw_object__setclick.pro

spd_ui_draw_object method: SetClickThis routine performs the draw work necessary to display a marker clickbasically this means mutating the selected flag on markerinfo.

spd_ui_draw_object__setcursor.pro
spd_ui_draw_object__setlegendhide.pro

spd_ui_draw_object method: setLegendHideBecause the static components of the legend are still somewhatdynamic(Because they can be manipulated between updates),This routine is needed to manipulate them separatelyFrom the lists in self.staticViews & self.dynamicViewsInputs: dynamic(boolean keyword):, set to hide dynamic component of the legend hide:(boolean): set to the hide value you want to use$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/display/draw_object/spd_ui_draw_object__setlegendhide.pro $

spd_ui_draw_object__setmodelhide.pro

spd_ui_draw_object method: setModelHideThis routine sets the hide values for all the models inside the views that it receives as an argumentIt just exists to remove some duplication that occurs when generating an instanced displayThis is a recursive functionInputs: hidevalue(boolean): The value that the hide flag will be set to.

spd_ui_draw_object__setproperty.pro
spd_ui_draw_object__setvarhide.pro

spd_ui_draw_object method: setVarHideThis routine sets the hide value for variables on a panel witha particular index.

spd_ui_draw_object__setzoom.pro
spd_ui_draw_object__update.pro

spd_ui_draw_object method: UpdateThis function updates the entire display, it will be prettyslow so it should only be called after panel applies, but notduring common widget events.

spd_ui_draw_object__updatehbar.pro
spd_ui_draw_object__updatelegend.pro
spd_ui_draw_object__updatepage.pro

spd_ui_draw_object method: makeViewupdates the draw object to reflect the page settingsInputs: pageSettings(object reference): the spd_ui_page_settings associated with the window being drawnOutputs: returns: 1 on success, 0 on failure.

spd_ui_draw_object__updatepanels.pro

spd_ui_draw_object method: updatePanelsdraws the panels for this window.

spd_ui_draw_object__updatevbar.pro
spd_ui_draw_object__vbaroff.pro

spd_ui_draw_object method: vBarOffstop drawing a vertical bar$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/display/draw_object/spd_ui_draw_object__vbaroff.pro $

spd_ui_draw_object__vbaron.pro
spd_ui_draw_object__xclip.pro

spd_ui_draw_object method: xclipThis routine, performs prepocessing with respect to the x-axis1.

spd_ui_draw_object__yclip.pro