casa::WedgeDD Class Reference

A DisplayData to draw color wedges. More...

#include <WedgeDD.h>

Inheritance diagram for casa::WedgeDD:

Public Member Functions
	WedgeDD (DisplayData *image)
virtual	~WedgeDD ()
	Destructor.
virtual void	setup ()
	Constructor help function, creates coordinatesystem and fills data Matrix.
virtual void	updateCsys ()
	The coordinate sydtem needs to be update when the data range changes.
virtual Bool	labelAxes (const WCRefreshEvent &ev)
	Axis labeller, 5th step in the WCHolder refresh cycle.
virtual Bool	canLabelAxes () const
bool	isDisplayable () const
virtual const Unit	dataUnit () const
	Return the data unit.
const IPosition	dataShape () const
uInt	dataDim () const
std::vector< int >	displayAxes () const
virtual String	showValue (const Vector< Double > &world)
	Format the wedge value at the given world position.
virtual void	setDefaultOptions ()
	Install the default options for this DisplayData.
virtual Bool	setOptions (Record &rec, Record &recOut)
	Apply options stored in `rec` to the DisplayData.
virtual Record	getOptions (bool scrub=false) const
	Retrieve the current and default options and parameter types.
virtual Display::DisplayDataType	classType ()
	Return the type of this DisplayData.
String	dataType () const
	Pure virtual function from DisplayData.
virtual CachingDisplayMethod *	newDisplayMethod (WorldCanvas worldCanvas, AttributeBuffer wchAttributes, AttributeBuffer ddAttributes, CachingDisplayData dd)
	Create a new AxesDisplayMethod for drawing on the given WorldCanvas when the AttributeBuffers are suitably matched to the current state of this DisplayData and of the WorldCanvas/Holder.
virtual AttributeBuffer	optionsAsAttributes ()
	Return the current options of this DisplayData as an AttributeBuffer.
virtual void	notifyUnregister (WorldCanvasHolder &wcHolder, Bool ignoreRefresh=False)
	Take actions on removal from WC[H] (notably, deletion of drawlists).
std::string	errorMessage () const
Static Public Attributes
static const String	WEDGE_PREFIX
Private Member Functions
	WedgeDD (const WedgeDD &other)
	(Required) copy constructor.
void	operator= (const WedgeDD &other)
	(Required) copy assignment.
Private Attributes
Float	itsMin
	Data minimum and maximum to set up the coordinate system.
Float	itsMax
uInt	itsLength
	the length of the Vector
String	itsDataUnit
	the unit of the input data
Float	itsPowerCycles
	the power law adjustment for for the scle handler
WCPowerScaleHandler *	itsPowerScaleHandler
String	itsOptionsMode
WCCSNLAxisLabeller	itsAxisLabeller
	the axis labeller
Matrix< Float >	itsColorbar
	The actual colorbar data.
DisplayCoordinateSystem	itsCoordinateSystem
	the local coordinate system - gets exported to the parent DD
DlHandle< DisplayData >	ihandle_
Friends
class	WedgeDM

Detailed Description

A DisplayData to draw color wedges.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

DisplayData CachingDisplayData

Etymology

Synopsis

This DisplayData can be created by itself. It's main task though is to set up a coordinate system form the data range and units of another DisplayData. The user can control this through options in this DisplayData: "datamin", "datamax, "dataunit" and "powercycles.

Example

Motivation

Users want wedges

Definition at line 81 of file WedgeDD.h.

Constructor & Destructor Documentation

casa::WedgeDD::WedgeDD ( DisplayData * image )

virtual casa::WedgeDD::~WedgeDD ( ) [virtual]

Destructor.

casa::WedgeDD::WedgeDD ( const WedgeDD & other ) [private]

(Required) copy constructor.

Member Function Documentation

virtual Bool casa::WedgeDD::canLabelAxes ( ) const [virtual]

