casa::MaskedScatterPlot Class Reference

Subclass of ScatterPlot that adds masking functionality. More...

#include <Plot.h>

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

List of all members.

Public Member Functions

 MaskedScatterPlot ()
virtual ~MaskedScatterPlot ()
virtual PlotPointDataPtr pointData () const
 Overrides ScatterPlot::pointData().
virtual bool maskedAt (unsigned int index) const
 Returns whether the data at the given index is masked or not.
virtual PlotMaskedPointDataPtr maskedData () const =0
 ABSTRACT METHODS //.
virtual void clearData ()=0
virtual bool maskedLinesShown () const =0
 Returns true if this plot has lines shown for masked points, false otherwise.
virtual void setMaskedLinesShown (bool linesShown=true)=0
 Sets whether or not lines are shown for masked points.
virtual PlotLinePtr maskedLine () const =0
 Returns a copy of the line used for masked points.
virtual void setMaskedLine (const PlotLine &line)=0
 Sets the lines for masked points to the given.
virtual void setMaskedLine (const PlotLinePtr line)
 Convenience methods for setting line for masked points.
virtual void setMaskedLine (const String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
virtual void setMaskedLineColor (const String &color)
virtual void setMaskedLineStyle (PlotLine::Style style)
virtual void setMaskedLineWidth (double width)
virtual bool maskedSymbolsShown () const =0
 Returns true if symbols are shown for masked points, false otherwise.
virtual void setMaskedSymbolsShown (bool symbolsShown=true)=0
 Sets whether symbols are shown or not for masked points.
virtual PlotSymbolPtr maskedSymbol () const =0
 Returns a copy of the symbol for masked points.
virtual void setMaskedSymbol (const PlotSymbol &symbol)=0
 Sets the symbols for masked points to the given.
virtual void setMaskedSymbol (const PlotSymbolPtr symbol)
 Convenience methods for setting symbol for masked points.
virtual void setMaskedSymbol (PlotSymbol::Symbol s)
virtual void setMaskedSymbol (char s)
virtual void setMaskedSymbolSize (double width, double height)
virtual void setMaskedSymbolLine (const PlotLine &line)
virtual void setMaskedSymbolLine (const PlotLinePtr line)
virtual void setMaskedSymbolLine (const String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
virtual void setMaskedSymbolAreaFill (const PlotAreaFill &fill)
virtual void setMaskedSymbolAreaFill (const PlotAreaFillPtr fill)
virtual void setMaskedSymbolAreaFill (const String &color, PlotAreaFill::Pattern pattern=PlotAreaFill::FILL)

Detailed Description

Subclass of ScatterPlot that adds masking functionality.

The ScatterPlot customization methods (lines, symbols, etc.) are expected to apply only to unmasked data, while additional methods are provided in MaskedScatterPlot to customize the masked data (which is not shown by default).

Definition at line 219 of file Plot.h.


Constructor & Destructor Documentation

casa::MaskedScatterPlot::MaskedScatterPlot (  )  [inline]

Definition at line 221 of file Plot.h.

virtual casa::MaskedScatterPlot::~MaskedScatterPlot (  )  [inline, virtual]

Definition at line 223 of file Plot.h.


Member Function Documentation

virtual void casa::MaskedScatterPlot::clearData (  )  [pure virtual]
virtual bool casa::MaskedScatterPlot::maskedAt ( unsigned int  index  )  const [inline, virtual]

Returns whether the data at the given index is masked or not.

Just a thin layer over the PlotMaskedPointData functionality.

Definition at line 231 of file Plot.h.

References casa::ScatterPlot::data(), and maskedData().

virtual PlotMaskedPointDataPtr casa::MaskedScatterPlot::maskedData (  )  const [pure virtual]

ABSTRACT METHODS //.

Returns the masked data used for this plot.

Referenced by maskedAt(), and pointData().

virtual PlotLinePtr casa::MaskedScatterPlot::maskedLine (  )  const [pure virtual]

Returns a copy of the line used for masked points.

Note: if lines are not shown, then this behavior is undefined. The last shown line can be returned, or a line with style NOLINE, or a null pointer, or...\.

Referenced by setMaskedLine(), setMaskedLineColor(), setMaskedLineStyle(), and setMaskedLineWidth().

virtual bool casa::MaskedScatterPlot::maskedLinesShown (  )  const [pure virtual]

Returns true if this plot has lines shown for masked points, false otherwise.

virtual PlotSymbolPtr casa::MaskedScatterPlot::maskedSymbol (  )  const [pure virtual]

Returns a copy of the symbol for masked points.

Note: if symbols are not shown, then this behavior is undefined. The last shown symbol can be returned, or a symbol with style NOSYMBOL, or a null pointer, or...\.

Referenced by setMaskedSymbol(), setMaskedSymbolAreaFill(), setMaskedSymbolLine(), and setMaskedSymbolSize().

virtual bool casa::MaskedScatterPlot::maskedSymbolsShown (  )  const [pure virtual]

Returns true if symbols are shown for masked points, false otherwise.

virtual PlotPointDataPtr casa::MaskedScatterPlot::pointData (  )  const [inline, virtual]

Overrides ScatterPlot::pointData().

Implements casa::ScatterPlot.

Definition at line 227 of file Plot.h.

References maskedData().

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

Definition at line 268 of file Plot.h.

References maskedLine(), and setMaskedLine().

virtual void casa::MaskedScatterPlot::setMaskedLine ( const PlotLinePtr  line  )  [inline, virtual]

Convenience methods for setting line for masked points.

Definition at line 264 of file Plot.h.

References setMaskedLine(), and setMaskedLinesShown().

virtual void casa::MaskedScatterPlot::setMaskedLine ( const PlotLine line  )  [pure virtual]

Sets the lines for masked points to the given.

Implies setMaskedLinesShown(true) unless the given line's style is set to NOLINE.

Referenced by setMaskedLine(), setMaskedLineColor(), setMaskedLineStyle(), and setMaskedLineWidth().

virtual void casa::MaskedScatterPlot::setMaskedLineColor ( const String &  color  )  [inline, virtual]

Definition at line 277 of file Plot.h.

References maskedLine(), and setMaskedLine().

virtual void casa::MaskedScatterPlot::setMaskedLinesShown ( bool  linesShown = true  )  [pure virtual]

Sets whether or not lines are shown for masked points.

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

Referenced by setMaskedLine().

virtual void casa::MaskedScatterPlot::setMaskedLineStyle ( PlotLine::Style  style  )  [inline, virtual]

Definition at line 282 of file Plot.h.

References maskedLine(), and setMaskedLine().

virtual void casa::MaskedScatterPlot::setMaskedLineWidth ( double  width  )  [inline, virtual]

Definition at line 287 of file Plot.h.

References maskedLine(), and setMaskedLine().

virtual void casa::MaskedScatterPlot::setMaskedSymbol ( char  s  )  [inline, virtual]

Definition at line 323 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

virtual void casa::MaskedScatterPlot::setMaskedSymbol ( PlotSymbol::Symbol  s  )  [inline, virtual]

Definition at line 318 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

virtual void casa::MaskedScatterPlot::setMaskedSymbol ( const PlotSymbolPtr  symbol  )  [inline, virtual]

Convenience methods for setting symbol for masked points.

Definition at line 314 of file Plot.h.

References setMaskedSymbol(), and setMaskedSymbolsShown().

virtual void casa::MaskedScatterPlot::setMaskedSymbol ( const PlotSymbol symbol  )  [pure virtual]

Sets the symbols for masked points to the given.

Implies setMaskedSymbolsShown(true) unless the symbol's style is set to NOSYMBOL.

Referenced by setMaskedSymbol(), setMaskedSymbolAreaFill(), setMaskedSymbolLine(), and setMaskedSymbolSize().

virtual void casa::MaskedScatterPlot::setMaskedSymbolAreaFill ( const String &  color,
PlotAreaFill::Pattern  pattern = PlotAreaFill::FILL 
) [inline, virtual]

Definition at line 353 of file Plot.h.

References maskedSymbol(), casacore::pattern(), and setMaskedSymbol().

virtual void casa::MaskedScatterPlot::setMaskedSymbolAreaFill ( const PlotAreaFillPtr  fill  )  [inline, virtual]

Definition at line 351 of file Plot.h.

References setMaskedSymbolAreaFill().

virtual void casa::MaskedScatterPlot::setMaskedSymbolAreaFill ( const PlotAreaFill fill  )  [inline, virtual]

Definition at line 346 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

Referenced by setMaskedSymbolAreaFill().

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

Definition at line 340 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

virtual void casa::MaskedScatterPlot::setMaskedSymbolLine ( const PlotLinePtr  line  )  [inline, virtual]

Definition at line 338 of file Plot.h.

References setMaskedSymbolLine().

virtual void casa::MaskedScatterPlot::setMaskedSymbolLine ( const PlotLine line  )  [inline, virtual]

Definition at line 333 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

Referenced by setMaskedSymbolLine().

virtual void casa::MaskedScatterPlot::setMaskedSymbolSize ( double  width,
double  height 
) [inline, virtual]

Definition at line 328 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

virtual void casa::MaskedScatterPlot::setMaskedSymbolsShown ( bool  symbolsShown = true  )  [pure virtual]

Sets whether symbols are shown or not for masked points.

If symbolsShown is true, the implementation can decide whether to choose the symbol shown, or just use the last set PlotSymbol.

Referenced by setMaskedSymbol().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1