LatticePADD.h

Classes

LatticePADisplayData -- Partial implementation of PrincipalAxesDD for Lattice-based data. (full description)

template <class T> class LatticePADisplayData : public PrincipalAxesDD

Interface

Public Members
LatticePADisplayData(Array<T> *array, const uInt xAxis, const uInt yAxis, const uInt mAxis, const IPosition fixedPos)
LatticePADisplayData(Array<T> *array, const uInt xAxis, const uInt yAxis)
LatticePADisplayData(ImageInterface<T> *image, const uInt xAxis, const uInt yAxis, const uInt mAxis, const T fixedPos)
LatticePADisplayData(ImageInterface<T> *image, const uInt xAxis, const uInt yAxis)
virtual ~LatticePADisplayData()
virtual String showValue(const Vector<Double> &world)
virtual const IPosition dataShape()
virtual const uInt dataDim()
virtual const T dataValue(IPosition pos)
virtual const Unit dataUnit()
virtual void setupElements() = 0
virtual void getMinAndMax()
virtual const Bool maskValue(const IPosition &pos)
virtual void setDefaultOptions()
virtual Bool setOptions(Record &rec, Record &recOut)
virtual Record getOptions()
virtual String className()
virtual WCResampleHandler *resampleHandler()
virtual Display::ComplexToRealMethod complexMode()
virtual void setComplexMode(Display::ComplexToRealMethod method)
virtual MaskedLattice<T> *maskedLattice()
virtual Bool insertArray(Record& toGoInto, Vector<Float> toInsert, const String fieldname)
virtual Bool insertFloat(Record& toGoInto, Float toInsert, const String fieldname)
virtual Record getHist()
virtual String getBrightnessUnits()
Private Members
void updateLatticeStatistics()
Bool updateHistogram(Record &rec, MaskedLattice<Complex> &pImage)
Bool updateHistogram(Record &rec, ImageInterface<Float> &pImage)
Bool updateHistogram(Record &rec, const Array<Complex>*)
Bool updateHistogram(Record &rec, const Array<Float>*)
WCLELMask* makeMask (const RecordInterface& mask)
ImageRegion* makeRegion (const RecordInterface& region)
Bool isMaskDifferent (WCLELMask*& pMask)
Bool isRegionDifferent (ImageRegion*& pRegion)
Bool transferPreferences (CoordinateSystem& cSysInOut, const CoordinateSystem& cSysIn) const

Description

Synopsis

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

Member Description

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

Constructors (no default) LatticePADisplayData();

Array-based constructors: >2d and 2d

LatticePADisplayData(ImageInterface<T> *image, const uInt xAxis, const uInt yAxis, const uInt mAxis, const T fixedPos)
LatticePADisplayData(ImageInterface<T> *image, const uInt xAxis, const uInt yAxis)

Image-based constructors: >2d and 2d

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()

required functions to help inherited "setup" amongst other things

virtual const uInt dataDim()

virtual const T dataValue(IPosition pos)

virtual const Unit dataUnit()

virtual void setupElements() = 0

left as pure virtual for implementation in concrete class

virtual void getMinAndMax()

virtual const 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()

retrieve the current and default options and parameter types.

virtual String className()

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

virtual WCResampleHandler *resampleHandler()

virtual Display::ComplexToRealMethod complexMode()

virtual void setComplexMode(Display::ComplexToRealMethod method)

virtual MaskedLattice<T> *maskedLattice()

virtual Bool insertArray(Record& toGoInto, Vector<Float> toInsert, const String fieldname)

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

virtual Bool insertFloat(Record& toGoInto, Float toInsert, const String fieldname)

virtual Record getHist()

Return the last calculated histogram

virtual String getBrightnessUnits()

Return the brightness unit as a string

void updateLatticeStatistics()

update itsLatticeStatistics

Bool updateHistogram(Record &rec, MaskedLattice<Complex> &pImage)

Update the histogram, and attach it to the supplied record

Bool updateHistogram(Record &rec, ImageInterface<Float> &pImage)

Bool updateHistogram(Record &rec, const Array<Complex>*)

Bool updateHistogram(Record &rec, const Array<Float>*)

WCLELMask* makeMask (const RecordInterface& mask)

ImageRegion* makeRegion (const RecordInterface& region)

Bool isMaskDifferent (WCLELMask*& pMask)

Bool isRegionDifferent (ImageRegion*& pRegion)

Bool transferPreferences (CoordinateSystem& cSysInOut, const CoordinateSystem& cSysIn) const

Transfer preferences between CoordinateSystems