casa::Histogram2dDD Class Reference

A DisplayData to draw histograms. More...

#include <Histogram2dDD.h>

Inheritance diagram for casa::Histogram2dDD:

Public Member Functions
	Histogram2dDD (const ImageInterface< Float > *image)
	Constructor taking a pointer to an already constructed ImageInterface.
virtual	~Histogram2dDD ()
	Constructor taking a pointer to an already constructed Table, and a String indicating a column name.
virtual const Unit	dataUnit ()
	Return the data unit.
virtual String	showValue (const Vector< Double > &world)
	Format the histogram 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.
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.
const Lattice< Float > &	lattice () const
	Provide read-only access to the Lattice.
const MaskedLattice< Float > &	maskedLattice () const
	Provide read-only access to the MaskedLattce.
Protected Member Functions
	Histogram2dDD ()
	(Required) default constructor.
	Histogram2dDD (const Histogram2dDD &other)
	(Required) copy constructor.
void	operator= (const Histogram2dDD &other)
	(Required) copy assignment.
Private Attributes
ImageInterface< Float > *	itsBaseImage
	The base image cloned at construction.
MaskedLattice< Float > *	itsMaskedLattice
	The masked lattice, effectively referencing one of itsBaseImage,
LatticeStatistics< Float > *	itsLatticeStatistics
	Object to use for calculating statistics.
LatticeHistograms< Float > *	itsLatticeHistograms
	Object ot use for calculating histograms.
Friends
class	Histogram2dDM

Detailed Description

A DisplayData to draw histograms.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Definition at line 64 of file Histogram2dDD.h.

Constructor & Destructor Documentation

casa::Histogram2dDD::Histogram2dDD ( const ImageInterface< Float > * image )

Constructor taking a pointer to an already constructed ImageInterface.

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

Constructor taking a pointer to an already constructed Table, and a String indicating a column name.

Histogram2dDD(const Table *table, const String column);

Constructor taking a pointer to an Array. Histogram2dDD(const Array<Float> *array);

Destructor.

casa::Histogram2dDD::Histogram2dDD ( ) [protected]

(Required) default constructor.

casa::Histogram2dDD::Histogram2dDD ( const Histogram2dDD & other ) [protected]

(Required) copy constructor.

Member Function Documentation

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

Return the type of this DisplayData.

Implements casa::DisplayData.

Definition at line 101 of file Histogram2dDD.h.

References casa::Display::CanvasAnnotation.

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

Return the data unit.

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

Retrieve the current and default options and parameter types.

Reimplemented from casa::ActiveCaching2dDD.

const Lattice<Float>& casa::Histogram2dDD::lattice ( ) const [inline]

Provide read-only access to the Lattice.

Definition at line 120 of file Histogram2dDD.h.

References itsMaskedLattice.

const MaskedLattice<Float>& casa::Histogram2dDD::maskedLattice ( ) const [inline]

Provide read-only access to the MaskedLattce.

Definition at line 125 of file Histogram2dDD.h.

References itsMaskedLattice.

virtual CachingDisplayMethod* casa::Histogram2dDD::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.

void casa::Histogram2dDD::operator= ( const Histogram2dDD & other ) [protected]

(Required) copy assignment.

Reimplemented from casa::ActiveCaching2dDD.

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

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::ActiveCaching2dDD.

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

Install the default options for this DisplayData.

Reimplemented from casa::ActiveCaching2dDD.

virtual Bool casa::Histogram2dDD::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 String casa::Histogram2dDD::showValue ( const Vector< Double > & world ) [virtual]

Format the histogram value at the given world position.

Implements casa::DisplayData.