A DisplayData to draw histograms. More...

#include <Histogram2dDD.h>

Inheritance diagram for casa::Histogram2dDD:

Public Member Functions
	Histogram2dDD (const casacore::ImageInterface< casacore::Float > *image)
	Constructor taking a pointer to an already constructed ImageInterface. More...

virtual	~Histogram2dDD ()
	Constructor taking a pointer to an already constructed casacore::Table, and a casacore::String indicating a column name. More...

virtual const casacore::Unit	dataUnit ()
	Return the data unit. More...

virtual casacore::String	showValue (const casacore::Vector< casacore::Double > &world)
	casacore::Format the histogram value at the given world position. More...

virtual void	setDefaultOptions ()
	Install the default options for this DisplayData. More...

virtual casacore::Bool	setOptions (casacore::Record &rec, casacore::Record &recOut)
	Apply options stored in `rec` to the DisplayData. More...

virtual casacore::Record	getOptions (bool scrub=false) const
	Retrieve the current and default options and parameter types. More...

virtual Display::DisplayDataType	classType ()
	Return the type of this DisplayData. More...

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

virtual AttributeBuffer	optionsAsAttributes ()
	Return the current options of this DisplayData as an AttributeBuffer. More...

const casacore::Lattice < casacore::Float > &	lattice () const
	Provide read-only access to the Lattice. More...

const casacore::MaskedLattice < casacore::Float > &	maskedLattice () const
	Provide read-only access to the MaskedLattce. More...

Public Member Functions inherited from casa::ActiveCaching2dDD
	ActiveCaching2dDD (const DisplayCoordinateSystem &coordsys, const casacore::Vector< casacore::Double > &pixblc, const casacore::Vector< casacore::Double > &pixtrc)
	Constructor. More...

virtual	~ActiveCaching2dDD ()
	Destructor. More...

virtual casacore::Bool	linToWorld (casacore::Vector< casacore::Double > &world, const casacore::Vector< casacore::Double > &lin)
	casacore::Coordinate transformation handlers, called by WorldCanvasHolder. More...

virtual casacore::Bool	worldToLin (casacore::Vector< casacore::Double > &lin, const casacore::Vector< casacore::Double > &world)

virtual casacore::String	showPosition (const casacore::Vector< casacore::Double > &world, const casacore::Bool &displayAxesOnly=false)
	casacore::Format a string containing coordinate information at the given world coordinate. More...

virtual casacore::Vector < casacore::String >	worldAxisNames () const
	World axis information suppliers. More...

virtual casacore::Vector < casacore::String >	worldAxisUnits () const

