CPlotView:PlotLine

The PlotLine method draws points in a new plot window. The points are drawn as line segments. The line attributes are set in the "View > Default Properties > Image Plots" dialog. The related Line method takes its data from x and y tables rather than the CPlotView class data matrix.

Syntax

CPlot = CPlotView:PlotLine()

CPlot = CPlotView:PlotLine( sX )

CPlot = CPlotView:PlotLine( sX, sY )

CPlot = CPlotView:PlotLine( sX, sY, sTitle )

CPlot = CPlotView:PlotLine( sX, sY, sTitle, sCaption )

sX is the optional x axis label. If nil, a default is used.

sY is the optional y axis label. If nil, a default is used.

sTitle is the optional window title. If nil, a default is used.

sCaption is the optional plot caption. If nil, a default is used.

Return value:

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

Remarks

The plot below shows a line plot without error bars. To add error bars, specify them in the call to the CPlotView:Add method. To plot the same data as a scatterplot with only markers use the PlotScatter method. To draw stepped lines, use the PlotSteptLine method. To draw both markers and line segments, use the PlotConnected method.

Example

The plot above was created using the script below. The CImageView V was selected from a drop-list of all open image windows, and an image set was chosen. The header keyword AIRMASS was chosen for the x-axis. You could choose any keyword in the headers, or plot against some other value.

	-- select an image view from open windows
V = attachlist_imageview()	-- Returns a reference V for the CmageView
Assert( V, "No Image views are open")	-- exit if V is nil
	-- Get the keyword to plot
sKwd = "AIRMASS"	-- default keyword
sKwd, bOK = GetString( sKwd,"Keyword Name:")
Assert(bOK)
	-- loop over all images in the CImageView:
nStart = V:GetIndex()	-- save index of top image
for i = 1, V:Count() do
V:SetIndex(i)	-- Change to the i-th image
I = V:GetImage()	-- get a reference to the image at index i
if I then	-- if the image is good (it should be!)
x = i	-- x plot value is the image index.
y = I:KwdGetNum(sKwd)	-- y plot value is the keyword value
P:Add(x,y)	-- add the point to the collection
end
end
V:SetIndex(nStart)	-- reset the image window to the starting image

sCap = Sprintf("%s vs Image Index", sKwd )	-- Create caption above the plot for Overplot mode
	-- plot points with X label, Y label, Title, and Caption
P:PlotLine( "Image Index", sKwd, "My Plot", sCap)	-- specify the title and other labels

Syntax

Remarks

Example

Related Topics