casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casa::ErrorPlot Class Referenceabstract

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

#include <Plot.h>

Inheritance diagram for casa::ErrorPlot:
casa::ScatterPlot casa::Plot casa::PlotItem

Public Member Functions

 ErrorPlot ()
 
virtual ~ErrorPlot ()
 
virtual PlotPointDataPtr pointData () const
 Overrides ScatterPlot::pointData(). More...
 
virtual PlotErrorDataPtr errorData () const =0
 ABSTRACT METHODS //. More...
 
virtual bool errorLineShown () const =0
 Returns whether the error bar line is shown or not. More...
 
virtual void setErrorLineShown (bool show=true)=0
 Sets whether the error bar line is shown. More...
 
virtual PlotLinePtr errorLine () const =0
 Returns the line used to draw the error bars. More...
 
virtual void setErrorLine (const PlotLine &line)=0
 Sets the line used to draw the error bars. More...
 
virtual void setErrorLine (const PlotLinePtr line)
 Convenience methods for setting error line. More...
 
virtual void setErrorLine (const casacore::String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
 
virtual void setErrorLineColor (const casacore::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. More...
 
virtual void setErrorCapSize (unsigned int capSize)=0
 Sets the error bar cap size in pixels. More...
 
- Public Member Functions inherited from casa::ScatterPlot
 ScatterPlot ()
 
virtual ~ScatterPlot ()
 
virtual PlotDataPtr data () const
 Overrides Plot::data(). More...
 
virtual ppoint_t pointAt (unsigned int i) const
 Returns the data value at the given index. More...
 
virtual unsigned int drawCount () const
 Implements PlotItem::drawCount(). More...
 
virtual bool linesStep () const =0
 Get/set to connect points in step rather than line. More...
 
virtual void setLinesStep (bool linesStep=true)=0
 
virtual bool symbolsShown () const =0
 Returns true if symbols are shown, false otherwise. More...
 
virtual void setSymbolsShown (bool symbolsShown=true)=0
 Sets whether symbols are shown or not. More...
 
virtual PlotSymbolPtr symbol () const =0
 Returns a copy of the symbol for this plot. More...
 
virtual void setSymbol (const PlotSymbol &symbol)=0
 Sets the plot symbols to the given symbol. More...
 
virtual void setSymbol (const PlotSymbolPtr symbol)
 IMPLEMENTED METHODS //. More...
 
virtual void setSymbol (PlotSymbol::Symbol s)
 
virtual void setSymbol (char s)
 
virtual void setSymbolSize (double width, double height)
 
virtual void setSymbolLine (const PlotLine &line)
 
virtual void setSymbolLine (const PlotLinePtr line)
 
virtual void setSymbolLine (const casacore::String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
 
virtual void setSymbolAreaFill (const PlotAreaFill &fill)
 
virtual void setSymbolAreaFill (const PlotAreaFillPtr fill)
 
virtual void setSymbolAreaFill (const casacore::String &color, PlotAreaFill::Pattern pattern=PlotAreaFill::FILL)
 
- Public Member Functions inherited from casa::Plot
 Plot ()
 
virtual ~Plot ()
 
virtual void dataChanged ()=0
 Should be called whenever the underlying PlotData has changed, to let the plot and its attached canvas know that the plot needs to be redrawn. More...
 
virtual bool linesShown () const =0
 It's likely that any plot subclass (scatter, bar, function, etc.) will have lines of some sort, so it's safe to have in the base class. More...
 
virtual void setLinesShown (bool linesShown=true)=0
 Sets whether or not lines are shown. More...
 
virtual PlotLinePtr line () const =0
 Returns a copy of the line used for this plot. More...
 
virtual void setLine (const PlotLine &line)=0
 Sets the plot lines to the given line. More...
 
virtual void setLine (const PlotLinePtr line)
 IMPLEMENTED METHODS //. More...
 
virtual void setLine (const casacore::String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
 
virtual void setLineColor (const casacore::String &color)
 
virtual void setLineStyle (PlotLine::Style style)
 
virtual void setLineWidth (double width)
 
- Public Member Functions inherited from casa::PlotItem
 PlotItem ()
 Constructor. More...
 
virtual ~PlotItem ()
 Destructor. More...
 
virtual PlotCanvascanvas () const =0
 Returns the canvas this item is currently attached to, or NULL for none. More...
 
virtual casacore::String title () const =0
 Returns a human-readable title for identification. More...
 
virtual void setTitle (const casacore::String &newTitle)=0
 Sets this items's title to the given. More...
 
virtual bool isValid () const =0
 Returns true if this item is valid, false otherwise. More...
 
virtual bool isQWidget () const =0
 Returns whether this item can be directly casted to a QWidget or not. More...
 
virtual PlotAxis xAxis () const =0
 Returns the item's axes. More...
 
virtual PlotAxis yAxis () const =0
 
virtual void setXAxis (PlotAxis x)=0
 Sets the item's axes. More...
 
virtual void setYAxis (PlotAxis y)=0
 
virtual void setAxes (PlotAxis x, PlotAxis y)
 Sets both the item's axes at once. More...
 
virtual unsigned int drawSegments (unsigned int segmentThreshold) const
 Returns the number of draw segments for this item, using the given segment threshold. More...
 

Detailed Description

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

It is expected to consist of PlotErrorData.

Definition at line 373 of file Plot.h.

Constructor & Destructor Documentation

casa::ErrorPlot::ErrorPlot ( )
inline

Definition at line 375 of file Plot.h.

virtual casa::ErrorPlot::~ErrorPlot ( )
inlinevirtual

Definition at line 377 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
inlinevirtual

Overrides ScatterPlot::pointData().

Implements casa::ScatterPlot.

Definition at line 381 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)
inlinevirtual

Convenience methods for setting error line.

Definition at line 405 of file Plot.h.

References casacore::CountedPtr< T >::null(), setErrorLine(), and setErrorLineShown().

virtual void casa::ErrorPlot::setErrorLine ( const casacore::String color,
PlotLine::Style  style = PlotLine::SOLID,
double  width = 1.0 
)
inlinevirtual

Definition at line 409 of file Plot.h.

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

virtual void casa::ErrorPlot::setErrorLineColor ( const casacore::String color)
inlinevirtual

Definition at line 418 of file Plot.h.

References errorLine(), casa::Plot::line(), 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)
inlinevirtual

Definition at line 423 of file Plot.h.

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

virtual void casa::ErrorPlot::setErrorLineWidth ( double  width)
inlinevirtual

Definition at line 428 of file Plot.h.

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


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