virtual casacore::uInt	nelements (const WorldCanvasHolder &) const
	Return the number of display elements (ie. More...

virtual casacore::uInt	nelements () const
	and non-specific More...

virtual casacore::Bool	sizeControl (WorldCanvasHolder &wcHolder, AttributeBuffer &holderBuf)
	Negotiatiate WorldCanvas linear coordinate system when asked to do so by the WorldCanvasHolder. More...

virtual casacore::Bool	conformsToCS (const WorldCanvas &wc)
	Determine whether DD can draw on the current coordinate system of the given WC[H]. More...

virtual void	cleanup ()
	Tidy up the elements of this DisplayData. More...

Public Member Functions inherited from casa::CachingDisplayData
	CachingDisplayData ()
	Constructor. More...

virtual	~CachingDisplayData ()
	Destructor. More...

virtual void	refreshEH (const WCRefreshEvent &ev)
	Refresh event handler which is called indirectly by the WorldCanvas, via the WorldCanvasHolder. More...

virtual void	notifyRegister (WorldCanvasHolder *wcHolder)

virtual void	notifyUnregister (WorldCanvasHolder &wcHolder, casacore::Bool ignoreRefresh=false)
	`ignoreRefresh` tells the DD not to refresh just to clean up DMs More...

virtual void	setColormap (Colormap *cmap, casacore::Float weight)
	Purges cache, to avoid reusing images with the wrong colormap, then calls base class version. More...

virtual void	purgeCache ()
	Empty cache completely. More...

virtual void	purgeCache (const WorldCanvasHolder &wch)
	Empty cache of all DMs for a given WCH. More...

Public Member Functions inherited from casa::DisplayData
	DisplayData ()
	(Required) default constructor. More...

virtual	~DisplayData ()
	required destructor More...

virtual std::string	errorMessage () const =0

virtual void	setDisplayState (DisplayState s)

virtual DisplayState	getDisplayState () const

virtual bool	isDisplayable () const

virtual void	addRestrictions (AttributeBuffer &otherBuf)
	Add general restrictions or a restriction for item `itemNum` of this DisplayData. More...

virtual void	addRestriction (Attribute &newRestriction, casacore::Bool permanent)

virtual void	addElementRestrictions (const casacore::uInt itemNum, AttributeBuffer &other)

virtual void	addElementRestriction (const casacore::uInt itemNum, Attribute &newRestriction, casacore::Bool permanent)

virtual void	setRestrictions (AttributeBuffer &otherBuf)
	Set general restrictions or a restriction for item `itemNum` of this DisplayData. More...

virtual void	setRestriction (Attribute &newRestriction)

virtual void	setElementRestrictions (const casacore::uInt itemNum, AttributeBuffer &other)

virtual void	setElementRestriction (const casacore::uInt itemNum, Attribute &newRestriction)

virtual void	removeRestriction (const casacore::String &name)
	Remove a general restriction or a restriction from item `itemNum` More...

virtual void	removeElementRestriction (const casacore::uInt itemNum, const casacore::String &name)

virtual void	clearRestrictions ()
	Clear all general restrictions or all restrictions of item `itemNum` (except the ones that are permanent of course...) More...

virtual void	clearElementRestrictions (const casacore::uInt itemNum)

virtual casacore::Bool	existRestriction (const casacore::String &name)
	Check if a general restriction or a restriction for item `itemNum` with name `name` exists. More...

virtual casacore::Bool	existElementRestriction (const casacore::uInt itemNum, const casacore::String &name)

virtual AttributeBuffer *	restrictionBuffer ()
	Get a handle to the buffer of general restrictions or of the buffer of restrictions for item `itemNum` More...

virtual AttributeBuffer *	elementRestrictionBuffer (const casacore::uInt itemNum)

virtual casacore::Bool	conformsTo (const WorldCanvas *wCanvas)
	Check whether the DD is is compatible with all WC[H] state, including its coordinate state, restrictions, and zIndex (if any). More...

virtual casacore::Bool	conformsTo (const WorldCanvas &wc)

virtual casacore::Bool	conformsToRstrs (const WorldCanvas &wc)
	Determine whether DD restrictions are in conformance with restrictions on the given WCH. More...

virtual casacore::Bool	conformsToZIndex (const WorldCanvas &wc)
	Determine whether DD is compatible with the current canvas animation (zIndex) position. More...

virtual casacore::Int	activeZIndex (const WorldCanvas *wc=0)
	Retrieve 'Active' zIndex. More...

virtual casacore::Bool	getFirstZIndex (int &firstZIndex, casacore::Int axZrng=-1) const
	Set firstZIndex to minimum zIndex setting from all canvases where this DD is registered. More...

virtual void	addPositionEventHandler (WCPositionEH *positionHandler)
	Add event handlers on the DisplayData. More...

virtual void	addMotionEventHandler (WCMotionEH *motionHandler)

virtual void	addRefreshEventHandler (WCRefreshEH *refreshHandler)

virtual void	addDisplayEventHandler (DisplayEH *displayHandler)

virtual void	removePositionEventHandler (WCPositionEH &positionHandler)
	Remove eventhandlers. More...

virtual void	removeMotionEventHandler (WCMotionEH &motionHandler)

virtual void	removeRefreshEventHandler (WCRefreshEH &refreshHandler)

virtual void	removeDisplayEventHandler (DisplayEH &displayHandler)

virtual void	removeColormap ()

virtual Colormap *	colormap () const

void	setAttribute (Attribute &at)
	set an Attribute or Attributes More...

void	setAttributes (AttributeBuffer &at)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::uInt &newValue)
	User interface to get value from the attribute buffer. More...

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Int &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Float &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Double &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Bool &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::String &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Vector< casacore::uInt > &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Vector< casacore::Int > &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Vector< casacore::Float > &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Vector< casacore::Double > &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Vector< casacore::Bool > &newValue)

casacore::Bool	getAttributeValue (const casacore::String &name, casacore::Vector< casacore::String > &newValue)

