Histogram2dDD.h

Classes

Histogram2dDD -- A DisplayData to draw histograms (full description)

class Histogram2dDD : public ActiveCaching2dDD

Interface

Public Members
Histogram2dDD(const ImageInterface<Float> *image)
virtual ~Histogram2dDD()
virtual const Unit dataUnit()
virtual String showValue(const Vector<Double> &world)
virtual void setDefaultOptions()
virtual Bool setOptions(Record &rec, Record &recOut)
virtual Record getOptions()
virtual Display::DisplayDataType classType()
virtual CachingDisplayMethod *newDisplayMethod(WorldCanvas *worldCanvas, AttributeBuffer *wchAttributes, AttributeBuffer *ddAttributes, CachingDisplayData *dd)
virtual AttributeBuffer optionsAsAttributes()
const Lattice<Float> &lattice() const
const MaskedLattice<Float> &maskedLattice() const
Protected Members
Histogram2dDD()
Histogram2dDD(const Histogram2dDD &other)
void operator=(const Histogram2dDD &other)

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Member Description

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. Histogram2dDD(const Table *table, const String column);

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

Destructor.

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

virtual Record getOptions()

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. The tag is a unique number used to identify the age of the newly constructed CachingDisplayMethod.

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.

Histogram2dDD()

(Required) default constructor.

Histogram2dDD(const Histogram2dDD &other)

(Required) copy constructor.

void operator=(const Histogram2dDD &other)

(Required) copy assignment.