casa::ErrorPlot Class Reference

An error plot is a scatter plot with error bars drawn. More...

#include <Plot.h>

Inheritance diagram for casa::ErrorPlot:

List of all members.

Public Member Functions
	ErrorPlot ()
virtual	~ErrorPlot ()
virtual PlotPointDataPtr	pointData () const
	Overrides ScatterPlot::pointData().
virtual PlotErrorDataPtr	errorData () const =0
	ABSTRACT METHODS //.
virtual bool	errorLineShown () const =0
	Returns whether the error bar line is shown or not.
virtual void	setErrorLineShown (bool show=true)=0
	Sets whether the error bar line is shown.
virtual PlotLinePtr	errorLine () const =0
	Returns the line used to draw the error bars.
virtual void	setErrorLine (const PlotLine &line)=0
	Sets the line used to draw the error bars.
virtual void	setErrorLine (const PlotLinePtr line)
	Convenience methods for setting error line.
virtual void	setErrorLine (const String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
virtual void	setErrorLineColor (const String &color)
virtual void	setErrorLineStyle (PlotLine::Style style)
virtual void	setErrorLineWidth (double width)
virtual unsigned int	errorCapSize () const =0
	Returns the "cap" size of the error bar.
virtual void	setErrorCapSize (unsigned int capSize)=0
	Sets the error bar cap size in pixels.

---

Detailed Description

An error plot is a scatter plot with error bars drawn.

It is expected to consist of PlotErrorData.

Definition at line 366 of file Plot.h.

---

Constructor & Destructor Documentation

casa::ErrorPlot::ErrorPlot

(

)

[inline]

Definition at line 368 of file Plot.h.

virtual casa::ErrorPlot::~ErrorPlot

(

)

[inline, virtual]

Definition at line 370 of file Plot.h.

---

Member Function Documentation

virtual unsigned int casa::ErrorPlot::errorCapSize

(

)

const [pure virtual]

Returns the "cap" size of the error bar.

The cap is the perpendicular line at the end of the error bar (that makes the error bar look like an I rather than a |).

virtual PlotErrorDataPtr casa::ErrorPlot::errorData

(

)

const [pure virtual]

ABSTRACT METHODS //.

Returns the error data used for this plot.

Referenced by pointData().

virtual PlotLinePtr casa::ErrorPlot::errorLine

(

)

const [pure virtual]

Returns the line used to draw the error bars.

Referenced by setErrorLine(), setErrorLineColor(), setErrorLineStyle(), and setErrorLineWidth().

virtual bool casa::ErrorPlot::errorLineShown

(

)

const [pure virtual]

Returns whether the error bar line is shown or not.

virtual PlotPointDataPtr casa::ErrorPlot::pointData

(

)

const [inline, virtual]

Overrides ScatterPlot::pointData().

Implements casa::ScatterPlot.

Definition at line 374 of file Plot.h.

References errorData().

virtual void casa::ErrorPlot::setErrorCapSize

(

unsigned int

capSize

)

[pure virtual]

Sets the error bar cap size in pixels.

virtual void casa::ErrorPlot::setErrorLine

(

const PlotLine &

line

)

[pure virtual]

Sets the line used to draw the error bars.

Referenced by setErrorLine(), setErrorLineColor(), setErrorLineStyle(), and setErrorLineWidth().

virtual void casa::ErrorPlot::setErrorLine

(

const PlotLinePtr

line

)

[inline, virtual]

Convenience methods for setting error line.

Definition at line 398 of file Plot.h.

References casa::SimpleCountedConstPtr< t >::null(), setErrorLine(), and setErrorLineShown().

virtual void casa::ErrorPlot::setErrorLine	(	const String &	color,
		PlotLine::Style	style = PlotLine::SOLID,
		double	width = 1.0
	)		[inline, virtual]

Definition at line 402 of file Plot.h.

References errorLine(), casa::Plot::line(), casa::PlotLine::setColor(), setErrorLine(), casa::PlotLine::setStyle(), and casa::PlotLine::setWidth().

virtual void casa::ErrorPlot::setErrorLineColor

(

const String &

color

)

[inline, virtual]

Definition at line 411 of file Plot.h.

References errorLine(), casa::Plot::line(), casa::PlotLine::setColor(), and setErrorLine().

virtual void casa::ErrorPlot::setErrorLineShown

(

bool

show = true

)

[pure virtual]

Sets whether the error bar line is shown.

If show is true, the implementation can decide whether to choose the line shown, or just use the last set PlotLine.

Referenced by setErrorLine().

virtual void casa::ErrorPlot::setErrorLineStyle

(

PlotLine::Style

style

)

[inline, virtual]

Definition at line 416 of file Plot.h.

References errorLine(), casa::Plot::line(), setErrorLine(), and casa::PlotLine::setStyle().

virtual void casa::ErrorPlot::setErrorLineWidth

(

double

width

)

[inline, virtual]

Definition at line 421 of file Plot.h.

References errorLine(), casa::Plot::line(), setErrorLine(), and casa::PlotLine::setWidth().

---

The documentation for this class was generated from the following file:

• code/graphics/GenericPlotter/Plot.h