casacore::Bool	existsAttribute (casacore::String &name)
	Check if a certain Attribute exists. More...

void	removeAttribute (casacore::String &name)
	Remove an Attribute. More...

AttValue::ValueType	attributeType (casacore::String &name)
	Get the type of the Attribute. More...

void	setAttributeOnPrimaryWCHs (Attribute &at)
	Set an attribute on any WorldCanvas for which this DD is CS master. More...

virtual void	removeFromAllWCHs ()
	remove this DD everywhere–will stop any more refresh handling by the DD. More...

virtual void	refresh (casacore::Bool clean=false)
	an explicit refresh: should be called if the DisplayData is changed such that drawing is required. More...

virtual casacore::Bool	labelAxes (const WCRefreshEvent &ev)
	an explicit request to draw the axes and/or labels. More...

virtual casacore::Bool	canLabelAxes () const

virtual casacore::String	className () const
	Return the class name of this DisplayData; useful mostly for debugging purposes, and perhaps future use in the glish widget interface. More...

virtual casacore::String	description () const

virtual casacore::String	dataType () const =0

virtual const casacore::IPosition	dataShape () const =0

virtual casacore::uInt	dataDim () const =0

virtual const casacore::Unit	dataUnit () const =0

virtual std::vector< int >	displayAxes () const =0

virtual ImageAnalysis *	imageanalysis () const
	Get image analyis about images... More...

virtual std::shared_ptr < casacore::ImageInterface < casacore::Float > >	imageinterface ()
	Returns a pointer that should not be deleted... More...

virtual void	setSubstituteTitleText (const casacore::String)

const WorldCanvasHolder *	findHolder (const WorldCanvas *wCanvas) const
	Identify the WorldCanvasHolder for the given WorldCanvas. More...

WorldCanvasHolder *	findHolder (const WorldCanvas *wCanvas)

virtual casacore::Block < casacore::Int >	allZIndices (casacore::Int axZrng=-1) const
	Return a sorted casacore::Block of all animation frame numbers currently set onto all WCHs where this DD is registered. More...

virtual casacore::Bool	zIndexHint (casacore::Int &) const
	Will be called just before registering the [GTk]DD on a [GTk]PanelDisplay which has none registered on it yet. More...

virtual void	handleEvent (DisplayEvent &ev)
	Overide DisplayEH::handleEvent. More...

virtual casacore::Bool	isCSmaster (const WorldCanvasHolder *wch=0) const
	Is this DD the CS master of the passed WCH? Defaulting wch to 0 asks whether this DD is CS master of some WCH on which it is registered. More...

virtual casacore::Int	uiBase () const
	DD 'Absolute Pixel Coordinates', e.g. More...

virtual void	setUIBase (casacore::Int uibase)

virtual casacore::Bool	getDelTmpData ()
	Get and set method for the flag. More...

virtual void	setDelTmpData (casacore::Bool delTmpData)

virtual void	setDisplayDataRed (DisplayData *)

virtual void	setDisplayDataBlue (DisplayData *)

virtual void	setDisplayDataGreen (DisplayData *)

Public Member Functions inherited from casa::DisplayOptions
	DisplayOptions ()
	Constructor. More...

virtual	~DisplayOptions ()
	Destructor. More...

