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

#include <Plot.h>

Inheritance diagram for casa::MaskedScatterPlot:

Public Member Functions
	MaskedScatterPlot ()

virtual	~MaskedScatterPlot ()

virtual PlotPointDataPtr	pointData () const
	Overrides ScatterPlot::pointData(). More...

virtual bool	maskedAt (unsigned int index) const
	Returns whether the data at the given index is masked or not. More...

virtual PlotMaskedPointDataPtr	maskedData () const =0
	ABSTRACT METHODS //. More...

virtual void	clearData ()=0

virtual bool	maskedLinesShown () const =0
	Returns true if this plot has lines shown for masked points, false otherwise. More...

virtual void	setMaskedLinesShown (bool linesShown=true)=0
	Sets whether or not lines are shown for masked points. More...

virtual PlotLinePtr	maskedLine () const =0
	Returns a copy of the line used for masked points. More...

virtual void	setMaskedLine (const PlotLine &line)=0
	Sets the lines for masked points to the given. More...

virtual void	setMaskedLine (const PlotLinePtr line)
	Convenience methods for setting line for masked points. More...

virtual void	setMaskedLine (const casacore::String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)

virtual void	setMaskedLineColor (const casacore::String &color)

virtual void	setMaskedLineStyle (PlotLine::Style style)

virtual void	setMaskedLineWidth (double width)

virtual bool	maskedLinesStep () const =0
	Get/set connect masked points in step rather than line. More...

virtual void	setMaskedLinesStep (bool linesStep=true)=0

virtual bool	maskedSymbolsShown () const =0
	Returns true if symbols are shown for masked points, false otherwise. More...

virtual void	setMaskedSymbolsShown (bool symbolsShown=true)=0
	Sets whether symbols are shown or not for masked points. More...

virtual PlotSymbolPtr	maskedSymbol () const =0
	Returns a copy of the symbol for masked points. More...

virtual void	setMaskedSymbol (const PlotSymbol &symbol)=0
	Sets the symbols for masked points to the given. More...

virtual void	setMaskedSymbol (const PlotSymbolPtr symbol)
	Convenience methods for setting symbol for masked points. More...

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 casacore::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 casacore::String &color, PlotAreaFill::Pattern pattern=PlotAreaFill::FILL)

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 PlotCanvas *	canvas () 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

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 223 of file Plot.h.

Constructor & Destructor Documentation

casa::MaskedScatterPlot::MaskedScatterPlot ( )

inline

Definition at line 225 of file Plot.h.

virtual casa::MaskedScatterPlot::~MaskedScatterPlot ( )

inlinevirtual

Definition at line 227 of file Plot.h.

Member Function Documentation

virtual void casa::MaskedScatterPlot::clearData ( )

pure virtual

virtual bool casa::MaskedScatterPlot::maskedAt ( unsigned int index ) const

inlinevirtual

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

Just a thin layer over the PlotMaskedPointData functionality.

Definition at line 235 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 bool casa::MaskedScatterPlot::maskedLinesStep ( ) const

pure virtual

Get/set connect masked points in step rather than line.

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

inlinevirtual

Overrides ScatterPlot::pointData().

Implements casa::ScatterPlot.

Definition at line 231 of file Plot.h.

References maskedData().

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::setMaskedLine ( const PlotLinePtr line )

inlinevirtual

Convenience methods for setting line for masked points.

Definition at line 268 of file Plot.h.

References casacore::CountedPtr< T >::null(), setMaskedLine(), and setMaskedLinesShown().

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

inlinevirtual

Definition at line 272 of file Plot.h.

References maskedLine(), and setMaskedLine().

virtual void casa::MaskedScatterPlot::setMaskedLineColor ( const casacore::String & color )

inlinevirtual

Definition at line 281 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::setMaskedLinesStep ( bool linesStep = true )

pure virtual

virtual void casa::MaskedScatterPlot::setMaskedLineStyle ( PlotLine::Style style )

inlinevirtual

Definition at line 286 of file Plot.h.

References maskedLine(), and setMaskedLine().

virtual void casa::MaskedScatterPlot::setMaskedLineWidth ( double width )

inlinevirtual

Definition at line 291 of file Plot.h.

References maskedLine(), and setMaskedLine().

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::setMaskedSymbol ( const PlotSymbolPtr symbol )

inlinevirtual

Convenience methods for setting symbol for masked points.

Definition at line 322 of file Plot.h.

References casacore::CountedPtr< T >::null(), setMaskedSymbol(), and setMaskedSymbolsShown().

virtual void casa::MaskedScatterPlot::setMaskedSymbol ( PlotSymbol::Symbol s )

inlinevirtual

Definition at line 326 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

virtual void casa::MaskedScatterPlot::setMaskedSymbol ( char s )

inlinevirtual

Definition at line 331 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

virtual void casa::MaskedScatterPlot::setMaskedSymbolAreaFill ( const PlotAreaFill & fill )

inlinevirtual

Definition at line 354 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

Referenced by setMaskedSymbolAreaFill().

virtual void casa::MaskedScatterPlot::setMaskedSymbolAreaFill ( const PlotAreaFillPtr fill )

inlinevirtual

Definition at line 359 of file Plot.h.

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

virtual void casa::MaskedScatterPlot::setMaskedSymbolAreaFill	(	const casacore::String &	color,
		PlotAreaFill::Pattern	pattern = `PlotAreaFill::FILL`
	)

inlinevirtual

Definition at line 361 of file Plot.h.

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

virtual void casa::MaskedScatterPlot::setMaskedSymbolLine ( const PlotLine & line )

inlinevirtual

Definition at line 341 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

Referenced by setMaskedSymbolLine().

virtual void casa::MaskedScatterPlot::setMaskedSymbolLine ( const PlotLinePtr line )

inlinevirtual

Definition at line 346 of file Plot.h.

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

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

inlinevirtual

Definition at line 348 of file Plot.h.

References maskedSymbol(), and setMaskedSymbol().

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

inlinevirtual

Definition at line 336 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:

casa/code/graphics/GenericPlotter/Plot.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation