casa::Histogram2dDD Class Reference
[DisplayDatas]

#include <Histogram2dDD.h>

Inheritance diagram for casa::Histogram2dDD:

Inheritance graph
[legend]
Collaboration diagram for casa::Histogram2dDD:

Collaboration graph
[legend]
List of all members.

Detailed Description

A DisplayData to draw histograms.

Intended use:

Part of API

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Definition at line 64 of file Histogram2dDD.h.

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 ()
 Retrieve the current and default options and parameter types.
virtual Display::DisplayDataType classType ()
 Return the type of this DisplayData.
virtual CachingDisplayMethodnewDisplayMethod (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


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 const Unit casa::Histogram2dDD::dataUnit (  )  [virtual]

Return the data unit.

Implements casa::DisplayData.

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

Format the histogram value at the given world position.

Implements casa::DisplayData.

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 Record casa::Histogram2dDD::getOptions (  )  [virtual]

Retrieve the current and default options and parameter types.

Reimplemented from casa::ActiveCaching2dDD.

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 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.

Implements casa::CachingDisplayData.

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

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::ActiveCaching2dDD.

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

Provide read-only access to the Lattice.

Definition at line 119 of file Histogram2dDD.h.

References itsMaskedLattice.

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

Provide read-only access to the MaskedLattce.

Definition at line 123 of file Histogram2dDD.h.

References itsMaskedLattice.

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

(Required) copy assignment.


Friends And Related Function Documentation

friend class Histogram2dDM [friend]

Definition at line 139 of file Histogram2dDD.h.


Member Data Documentation

ImageInterface<Float>* casa::Histogram2dDD::itsBaseImage [private]

The base image cloned at construction.

Definition at line 142 of file Histogram2dDD.h.

MaskedLattice<Float>* casa::Histogram2dDD::itsMaskedLattice [private]

The masked lattice, effectively referencing one of itsBaseImage,

\..

Definition at line 146 of file Histogram2dDD.h.

Referenced by lattice(), and maskedLattice().

LatticeStatistics<Float>* casa::Histogram2dDD::itsLatticeStatistics [private]

Object to use for calculating statistics.

Definition at line 149 of file Histogram2dDD.h.

LatticeHistograms<Float>* casa::Histogram2dDD::itsLatticeHistograms [private]

Object ot use for calculating histograms.

Definition at line 152 of file Histogram2dDD.h.


The documentation for this class was generated from the following file:
Generated on Tue Aug 26 22:36:48 2008 for NRAOCASA by  doxygen 1.5.1