template<class T >
casacore::Bool	readOptionRecord (casacore::Vector< T > &target, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const
	Find the field `fieldname` in casacore::Record `rec`, containing the requested type (casacore::Bool, casacore::String, casacore::Float, casacore::Int) in itself or its "value" sub-field, and return the value in `target`. More...

template<class T >
casacore::Bool	readOptionRecord (T &target, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const

virtual casacore::Bool	readOptionRecord (casacore::String &target, casacore::Bool &unsetTarget, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const
	Find the field `fieldname` in casacore::Record `rec`, containing the requested type (casacore::String) in itself or its "value" sub-field, and return the value in `target`. More...

casacore::Record	unset () const
	Return a casacore::Record which is an "unset" casacore::Record, ie. More...

casacore::Bool	isUnset (const casacore::Record &rec) const
	Return true or false indicating if the provided casacore::Record is equal to an "unset" Record. More...

Public Member Functions inherited from casa::DisplayEH
virtual	~DisplayEH ()

Public Member Functions inherited from casa::DlTarget
	DlTarget ()

	DlTarget (const DlTarget &)

virtual	~DlTarget ()

void	reg (DlHandleBase *p)

void	unreg (DlHandleBase *p)

Protected Member Functions
	Histogram2dDD ()
	(Required) default constructor. More...

	Histogram2dDD (const Histogram2dDD &other)
	(Required) copy constructor. More...

void	operator= (const Histogram2dDD &other)
	(Required) copy assignment. More...

Protected Member Functions inherited from casa::ActiveCaching2dDD
	ActiveCaching2dDD ()
	(Required) default constructor. More...

	ActiveCaching2dDD (const ActiveCaching2dDD &other)
	(Required) copy constructor. More...

void	operator= (const ActiveCaching2dDD &other)
	(Required) copy assignment. More...

void	setCoordinateSystem (const DisplayCoordinateSystem &coordsys, const casacore::Vector< casacore::Double > &pixblc, const casacore::Vector< casacore::Double > &pixtrc)
	Install a DisplayCoordinateSystem and limits. More...

void	identifyWorldAxis (casacore::Coordinate::Type &type, casacore::Int &coordinate, casacore::Int &axisincoord, const casacore::uInt worldaxisnum)
	Identify a specified world axis by its casacore::Coordinate type, number, and axis in that coordinate. More...

casacore::String	codeWorldAxis (const casacore::uInt worldaxisnum)
	Generate a casacore::String code for the specified world axis, describing the coordinate type, number and axis in that coordinate. More...

casacore::Vector < casacore::Double >	worldAxisIncrements () const
	Return the world axis increments. More...

virtual casacore::Bool	worldCoordTracking () const
	Return whether tracking is currently world (T) or pixel (F) coordinates. More...

Protected Member Functions inherited from casa::CachingDisplayData
virtual void	setCaching (const casacore::Bool caching)
	Return any additional Attributes to consider when searching the cache. More...

	CachingDisplayData (const CachingDisplayData &other)
	(Required) copy constructor. More...

void	operator= (const CachingDisplayData &other)
	(Required) copy assignment. More...

Protected Member Functions inherited from casa::DisplayData
virtual casacore::Bool	setActiveZIndex_ (casacore::Int zindex)
	DDs may override to adjust the internal stored current animation index (activeZIndex_) if necessary, and to set return value false iff the passed zindex won't work for the DD. More...

casacore::Bool	conformed ()
	Returns result of last call to conformsTo(WCH&). More...

casacore::Bool	isCsAndZIndexConformed ()
	Added so that when two images are loaded with no velocity alignment, they can still show their position coordinates without having to be rstrsConformed. More...

virtual void	delTmpData (casacore::String &tmpData)
	Delete temporary data. More...

virtual const std::list < WCPositionEH * > *	positionEventHandlerList ()
	Retrieve position, motion, refresh and display event handler lists. More...

virtual const std::list < WCMotionEH * > *	motionEventHandlerList ()

virtual const std::list < WCRefreshEH * > *	refreshEventHandlerList ()

virtual const std::list < DisplayEH * > *	displayEventHandlerList ()

virtual void	positionEH (const WCPositionEvent &ev)
	Position, motion and refresh event handlers that will generally be called by a WorldCanvasHolder. More...

virtual void	motionEH (const WCMotionEvent &ev)

	DisplayData (const DisplayData &other)
	(Required) copy constructor. More...

void	operator= (const DisplayData &other)
	(Required) copy assignment. More...

Protected Member Functions inherited from casa::DisplayOptions
	DisplayOptions (const DisplayOptions &other)
	(Required) copy constructor. More...

void	operator= (const DisplayOptions &other)
	(Required) copy assignment. More...

Private Attributes
casacore::ImageInterface < casacore::Float > *	itsBaseImage
	The base image cloned at construction. More...

casacore::MaskedLattice < casacore::Float > *	itsMaskedLattice
	The masked lattice, effectively referencing one of itsBaseImage, ... More...

casacore::LatticeStatistics < casacore::Float > *	itsLatticeStatistics
	Object to use for calculating statistics. More...

casacore::LatticeHistograms < casacore::Float > *	itsLatticeHistograms
	Object ot use for calculating histograms. More...

Friends
class	Histogram2dDM

Additional Inherited Members
Public Types inherited from casa::DisplayData
enum	DisplayState { DISPLAYED, UNDISPLAYED, LIMBO }

Static Public Attributes inherited from casa::DisplayData
static const casacore::String	DATA_MIN

static const casacore::String	DATA_MAX

Protected Attributes inherited from casa::ActiveCaching2dDD
DisplayCoordinateSystem	itsCoordinateSystem
	Store the 2d DisplayCoordinateSystem here. More...

casacore::Vector < casacore::Double >	itsPixelBlc
	Store the 2d pixel corners here. More...

casacore::Vector < casacore::Double >	itsPixelTrc

Protected Attributes inherited from casa::CachingDisplayData
casacore::Bool	restorePCColormap_
	The default is false. More...

Protected Attributes inherited from casa::DisplayData
AttributeBuffer	restrictions
	The Book says that we should not put data members in class that is supposed to only define an interface, but by putting these here, we can implement some of the restriction & eventhandling stuff so that people do not have to repeat it. More...

AttributeBuffer	attributes
	buffer for storing Attributes More...

casacore::PtrBlock< void * >	DDelement
	list of DisplayDataElements, which are of type DisplayMethod or derived More...

casacore::Int	activeZIndex_
	Indicates the 'current' animation frame, i.e. More...

casacore::Bool	delTmpData_
	Flag indicating that temporary data should be removed when deleting the object. More...

casacore::Bool	rstrsConformed_
	Somewhat limited-use state, saved here for 'efficiency'. More...

casacore::Bool	csConformed_

casacore::Bool	zIndexConformed_

Detailed Description

A DisplayData to draw histograms.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Definition at line 68 of file Histogram2dDD.h.

Constructor & Destructor Documentation

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

Constructor taking a pointer to an already constructed ImageInterface.

virtual casa::Histogram2dDD::~Histogram2dDD ( )

virtual

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

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

Constructor taking a pointer to an Array. Histogram2dDD(const casacore::Array<casacore::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 ( )

inlinevirtual

Return the type of this DisplayData.

Implements casa::DisplayData.

Definition at line 105 of file Histogram2dDD.h.

References casa::Display::CanvasAnnotation.

virtual const casacore::Unit casa::Histogram2dDD::dataUnit ( )

virtual

Return the data unit.

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

virtual

Retrieve the current and default options and parameter types.

Reimplemented from casa::ActiveCaching2dDD.

const casacore::Lattice<casacore::Float>& casa::Histogram2dDD::lattice ( ) const

inline

Provide read-only access to the Lattice.

Definition at line 124 of file Histogram2dDD.h.

References itsMaskedLattice.

const casacore::MaskedLattice<casacore::Float>& casa::Histogram2dDD::maskedLattice ( ) const

inline

Provide read-only access to the MaskedLattce.

Definition at line 129 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.

Implements casa::CachingDisplayData.

void casa::Histogram2dDD::operator= ( const Histogram2dDD & other )

protected

(Required) copy assignment.

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 casacore::Bool casa::Histogram2dDD::setOptions	(	casacore::Record &	rec,
		casacore::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 casacore::String casa::Histogram2dDD::showValue ( const casacore::Vector< casacore::Double > & world )

virtual

casacore::Format the histogram value at the given world position.

Implements casa::DisplayData.

Friends And Related Function Documentation

friend class Histogram2dDM

friend

Definition at line 146 of file Histogram2dDD.h.

Member Data Documentation

casacore::ImageInterface<casacore::Float>* casa::Histogram2dDD::itsBaseImage

private

The base image cloned at construction.

Definition at line 149 of file Histogram2dDD.h.

casacore::LatticeHistograms<casacore::Float>* casa::Histogram2dDD::itsLatticeHistograms

private

Object ot use for calculating histograms.

Definition at line 159 of file Histogram2dDD.h.

casacore::LatticeStatistics<casacore::Float>* casa::Histogram2dDD::itsLatticeStatistics

private

Object to use for calculating statistics.

Definition at line 156 of file Histogram2dDD.h.

casacore::MaskedLattice<casacore::Float>* casa::Histogram2dDD::itsMaskedLattice

private

The masked lattice, effectively referencing one of itsBaseImage,

...

Definition at line 153 of file Histogram2dDD.h.

Referenced by lattice(), and maskedLattice().

The documentation for this class was generated from the following file:

casa/code/display/DisplayDatas/Histogram2dDD.h

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation