Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data
PURPOSE:
A GA_Data object defines a dataset Y as a function of X. It can
be drawn on a Plot defined by a GA_Plot object.
CATEGORY:
GAplot
SUPERCLASSES:
SUBCLASSES:
GA_Data3
GA_DataV
CREATION:
See GA_Data::Init
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::Add_Text
PURPOSE:
Add a text annotation defined by GA_AnnotateText object that will be
drawn together with this data object onto the plot object.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Data::]Add_Text(XPOS,YPOS,TEXT)
ARGUMENTS:
XPOS X position of the text
YPOS Y position of the text
TEXT a string
KEYWORDS:
DRAW Set to draw this data object after adding the text.
USE Set to 0 to hide or 1 to display this text annotation. Default=1
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::Delete_Text
PURPOSE:
Deletes a text member from the data object.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->Delete_Text,dataset
ARGUMENTS:
DATASET Either a text object or the index of text objects starting
zero as the first one.
KEYWORDS:
DRAW Draw the data set upon deletion of the text object.
NODESTROY Set to not destroy the text object itself, only remove
from this data object. Default to destroy.
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::Draw
PURPOSE:
Overplots this data set onto a Plot that has been established by
a GA_Plot object.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Data::]Draw
ARGUMENTS:
KEYWORDS:
DRAGOFFSET
ERASE
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetColor
PURPOSE:
Retrieves the color index associated with this data set.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetColor()
ARGUMENTS:
KEYWORDS:
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetFlagAutoLabel
PURPOSE:
Retrieves value of FlagAutoLabel
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetFlagAutoLabel()
ARGUMENTS:
KEYWORDS:
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetLabel
PURPOSE:
Retrieves the label of this dataset. If not set, use YName.
Can be overridden by subclasses to supply automatically generated
label. FlagAutoLabel is provided to facilitate this.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetLabel()
ARGUMENTS:
KEYWORDS:
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetLineStyle
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetLineStyle()
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetLineStyleNone
PURPOSE:
Retrieves linestyle index for 'NONE' (no line).
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetLineStyleNone()
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetPlot
PURPOSE:
Retrieves the GA_Plot object that contains this data object.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetPlot()
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetSymbol
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetSymbol()
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetSymbolSize
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetSymbolSize()
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetXData
PURPOSE:
Retrieves abscissa vector X.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetXData()
ARGUMENTS:
KEYWORDS:
MARKER >0, returns X values of marked data points.
<0, returns X values of unmarked data points.
RESAMPLE Set to resample data before returning X. Data is resampled
to the maximum number of data points specified by member maxpts.
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetXName
PURPOSE:
Retrieves the name of X vector.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetXName()
ARGUMENTS:
KEYWORDS:
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetXRange
PURPOSE:
Retrieves the range of X data.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetXRange()
ARGUMENTS:
KEYWORDS:
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetYData
PURPOSE:
Retrieves ordinate vector Y.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetYData()
ARGUMENTS:
KEYWORDS:
MARKER >0, returns Y values of marked data points.
<0, returns Y values of unmarked data points.
RESAMPLE Set to resample data before returning Y. Data is resampled
to the maxmum number of data points specified by member maxpts.
ERRORBAR A vector of same size of Y vector. Returns Y + ERRORBAR/2.
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetYName
PURPOSE:
Retrieves the name of Y vector.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetYName()
ARGUMENTS:
KEYWORDS:
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::GetYRange
PURPOSE:
Retrieves the range of Y data.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Data::]GetYRange([XRANGE])
ARGUMENTS:
XRANGE Returns Y range only for data points within XRANGE.
KEYWORDS:
ERRORBAR Set to retrieve Y range with errorbars included.
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::Init
PURPOSE:
Initializes the GA_Data object.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj = OBJ_NEW('GA_Data',[X,]Y)
or
Result = Obj->[GA_Data::]Init([X,]Y) (in a subclass' Init method only)
ARGUMENTS:
X - A vector or a pointer to a vector. If not specified, Y is defined
as a function of point number starting at zero. If both arguments
are specified, Y is a function of X, and X and Y have to be of
same data type.
Y - The ordinate data or a pointer to the ordinate data.
KEYWORDS:
Properties retrieveable via GA_Data::Get{PropertyName} are
indicated by "Get" following the keyword. Properties settable via
GA_Data::SetProperty are indicated by "Set" following the keyword.
COLOR (Get,Set) The color index for plotting this data set. Default=foreground
DEBUG Set to turn on debugging.
ERRORBAR (Set) A vector of errorbar values (+- errorbar/2).
INTERPOLATE (Set) Set to set editmode to interpolate (?)
FLAGAUTOLABEL (Get,Set) Set to automatically determine label from method call.
LABEL (Get,Set) Legend label
LINESTYLE (Get,Set) The linestyle of drawing this data. Default=0 (solid line)
MARKCOLOR (Get,Set) Color index for markers
MARKER (Get,Set) Set to indicate that data points can be marked.
MARKFILL (Get,Set) Set to fill marker symbols.
MARKLABELS (Get,Set) Label used for markers.
MARKSIZE (Get,Set) Size of mark symbols.
MARKSYMBOL (Get,Set) Symbol used for markers.
PLOT (Get,Set) The GA_Plot object that contains this object.
SHIFT (Set) Set to set editmode to shift (?)
SYMBOL (Get,Set) The symbol used for this data set.
SYMFILL (Get,Set) Set this keyword to fill the symbols.
SYMFRAC (Get,Set) The fraction (0-100) of symbols to plot. Default=0.
SYMSIZE (Get,Set) The size of symbols. Default=1.
XNAME (Get,Set) A name associated with X.
XSCALE (Get,Set) Two elements arrary for X scaling. X=X*XSCALE[1]+XSCALE[0]
YNAME (Get,Set) A name associated with Y.
YSCALE (Get,Set) Two elements array for Y scaling. Y=Y*YSCALE[1]+YSCALE[0]
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::SetProperty
PURPOSE:
Sets the value of a property or group of properties for the GA_Data.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Data:]SetProperty
ARGUMENTS:
KEYWORDS:
Any keyword to GA_Data::Init followed by "Set". In addition,
HIDE Set to hide this data set in Plot.
PROPERTIES3D
SELECTEDPOINT Index of selected data point.
STATUS
XDATA A vector argument to replace abscissa data X.
YDATA A vector argument to replace ordinate data Y.
fitDegree Degree of fit to display with data.
0=none, 1=linear, 2=quadratic, 3=cubic
fitThruZero if=1 then fit forced to go through zero
MODIFICATION HISTORY
11-Mar-2005 Added fitDegree and fitThruZero keywords
Source: src/idl_cvs/ga_data__define.pro
NAME:
GA_Data::Set_Text_Property
PURPOSE:
Sets the parameters associated with a text annotation object.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Data::]Set_Text_Property [,TEXTMEMBER]
ARGUMENTS:
TEXTMEMBER Index number of text objects (0 being the first one).
If not specified, this methon applies to all text members.
KEYWORDS:
DRAW Draw this data object after setting text properties.
NOUSE Set to not display the text.
TEXT A string to replace the text content.
USE Set to display the text.
All properties settable by GA_AnnotateText::SetProperty.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot
PURPOSE:
A GA_Plot object draws graphs of its data members. It is a container of
GA_Data objects. If it has more than one data object member, the data
members are overlayed. A plot object can be thought as a wrapper to
IDL's PLOT command, keyword values to the PLOT command are preserved as
plot object's or data objects' members. A plot object is plotted on a
window created by a GA_Plot_Window object which may contain several plot
objects.
CATEGORY:
GAplot
SUPERCLASSES:
SUBCLASSES:
GA_Plot3
CREATION:
See GA_Plot::Init
BASIC METHODS:
GA_Plot::Add_Data
GA_Plot::Add_Data_Object
GA_Plot::Delete_Data
GA_Plot::Select_Data
GA_Plot::Set_Data_Property
GA_Plot::Set_Plot_Property
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Add_Data
PURPOSE:
This method allows you to add another data object to
the plot object. Properties of the data object may be set with
the method's keywords. Extra carries any keywords acceptable
by Ga_Data[3]::Init. A new data object will be created and
the reference is returned.
See also GA_Plot::Add_Data_Object
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->Add_Data([XDATA,] YDATA [,ZDATA]])
ARGUMENTS:
XDATA X vector. If not specified, X will set to a point number
array starting at zero.
YDATA Y vector as a function of X if ZDATA is not specified.
If ZDATA is specified, YDATA is the 2nd independent data.
ZDATA A two dimensional array as a function of X and Y.
If ZDATA is specified, a GA_Data3 will be created.
See GA_Data::Init and GA_Data3::Init for acceptable inputs.
KEYWORDS:
Any keywords acceptable to GA_Data::Init or GA_Data3::Init, and
DRAW Set to re-draw all datasets.
NOAUTORANGE Set to not reset data ranges automatically.
HISTORY:
07-10-2002 Q.Peng - This method shouldn't have worked for adding a
GA_Data3 (with XDATA,YDATA,ZDATA) before. The order of
arguments has just been corrected.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Add_Data_Object
PURPOSE:
This method allows you to add a GA_DATA or GA_DATA3 object to
the plot object. The data object reference is returned.
See also GA_Plot::Add_Data
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Plot::]Add_Data_Object, NEWDATA
ARGUMENTS:
NEWDATA A GA_Data(3) object to be added.
KEYWORDS:
DRAW Set to re-draw all datasets.
NOAUTORANGE Set to not reset the data range automatically.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Add_Text
PURPOSE:
This method adds a text annotation to a specified location on
the plot.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->Add_Text, XPOS, YPOS, TEXT
ARGUMENTS:
XPOS X coordinate of the text.
YPOS Y coordinate of the text.
TEXT A string.
KEYWORDS:
Any keywords acceptable to GA_AnnotateText::Init, and
DRAW Set to re-draw all datasets.
USE 1 - display the text (default), 0 - do not display the text.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Auto_Range
PURPOSE:
Set data ranges automatically according to data.
This is needed for multiple data sets.
Set both xrange and yrange by default.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]Auto_Range
KEYWORDS:
OVERRIDE Set to ALWAYS autoscale both MIN and MAX regardless of
the settings of xautorange and yautorange
XONLY Set to only autoscale X range.
YONLY Set to only autoscale Y range.
ZONLY Set to only autoscale Z range.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Delete_Data
PURPOSE:
This method allows you to delete a data set member from the Plot
Object. The data set may be specified by indicating its NAME, by
indicating its POSITION (index number), or by the data OBJECT itself.
(See the Select_Data method for more details about a data set's
NAME and POSITION.)
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]Delete_Data, DATASET
ARGUMENTS:
DATASET A string for its name, or an integer for its position
(0 being the 1st), or a GA_Data object reference.
KEYWORDS:
DRAW Set to re-draw all datasets.
NOAUTORANGE Set to not reset data ranges automatically.
NODESTROY Set to not destroy the deleted data object.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Draw
PURPOSE:
This method draws the Plot Object, including all of the
data members included in the Plot Object.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]Draw
KEYWORDS:
NODATA If set, only the plot axes and annotation are drawn.
NOERASE keyword to PLOT.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::GetDataObjects
PURPOSE:
The method returns the array of data objects stored in this plot object.
CATEGORY:
GAplot
CALLING SEQUENCE:
Results = Obj->[GA_Plot::]GetDataObjects()
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::GetDataSelected
PURPOSE:
Retrieves the selected data object. A data object can be selected
by clicking near to the data points with Left-Mouse-Button in
'Select' mode.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Plot::]GetDataSelected()
KEYWORDS:
INDEX A named variable to recieve the index of the selected data object
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::GetWindow
PURPOSE:
This method returns the GA_Plot_Window object that the plot object
belongs to, for EditCallBack purpose.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Plot::]GetWindow()
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Get_Data_Property
PURPOSE:
This method allows you to retrieve the properties of a data member
belonging to the plot. Data member is identified by passing its
object reference (which can be obtained with the Select_Data method).
If a data member is not specified, the first data memeber is used
as a default.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]Get_Data_Property [,DATAMEMBER]
ARGUMENTS:
DATAMEMBER A GA_Data object associated with this plot object.
KEYWORDS:
Keywords are named variables to receive retrieved values.
At least one keyword should be provided.
COLOR The color index of the data member.
LINESTYLE The linestyle of the data member.
MARKER Used together with XDATA and/or YDATA.
>0 for marked data points, <0 for unmarked data points.
SYMBOL
SYMFILL
SYMFRAC
SYMSIZE
XNAME
XDATA Abscissa vector X of the data member.
YNAME
YDATA Ordinate vector Y of the data member.
EXAMPLE:
oPlot->Get_Data_Property,oPlot->Select_Data(1),XData=xdata,Marker=-1
This retrives X values of the unmarked data points from the 2nd
data member of this plot and stores the result in variable xdata.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Get_Plot_Property
PURPOSE:
This method allows you to obtain the standard Plot properties
from the Plot Object. (See the Init Method for a more complete
explanation of these Plot properties.)
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]Get_Plot_Property
KEYWORDS:
Keywords are named variables to receive retrieved values.
Any keywords to GA_Plot::Init followed by "Get", and
NUMDATASETS
NUMTEXT
LCHARSIZE
NOXTICKS
SETXRANGE
SETYRANGE
XAXIS
XAUTORANGE
YAXIS
YAUTORANGE
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Init
PURPOSE:
This method initializes a GA_Plot object. Standard properties
are set with positional and keyword parameters. The routine makes
GA_DATA objects from the data passed into the method. Use the
Add_Data method to add additional data sets and the Delete_Data
method to remove data sets from the Plot Object. Data inside the
data objects can be modified with the Set_Data_Property method.
Think of this initialization routine as a wrapper for the PLOT
command. Use keywords appropriate for the PLOT command
in making the call.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj = OBJ_NEW('GA_Plot'[,X [,Y]])
or
Result = Obj->[GA_Plot::]Init([X [,Y]]) (in a subclass' Init method only)
ARGUMENTS:
X - If Y is specified, X, Y are the two arguments to GA_Data::Init
If Y is not specified, X can be a GA_Data or GA_DataV object,
or it can be the only argument to GA_Data::Init.
Y - The 2nd argument to GA_Data::Init
KEYWORDS:
Properties retrieveable via GA_Plot::Get_Plot_Property are indicated
by "Get" following the keyword. Properties settable via
GA_Plot::Set_Plot_Property are indicated by "Set".
ASPECT (Get,Set) Set to keep aspect ratio of plots.
BACKGROUND (Get,Set) The color index of background.
CHARSIZE (Get,Set) The character size for labels.
COLOR (Get,Set) The color index for axes and annotations.
CONTOUR Set to do contour plots.
DATACOLOR The color for plotting data created here.
DEBUG(Set) Set to turn on debugging.
DEP_DATA_NAME The name associated with dependent data (Y).
FLAGLEGEND (Get,Set) 0 = do not show labels, 1 = show labels
INDEP_DATA_NAME The name associated with independent data (X).
GRID (Get,Set) A two-element array (columns,rows) for the layout of all plots
in the GA_Plot_Window object to which this plot object belongs.
LEVELS The level vector for contour plot.
NAME (Get,Set) The name associated with this plot (used for plot selection).
NUMBER (Get,Set) The index number of this plot in window (starting at 0).
OVERGRIDSTYLE (Get,Set) Grid style for both X and Y axes.
OVERLAYGRID (Get,Set)
OVERLAYZERO (Get,Set)
PSYM The plot symbol used to display the data.
SLICEMODE (Get,Set)
SUBTITLE (Get,Set)
SYMFRAC The fraction (0-100) of symbols to be plotted.
SYMSIZE The plot symbol size.
TICKSOUT (Get,Set) If non 0, ticks appear on outside of the plot.
TITLE (Get,Set) The plot title.
XCHARSIZE (Get,Set)
XLOG (Get,Set)
XMTICKS (Get,Set) X minor ticks
XRANGE (Get,Set)
XSTYLE (Get,Set)
XTICKFORMAT(Set)
XTICKS (Get,Set)
XTITLE (Get,Set)
YCHARSIZE (Get,Set)
YLOG (Get,Set)
YMTICKS (Get,Set) Y minor ticks
YRANGE (Get,Set)
YSTYLE (Get,Set)
YTICKFORMAT(Set)
YTICKS (Get,Set)
YTITLE (Get,Set)
WID (Get,Set) The window index number of the window where this plot is displayed.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Select_Data
PURPOSE:
This method retrieves a particular data object associated with this
plot object. A data can be selected by name or by index number.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Plot::]Select_Data([DATASET])
ARGUMENTS:
DATASET A string specifying the name of the data object, or an
integer specifying the index number, 0 being the 1st one.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::SetSliceMode
PURPOSE:
Set mode for data slicing. For a GA_Plot object, the plot can be used
as a slicer to slice through other GA_Plot3 objects in the same
window. The data in this plot will not be sliced because there is
no third dimension.
See also GA_Plot3::SetSliceMode
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]SetSliceMode, MODE
ARGUMENTS:
MODE 'A' - Can be used to slice through the 1st dimension of a
GA_Plot3 object with slicemode 'AB', or the 2nd dimension
of a GA_Plot3 object with slicemode 'BA'.
'B' - Can be used to slice through the 2nd dimension of a
GA_Plot3 object with slicemode 'AB', or the 2nd dimension
of a GA_Plot3 object with slicemode 'AB'.
'X' - Not a slicer. In 'Slice' mode, when cursor moves into
this plot, nothing happens.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Set_Data_Property
PURPOSE:
This method allows you to change the parameters associated with a
particular data object. You must specify a particular data set by
passing the object reference to the data set. (This can be obtained
with the GA_Plot::Select_Data method.) If a data set object is not
specified as the data member, the first data set is used by default.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]Set_Data_Property [,DATAMEMBER]
ARGUMENTS:
DATAMEMBER A GA_Data object associated with this plot object.
KEYWORDS:
Any keywords acceptable to GA_Data::SetProperty, and
AUTORANGE Set to reset the data range automatically.
DRAW Set to re-draw all datasets.
EXAMPLES:
oPlot->Set_Data_Property,oPlot->Select_Data(1),XData=x,Ydata=y
This resets X and Y vectors for the 2nd dataset in the oPlot object.
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Set_Plot_Property
PURPOSE:
This method allows you to set the standard Plot properties. If
the DRAW keyword is set, the plot will be drawn after the new
properties are set. (See the Init Method for a more complete
explanation of these Plot properties.)
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]Set_Plot_Property
KEYWORDS:
Any keywords to GA_Plot::Init followed by "Set", and
DRAW
LCHARSIZE
NOXTICKS
SETXRANGE
SETYRANGE
XAUTORANGE
YAUTORANGE
WINDOW
Source: src/idl_cvs/ga_plot__define.pro
NAME:
GA_Plot::Set_Text_Property
PURPOSE:
This method allows you to change the parameters associated with a
text annotaion object. The textMember is the index number of the
text object. All text members are used by default if no textMember
is specified.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot::]Set_Text_Property [,TEXTMEMBER]
ARGUMENTS:
TEXTMEMBER An integer specifying the index number of the text memeber.
0 is the 1st text. If not specified, all texts are used.
KEYWORDS:
DRAW Set to re-draw all datasets.
NOUSE Set to not display the text in the plot.
TEXT A string to replace the text value.
USE Set to display the text in the plot.
Any keywords acceptable by GA_AnnotateText::SetProperty
Source: src/idl_cvs/ga_plotw.pro
NAME:
GA_PlotW
PURPOSE:
Plot widget for "table" of data, or input X & Y arrays.
CATEGORY:
Plotting, GA Plot Objects
KEYWORDS:
indicesPlot - indices to plot (plot if =1).
Same 1st dimension as Y (if Y is 2-D)
if just 1 dimension, and Y is two, use same mask for
all y's.
psym - many options. psym=7 is no symbols
0 is circle
1 is square
2 is diamond
3 is triangle
4 is upside down triangle
5 is 4-point star
6 is 5-point star
color - can be an index 0-255, or common color name, like 'red'
linestyle
xrange
yrange
PlotLabels
xtitle
ytitle
title
xsize
ysize
flagLegend - if=0, do not make a legend
EXAMPLE:
objRef = GA_PlotW( xdata=indgen(5), ydata=[1,3,5,4,2] )
or
table=strarr(3,8)
table[0,*]= ['time','0.01','0.02','0.03','0.04','0.05','0.06','0.07']
table[1,*]= ['Ip', '1.0', '1.1', '1.3', '1.6', '1.6', '1.5', '1.3' ]
table[2,*]= ['Bt', '.7', '.71', '.73', '.76', '.75', '.65', '.59' ]
objRef = GA_PlotW( table=table )
or
objRef = GA_PlotW(table=['Bt', '.7', '.71', '.73', '.76'] )
or to make a scatter plot with a y=y line through it:
x=findgen(100)
noise = randomn(seed,100)*(x+20)/10
y=(x+noise ) > 0
objRef = GA_PlotW( xdata=x, ydata=transpose([[y],[x]]), plotnum=[0,0], $
psymbol=[10,7], linestyle=[6,0] )
LIMITATIONS:
"Marking" points on a plot will select correspongind row in table,
if called "properly," as from plotdef__define.pro, but this only works
for the last table created.
MODIFICATION HISTORY
28-Jul-2011 enhanced keywords, like color and psym.
21-Mar-2003 Allow for indices array to plot different xranges.
(Can then have different ranges have different colors, etc.)
10-Dec-2002 Written by Bill Davis. Based on various object-oriented
plotting codes from General Atomics.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window
PURPOSE:
A GA_Plot_Window is a compound widget with a draw window that
contains one or several GA_Plot[3] objects. Plots can be added
or deleted. The window object handles plot layout, coordinates,
preference and properties configurations, mouse events and
draws all the plots through their own draw methods.
CATEGORY:
GAplot
SUPERCLASSES:
SUBCLASSES:
CREATION:
See GA_Plot_Window::Init
BASIC METHODS:
GA_Plot_Window::Add_Plot
GA_Plot_Window::Delete_Plot
GA_Plot_Window::SetCurrentTool
GA_Plot_Window::Set_Crosshairs
GA_Plot_Window::Set_Status_Window
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Add_Plot
PURPOSE:
This method adds a plot to the window. A new column of plots
will be created if necessary to accomodate the new plot. A plot
object is required. If NoDuplicate keyword is set, check if newPlot
belongs to the window already. If so, return.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Add_Plot, NEWPLOT
ARGUMENTS:
NEWPLOT A GA_Plot object to be added to the window.
KEYWORDS:
DRAW Set to re-draw all plots.
NODUPLICATE Set to make sure NEWPLOT is added to this
window object only once.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::CheckPlotNumbers
PURPOSE:
Goes through member plots and checks to ensure that they are
sequentially numbered. Renumbers them if they are not. Plots
having the same number are overlayed and can cause confusing
display results. This routine is optional - to be used by
the parent application if needed.
It returns 0 if no plot has been renumbered, returns 1 otherwise.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Plot_Window::]CheckPlotNumbers()
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Delete_Plot
PURPOSE:
This method deletes a plot from the list of plots within the window.
Plots are numbered from 1 to N and are in column order in the window.
NO EDITCALLBACK is generated by this method! For an EDITCALLBACK
use GA_Plot_Window::RemovePlot.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Delete_Plot, NUMBER
ARGUMENTS:
NUMBER The index number of the plot object to be deleted.
KEYWORDS:
NODRAW Set to not re-draw all plots. Useful when deleting
more than one plot to complete the deletion before
re-drawing what is left.
NODESTROY Set to not destroy the plot object being deleted from this window.
Default is to destroy the plot object.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Draw
PURPOSE:
Draws all the plots in this window by calling the plot objects
Draw method.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Draw
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Dump
PURPOSE:
Prints out pointers to plot objects and their associated data objects.
For debugging purposes.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Dump
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::EditCallback
PURPOSE:
Perform an IDL procedure call upon certain editing action,
CALL_PROCEDURE,ProName,Parent,oData,oPlot,Action
ProName is the procedure name specified by keyword EDITCALLBACK
when the window object is created (see GA_Plot_Window::Init).
This procedure should expect four arguments.
Parent The parent widget of the PARENT argument specified in
GA_Plot_Window::Init. If the GA_Plot_Window is
created through CW_GAWindow, Parent will be the PARENT
argument passed to CW_GAWindow.
oData A GA_Data object or a null object.
oPlot A GA_Plot object or a null object.
Action An action string such as 'ADD_DATA','DELETE_DATA',
'DELETE_PLOT','REFERENCE_POINT',etc.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]EditCallback, oData, oPlot, Action
ARGUMENTS: see above
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::GetCurrentTool
PURPOSE:
Retrieves the name of the current mouse mode. Possible modes are
['Select','Zoom','Edit','Cursor','Slice','Mark','Vector'] plus
those defined by MOUSEMODES.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Plot_Window::]GetCurrentTool()
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::GetPlot
PURPOSE:
Retrieves a plot object specified by its index number.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Plot_Window::]GetPlot(INDEX)
ARGUMENTS:
INDEX An index number of the plot object in this window.
0 = 1st plot object.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::GetPlotList
PURPOSE:
Retrieves the names of plots in this window object. A name is
specified or a default is given when a plot object is created.
CATEGORY:
GAplot
CALLING SEQUENCE:
Result = Obj->[GA_Plot_Window::]GetPlotList()
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Init
PURPOSE:
Initializes a GA_Plot_Window object. The window is conceived as a
compound widget via CW_GAWindow. When you get the "value" of the
compound widget, you are returned the window object. Instead of
"setting values" to the compound widget, you call window object
methods.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj = OBJ_NEW('GA_Plot_Window',PARENT)
ARGUMENTS:
PARENT A parent widget ID in which the GA_Plot_Window object
draw widget will be build.
KEYWORDS:
ALLSAMEX Set to draw all plots with the same X range. Default = 1.
CHANGEMOUSEBITMAP Set to change cursor appearance in different modes. Default = 1.
CURRENTTOOL The index of currently selected mode from list
['Select','Zoom','Edit','Cursor','Slice','Mark','Vector']
COLOR The color index for cursor in the window.
DEBUG Set to turn on debugging.
EDITCALLBACK A string specifies a procedure name to call when editing is performed.
EDITFLAGS
EMPTYMSG A string array to display when there is no plot in the window.
ERRORCALLBACK A string specifies a procedure name to call when error occurs.
EVENTCALLBACK A string specifies a procedure name to call when WIDGET_DRAW event occurs.
GRID A two element array for plot layout.
GRID[0] = number of columns, GRID[1] = number of rows.
IMAGE_COLORS
MAXCOLS Maximum number of columns when determining grid automatically.
MAXROWS Maximum number of rows when determining grid automatically.
MBAR Widget ID of menubar for popup window.
MOUSEMODES A string array specifies additional mouse modes.
PLOTS A pointer to a vector of GA_Plot objects.
POPUPOPTIONS A 2xN string array specify entries for popup window.
If not specified, the default options are used.
POPUPOPTIONS[0,*] specify button names,
POPUPOPTIONS[1,*] specify event procedure names to call.
PREFERENCESFILE The file name for user preferences. File should be in user's HOME.
STATUS Set to include the status widget.
TRACKING Set to turn on cursor tracking.
XSIZE The X size of the draw widget display window.
YSIZE The Y size of the draw widget display window.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Insert_Plot
PURPOSE:
Inserts a new plot at a specified index number. The plot numbers
are shifted by 1 (+1) from the inserted plot.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Insert_Plot, OPLOT, NUMBER
ARGUMENTS:
OPLOT A GA_Plot object to be inserted.
NUMBER The index number which the new plot is inserted to.
KEYWORDS:
NODRAW Set to not re-draw all the plots. Useful when inserting
more than one plot to complete insertion before re-draw.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Remove_Plot
PURPOSE:
If the PLOT tag in EDITFLAGS structure is set, this method deletes
the plot object specified by the index number.
A GA_Plot_Window::EditCallBack is generated.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Remove_Plot
ARGUMENTS:
NUMBER The index number of the plot to be deleted.
KEYWORDS:
Any keywords acceptable by GA_Plot_Window::Delete_Plot.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Replace_Plot
PURPOSE:
This method replaces a current plot in the window with another plot.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Replace_Plot, OPLOT
ARGUMENTS:
OPLOT A replacement GA_Plot object.
KEYWORDS:
NUMBER The index number of the plot to be replaced.
The first plot (0) is replaced if number if not specified.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::RestorePreferences
PURPOSE:
Restore user's preferences from file specified by
PreferencesFile. This file is always in user's HOME directory.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]RestorePreferences
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::SavePreferences
PURPOSE:
Save the current settings to user's preferences file specified by
PreferencesFile. This file is always in user's HOME directory.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]SavePreferences
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::SetAutoGrid
PURPOSE:
Turn on or off the automatic grid layout calculation.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]SetAutoGrid, ONOFF
ARGUMENTS:
ONOFF 1 - turn on auto grid, 0 - turn off auto grid.
KEYWORDS:
DRAW Set to re-draw all plots.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::SetCharsize
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]SetCharsize, charsize
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::SetColorFlag
PURPOSE:
Resetting the color table.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]SetColorFlag, COLORFLAG
ARGUMENTS:
COLORFLAG Flag used by Color_Setup to determine the type of color table.
0 - greyscale color table,
1 - color_list() color table,
2 - black and white only.
KEYWORDS:
REVERSE Set to have white background. The default is with black background.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::SetCurrentTool
PURPOSE:
This method sets the current tool(mouse mode) to be used in the window.
'SELECT' - Seleting a data or a plot for manipulation, copying and deletion, etc.
'ZOOM' - Zoom and reset a plot, switch between multiple and single-plot displays.
'EDIT' - Add, delete or move data points.
'CURSOR' - Mark reference points, switch cursor readout from absolute to relative.
'SLICE' - Change the slices of the 3D data being plotted.
'MARK' - Mark a data point with a special symbol.
'VECTOR' - Change vector magnitute, data point resampling rate, etc.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]SetCurrentTool, TOOL
ARGUMENTS:
TOOL A string specifies the mode to set. See above for possible values.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::SetMaxGrid
PURPOSE:
Set the maximum number of columns and rows for determining
grid layout of plots automatically.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]SetMaxGrid, MAXGRID
ARGUMENTS:
MAXGRID A two-element array.
MAXGRID[0] = maxcols, MAXGRID[1] = maxrows.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Set_Crosshairs
PURPOSE:
This method turns cursor crosshair tracking on or off.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Set_Crosshairs, ONOFF
ARGUMENTS
ONOFF 1 - crosshair tracking on, 0 - crosshair tracking off.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::Set_Status_Window
PURPOSE:
This method assigns a text or label widget ID to be the
status window. Cursor tracking reports are sent to the
status window.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]Set_Status_Window,WID
ARGUMENTS:
WID The ID of a text or a label widget to report the cursor readouts
and other status message.
Source: src/idl_cvs/ga_plot_window__define.pro
NAME:
GA_Plot_Window::UserSetGrid
PURPOSE:
Allows manually setting the grid layout of the plots.
If howeve, the total number of plots is greater than
GRID[0]*GRID[1], the grid is recalculated automatically.
CATEGORY:
GAplot
CALLING SEQUENCE:
Obj->[GA_Plot_Window::]UserSetGrid, GRID
ARGUMENTS:
GRID A two-element array specifying the layout of plots.
GRID[0] = number of columns, GRID[1] = number of rows.
KEYWORDS:
DRAW Set to re-draw all the plots.