Reimplemented from casa::DisplayData.

virtual Display::DisplayDataType casa::WedgeDD::classType ( ) [inline, virtual]

Return the type of this DisplayData.

Implements casa::DisplayData.

Definition at line 129 of file WedgeDD.h.

References casa::Display::Raster.

uInt casa::WedgeDD::dataDim ( ) const [inline, virtual]

Implements casa::DisplayData.

Definition at line 106 of file WedgeDD.h.

const IPosition casa::WedgeDD::dataShape ( ) const [inline, virtual]

Implements casa::DisplayData.

Definition at line 103 of file WedgeDD.h.

String casa::WedgeDD::dataType ( ) const [inline, virtual]

Pure virtual function from DisplayData.

.\.

Implements casa::DisplayData.

Definition at line 133 of file WedgeDD.h.

virtual const Unit casa::WedgeDD::dataUnit ( ) const [virtual]

Return the data unit.

Implements casa::DisplayData.

std::vector<int> casa::WedgeDD::displayAxes ( ) const [inline, virtual]

Implements casa::DisplayData.

Definition at line 109 of file WedgeDD.h.

std::string casa::WedgeDD::errorMessage ( ) const [inline, virtual]

Implements casa::DisplayData.

Definition at line 157 of file WedgeDD.h.

virtual Record casa::WedgeDD::getOptions ( bool scrub = false ) const [virtual]

Retrieve the current and default options and parameter types.

Reimplemented from casa::ActiveCaching2dDD.

bool casa::WedgeDD::isDisplayable ( ) const [virtual]

Reimplemented from casa::DisplayData.

virtual Bool casa::WedgeDD::labelAxes ( const WCRefreshEvent & ev ) [virtual]

Axis labeller, 5th step in the WCHolder refresh cycle.

Reimplemented from casa::DisplayData.

virtual CachingDisplayMethod* casa::WedgeDD::newDisplayMethod	(	WorldCanvas *	worldCanvas,
		AttributeBuffer *	wchAttributes,
		AttributeBuffer *	ddAttributes,
		CachingDisplayData *	dd
	)			`[virtual]`

Create a new AxesDisplayMethod for drawing on the given WorldCanvas when the AttributeBuffers are suitably matched to the current state of this DisplayData and of the WorldCanvas/Holder.

The tag is a unique number used to identify the age of the newly constructed CachingDisplayMethod.

virtual void casa::WedgeDD::notifyUnregister	(	WorldCanvasHolder &	wcHolder,
		Bool	ignoreRefresh = `False`
	)			`[virtual]`

Take actions on removal from WC[H] (notably, deletion of drawlists).

Reimplemented from casa::CachingDisplayData.

void casa::WedgeDD::operator= ( const WedgeDD & other ) [private]

(Required) copy assignment.

Reimplemented from casa::ActiveCaching2dDD.

virtual AttributeBuffer casa::WedgeDD::optionsAsAttributes ( ) [virtual]

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::ActiveCaching2dDD.

virtual void casa::WedgeDD::setDefaultOptions ( ) [virtual]

Install the default options for this DisplayData.

Reimplemented from casa::ActiveCaching2dDD.

virtual Bool casa::WedgeDD::setOptions	(	Record &	rec,
		Record &	recOut
	)			`[virtual]`

Apply options stored in rec to the DisplayData.

A return value of True means a refresh is needed. recOut contains any fields which were implicitly changed as a result of the call to this function.

Reimplemented from casa::ActiveCaching2dDD.

virtual void casa::WedgeDD::setup ( ) [virtual]

Constructor help function, creates coordinatesystem and fills data Matrix.

virtual String casa::WedgeDD::showValue ( const Vector< Double > & world ) [virtual]

Format the wedge value at the given world position.

Implements casa::DisplayData.

virtual void casa::WedgeDD::updateCsys ( ) [virtual]

The coordinate sydtem needs to be update when the data range changes.