CPlotView:Scatter

CPlotView:Scatter

The Scatter method creates a scatter plot using markers for data points. This is a CPlotView class version pf the non-class scatter function. The x and y points at the same array index are presumed to correspond to the same point. This function also can plot x and y error bars. The data for x, y, and the x and y error bars are each held in a 1-dimensional array. The example below adds a script for using y error bars. Error bars can also be used by the Line, Connect, and Stepline methods. The PlotScatter method takes its data from the CPlotView class data matrix rather than from x and y tables. Also see the Connect, Line, and StepLine commands in the CPlotView class.

This function creates a new plot window and returns a CPlot object for the plot series it creates. This object can be used to enhance or add to the plot or extract plot data for further analysis.

Syntax

CPlot = CPlotView:Scatter( x, y )

CPlot = CPlotView:Scatter( x, y, xe )

CPlot = CPlotView:Scatter( x, y, xe, ye )

CPlot = CPlotView:Scatter( x, y, xe, ye, sLabelX )

CPlot = CPlotView:Scatter( x, y, xe, ye, sLabelX, sLabelY )

CPlot = CPlotView:Scatter( x, y, xe, ye, sLabelX, sLabelY, sCaption )

CPlot = CPlotView:Scatter( x, y, xe, ye, sLabelX, sLabelY, sCaption, sWindowTitle )

x is a 1-dimensional array containing the x values.

y is a 1-dimensional array containing the x values.

xe is an optional 1-dimensional array containing the x error bar values.

ye is an optional 1-dimensional array containing the y error bar values.

sLabelX is an optional label for the x axis.

sLabelY is an optional label for the y axis.

sCaption is an optional plot caption.

sWindowTitle is an optional plot window title.

Parameters that are nil or missing to the right are assigned default values.

Return values:

CPlot is a new CPlot object attached to the current plot series. It is nil on failure.

Remarks

The returned parameters permit access to the plotted data. You can also change the plot properties including the marker attributes, labels, scaling, and others using commands such as Series Attributes and Plot Attributes.

Only the first 2 arguments, the (x,y) data, are required. Use a placeholder, like 0 or nil, to fill holes created by unused arguments. For example, to include y error bars but not x error bars, use nil in place of the xe parameter.

Examples

The script below creates some data from the random number generator and creates a scatter plot with default plot labels. Since none of the optional parameters is used, only the x and y arrays need to be specified.

V = new_plotview()	-- create a new CPlotView object
x = random( 10, 10, 20 )	-- 10 values between 10 and 20
y = random( 10, 20, 40 )	-- 10 values between 20 and 40
V:Scatter( x, y )	-- create the scatter plot

The next example creates a scatter plot of 1 million Gaussian Deviates including error bars on the y axis. The deviates have a standard deviation of 10 and mean of 100. A table for y errors bars is also created with a standard deviation of 3000 and mean of 0. The table for error bars is made to the same number of elements as the x-axis table x. This plot is the second one shown above.

V = new_plotview()	-- create a new CPlotView object
tbl_gauss = gaussdev(1000000, 10, 100)	-- create 1 million Gaussian deviates
H = new_histogram()	-- create a histogram object
h = H:Calc( tbl_gauss )	-- calculate the hstogram of the deviates
nCount = H:GetBinCount()	-- separate the 3 parameters for clarity
nMin = H:GetMin()+H:GetBinWidth()/2
nStep = H:GetBinWidth()
x = series( nCount, nMin, nStep )	-- create a series for the histgram x axis
ye = gaussdev( #x, 3000, 0)	-- add a table for y error bars
V:Scatter( x, h, nil, ye )	-- create the scatter plot with y error bars

Syntax

Remarks

Examples

Related Topics