casa::LatticePADisplayData< T > Class Template Reference

Partial implementation of PrincipalAxesDD for Lattice-based data. More...

#include <LatticePADD.h>

Inheritance diagram for casa::LatticePADisplayData< T >:

Public Member Functions
	LatticePADisplayData (Array< T > *array, const uInt xAxis, const uInt yAxis, const uInt mAxis, const IPosition fixedPos)
	Constructors (no default) LatticePADisplayData();.
	LatticePADisplayData (Array< T > *array, const uInt xAxis, const uInt yAxis)
	LatticePADisplayData (SHARED_PTR< ImageInterface< T > > image, const uInt xAxis, const uInt yAxis, const uInt mAxis, const IPosition fixedPos, viewer::StatusSink *sink=0)
	Image-based constructors: >2d and 2d.
	LatticePADisplayData (SHARED_PTR< ImageInterface< T > > image, const uInt xAxis, const uInt yAxis)
virtual	~LatticePADisplayData ()
	Destructor.
virtual String	showValue (const Vector< Double > &world)
	Format a string containing value information at the given world coordinate.
virtual const IPosition	dataShape () const
	required functions to help inherited "setup" amongst other things
virtual uInt	dataDim () const
virtual T	dataValue (IPosition pos)
virtual const Unit	dataUnit () const
String	dataType () const
	Pure virtual function from DisplayData.
virtual ImageAnalysis *	imageanalysis () const
	Get image analyis about object.
SHARED_PTR< ImageInterface < Float > >	imageinterface ()
	Returns a pointer that should not be deleted.
virtual void	setupElements ()=0
	left as pure virtual for implementation in concrete class
virtual void	getMinAndMax ()
virtual Bool	maskValue (const IPosition &pos)
	return mask value at given position
virtual void	setDefaultOptions ()
	install the default options for this DisplayData
virtual Bool	setOptions (Record &rec, Record &recOut)
	apply options stored in val to the DisplayData; return value True means a refresh is needed.
virtual Record	getOptions (bool scrub=false) const
	retrieve the current and default options and parameter types.
virtual String	className () const
	Return the class name of this DisplayData; useful mostly for debugging purposes, and perhaps future use in the glish widget interface.
String	description () const
virtual WCResampleHandler *	resampleHandler ()
virtual Display::ComplexToRealMethod	complexMode ()
virtual void	setComplexMode (Display::ComplexToRealMethod method)
virtual SHARED_PTR < MaskedLattice< T > >	maskedLattice ()
virtual Bool	insertArray (Record &toGoInto, Vector< Float > toInsert, const String fieldname)
	Insert an array into a Record.
virtual Bool	insertFloat (Record &toGoInto, Float toInsert, const String fieldname)
virtual Record	getHist () const
	Return the last calculated histogram.
virtual String	getBrightnessUnits () const
	Return the brightness unit as a string.
Static Public Member Functions
static Bool	useStriding (const IPosition &shape, IPosition &stride, uInt maxPixels=1000000u, uInt minPerAxis=20u)
	Aids updateHistogram() by computing a stride to use for efficiency when computing histograms (could be used elsewhere too).
Protected Member Functions
virtual void	SetUpBeamData_ ()
	Called by constructors: set up data for beam drawing, if applicable.
virtual void	drawBeamEllipse_ (WorldCanvas *wc)
	Will draw the beam ellipse if applicable (i.e., the LatticePADD has an image with beam data, beam drawing is turned on, and the WC's CoordinateSystem is set to sky coordinates).
Private Attributes
SHARED_PTR< ImageInterface< T > >	itsBaseImagePtr
	The base image cloned at construction.
Array< T > *	itsBaseArrayPtr
	The base array cloned at construction.
Record	imageHistogram
	The image histogram.
Bool	calcHist
	Whether to always calculate the histogram or not.
SHARED_PTR< MaskedLattice< T > >	itsMaskedLatticePtr
	The masked lattice, effectively referencing one of itsBaseImagePtr or itsBaseArray, or some sub-region of said.
Bool	itsDeleteMLPointer
	Says whether the destructor should delete itsMaskedLattice or not.
LatticeStatistics< Float > *	itsLatticeStatisticsPtr
	Object to use for calculating statistics.
ImageRegion *	itsRegionPtr
	Is itsLattice a SubImage?
WCLELMask *	itsMaskPtr
	OTF mask.
Unit	itsDataUnit
	The data unit.
Display::ComplexToRealMethod	itsComplexToRealMethod
	the complex to real method
String	itsResample
	storage for the display parameters
String	itsComplexMode

Detailed Description

template<class T>
class casa::LatticePADisplayData< T >

Partial implementation of PrincipalAxesDD for Lattice-based data.

Synopsis

This class is a partial (ie. base) implementation of PrincipalAxesDD which adds methods particular to handling Lattice-based data.

Definition at line 60 of file LatticePADD.h.

Constructor & Destructor Documentation

template<class T>

casa::LatticePADisplayData< T >::LatticePADisplayData	(	Array< T > *	array,
		const uInt	xAxis,
		const uInt	yAxis,
		const uInt	mAxis,
		const IPosition	fixedPos
	)

Constructors (no default) LatticePADisplayData();.

Array-based constructors: >2d and 2d

template<class T>

casa::LatticePADisplayData< T >::LatticePADisplayData	(	Array< T > *	array,
		const uInt	xAxis,
		const uInt	yAxis
	)

template<class T>

casa::LatticePADisplayData< T >::LatticePADisplayData	(	SHARED_PTR< ImageInterface< T > >	image,
		const uInt	xAxis,
		const uInt	yAxis,
		const uInt	mAxis,
		const IPosition	fixedPos,
		viewer::StatusSink *	sink = `0`
	)

Image-based constructors: >2d and 2d.

template<class T>

casa::LatticePADisplayData< T >::LatticePADisplayData	(	SHARED_PTR< ImageInterface< T > >	image,
		const uInt	xAxis,
		const uInt	yAxis
	)

template<class T>

virtual casa::LatticePADisplayData< T >::~LatticePADisplayData ( ) [virtual]

Destructor.

Member Function Documentation

template<class T>

virtual String casa::LatticePADisplayData< T >::className ( ) const [inline, virtual]

Return the class name of this DisplayData; useful mostly for debugging purposes, and perhaps future use in the glish widget interface.

Reimplemented from casa::DisplayData.

Reimplemented in casa::LatticeAsContour< T >, casa::LatticeAsMarker< T >, casa::LatticeAsRaster< T >, and casa::LatticeAsVector< T >.

Definition at line 126 of file LatticePADD.h.

template<class T>

virtual Display::ComplexToRealMethod casa::LatticePADisplayData< T >::complexMode ( ) [inline, virtual]

Definition at line 139 of file LatticePADD.h.

template<class T>

virtual uInt casa::LatticePADisplayData< T >::dataDim ( ) const [virtual]

Implements casa::DisplayData.

template<class T>

virtual const IPosition casa::LatticePADisplayData< T >::dataShape ( ) const [virtual]

required functions to help inherited "setup" amongst other things

Implements casa::DisplayData.

template<class T>

String casa::LatticePADisplayData< T >::dataType ( ) const [inline, virtual]

Pure virtual function from DisplayData.

.\.

Implements casa::DisplayData.

Definition at line 96 of file LatticePADD.h.

template<class T>

virtual const Unit casa::LatticePADisplayData< T >::dataUnit ( ) const [virtual]

Implements casa::DisplayData.

template<class T>

virtual T casa::LatticePADisplayData< T >::dataValue ( IPosition pos ) [virtual]

Reimplemented in casa::LatticeAsVector< T >.

template<class T>

String casa::LatticePADisplayData< T >::description ( ) const [inline, virtual]

Reimplemented from casa::DisplayData.

Definition at line 129 of file LatticePADD.h.

template<class T>

virtual void casa::LatticePADisplayData< T >::drawBeamEllipse_ ( WorldCanvas * wc ) [protected, virtual]

Will draw the beam ellipse if applicable (i.e., the LatticePADD has an image with beam data, beam drawing is turned on, and the WC's CoordinateSystem is set to sky coordinates).

Reimplemented from casa::PrincipalAxesDD.

template<class T>

virtual String casa::LatticePADisplayData< T >::getBrightnessUnits ( ) const [virtual]

Return the brightness unit as a string.

template<class T>

virtual Record casa::LatticePADisplayData< T >::getHist ( ) const [virtual]

Return the last calculated histogram.

template<class T>

virtual void casa::LatticePADisplayData< T >::getMinAndMax ( ) [virtual]

Implements casa::PrincipalAxesDD.

template<class T>

virtual Record casa::LatticePADisplayData< T >::getOptions ( bool scrub = false ) const [virtual]

retrieve the current and default options and parameter types.

Reimplemented from casa::PrincipalAxesDD.

Reimplemented in casa::LatticeAsContour< T >, casa::LatticeAsMarker< T >, casa::LatticeAsRaster< T >, and casa::LatticeAsVector< T >.

template<class T>

virtual ImageAnalysis* casa::LatticePADisplayData< T >::imageanalysis ( ) const [virtual]

Get image analyis about object.

.\.

Reimplemented from casa::DisplayData.

template<class T>

SHARED_PTR<ImageInterface<Float> > casa::LatticePADisplayData< T >::imageinterface ( ) [virtual]

Returns a pointer that should *not* be deleted.

.\.

Reimplemented from casa::DisplayData.

template<class T>

virtual Bool casa::LatticePADisplayData< T >::insertArray	(	Record &	toGoInto,
		Vector< Float >	toInsert,
		const String	fieldname
	)			`[virtual]`

Insert an array into a Record.

The array is insert into a "value" field, eg somerecord.fieldname.value

template<class T>

virtual Bool casa::LatticePADisplayData< T >::insertFloat	(	Record &	toGoInto,
		Float	toInsert,
		const String	fieldname
	)			`[virtual]`

template<class T>

virtual SHARED_PTR<MaskedLattice<T> > casa::LatticePADisplayData< T >::maskedLattice ( ) [inline, virtual]

Definition at line 146 of file LatticePADD.h.

template<class T>

virtual Bool casa::LatticePADisplayData< T >::maskValue ( const IPosition & pos ) [virtual]

return mask value at given position

template<class T>

virtual WCResampleHandler* casa::LatticePADisplayData< T >::resampleHandler ( ) [inline, virtual]

Definition at line 133 of file LatticePADD.h.

template<class T>

virtual void casa::LatticePADisplayData< T >::setComplexMode ( Display::ComplexToRealMethod method ) [inline, virtual]

Definition at line 142 of file LatticePADD.h.

template<class T>

virtual void casa::LatticePADisplayData< T >::setDefaultOptions ( ) [virtual]

install the default options for this DisplayData

Reimplemented from casa::PrincipalAxesDD.

Reimplemented in casa::LatticeAsContour< T >, casa::LatticeAsMarker< T >, casa::LatticeAsRaster< T >, and casa::LatticeAsVector< T >.

template<class T>

virtual Bool casa::LatticePADisplayData< T >::setOptions	(	Record &	rec,
		Record &	recOut
	)			`[virtual]`

apply options stored in val to the DisplayData; return value True means a refresh is needed.

.\.

Reimplemented from casa::PrincipalAxesDD.

Reimplemented in casa::LatticeAsContour< T >, casa::LatticeAsMarker< T >, casa::LatticeAsRaster< T >, and casa::LatticeAsVector< T >.

template<class T>

virtual void casa::LatticePADisplayData< T >::SetUpBeamData_ ( ) [protected, virtual]

Called by constructors: set up data for beam drawing, if applicable.

template<class T>

virtual void casa::LatticePADisplayData< T >::setupElements ( ) [pure virtual]

left as pure virtual for implementation in concrete class

Reimplemented from casa::PrincipalAxesDD.

Implemented in casa::LatticeAsContour< T >, casa::LatticeAsMarker< T >, casa::LatticeAsRaster< T >, and casa::LatticeAsVector< T >.

template<class T>

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

Format a string containing value information at the given world coordinate.

Implements casa::DisplayData.

template<class T>

static Bool casa::LatticePADisplayData< T >::useStriding	(	const IPosition &	shape,
		IPosition &	stride,
		uInt	maxPixels = `1000000u`,
		uInt	minPerAxis = `20u`
	)			`[static]`

Aids updateHistogram() by computing a stride to use for efficiency when computing histograms (could be used elsewhere too).

Input parameter 'shape' is the shape of the original lattice or array. Return value indicates whether striding should be used; if so, the recommended stride is returned in the 'stride' parameter. maxPixels is the desired maximum number of elements in the sub-lattice that would result from using the returned stride (may be exceeded because of minPerAxis requirements, or in any case by a few percent). A stride greater than 1 will not be returned for an axis if it would make the length of that axis in the strided sub-lattice less than minPerAxis.