casacore::ExtendLattice< T > Class Template Reference

An extension of a Lattice or MaskedLattice. More...

#include <ExtendLattice.h>

Inheritance diagram for casacore::ExtendLattice< T >:

Public Member Functions
	ExtendLattice ()
	The default constructor creates a ExtendLattice that is useless for just about everything, except that it can be assigned to with the assignment operator.
	ExtendLattice (const Lattice< T > &lattice, const IPosition &newShape, const IPosition &extendAxes, const IPosition &stretchAxes)
	Create a ExtendLattice from a Lattice.
	ExtendLattice (const MaskedLattice< T > &lattice, const IPosition &newShape, const IPosition &newAxes, const IPosition &stretchAxes)
	ExtendLattice (const ExtendLattice< T > &other)
	Copy constructor (reference semantics).
virtual	~ExtendLattice ()
ExtendLattice< T > &	operator= (const ExtendLattice< T > &other)
	Assignment (reference semantics).
virtual MaskedLattice< T > *	cloneML () const
	Make a copy of the object (reference semantics).
virtual Bool	isMasked () const
	Is the lattice masked? It is if its parent lattice is masked.
virtual Bool	isPersistent () const
	An ExtendLattice is not persistent.
virtual Bool	isPaged () const
	Is the ExtendLattice paged to disk?
virtual Bool	isWritable () const
	An ExtendLattice is not writable.
virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Handle locking of the ExtendLattice which is delegated to its parent.
virtual void	unlock ()
virtual Bool	hasLock (FileLocker::LockType) const
virtual void	resync ()
	Resynchronize the Lattice object with the lattice file.
virtual void	flush ()
	Flush the data.
virtual void	tempClose ()
	Close the Lattice temporarily (if it is paged to disk).
virtual void	reopen ()
	If needed, reopen a temporarily closed Lattice.
virtual Bool	hasPixelMask () const
	Does the ExtendLattice have a pixelmask?
virtual const Lattice< Bool > &	pixelMask () const
	Get access to the pixelmask.
virtual Lattice< Bool > &	pixelMask ()
virtual const LatticeRegion *	getRegionPtr () const
	Get the region used (always returns 0).
virtual IPosition	shape () const
	Returns the shape of the ExtendLattice.
virtual String	name (Bool stripPath=False) const
	Return the name of the parent lattice.
virtual uInt	advisedMaxPixels () const
	This function returns the recommended maximum number of pixels to include in the cursor of an iterator.
virtual Bool	ok () const
	Check class internals - used for debugging.
virtual Bool	doGetSlice (Array< T > &buffer, const Slicer &section)
	Do the actual getting of an array of values.
virtual void	doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride)
	Putting data is not possible.
virtual Bool	doGetMaskSlice (Array< Bool > &buffer, const Slicer &section)
	Get a section of the mask.
virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	Get the best cursor shape.
Private Member Functions
void	setPtr (Lattice< T > latticePtr, MaskedLattice< T > maskLatPtr)
	Set the various pointer needed to construct the object.
Bool	getMaskDataSlice (Array< Bool > &buffer, const Slicer &section)
	Get mask data from mask.
Private Attributes
Lattice< T > *	itsLatticePtr
MaskedLattice< T > *	itsMaskLatPtr
Bool	itsHasPixelMask
ExtendLattice< Bool > *	itsPixelMask
ExtendSpecifier	itsExtendSpec

Detailed Description

template<class T>
class casacore::ExtendLattice< T >

An extension of a Lattice or MaskedLattice.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Synopsis

An ExtendLattice is a lattice virtually extending another lattice by stretching axes with length 1 and/or by adding new axes. It is useful for e.g. LEL to have the same shapes for lattices. An ExtendLattice is not writable (since many pixels map to the same underlying pixel).

Example

Template Type Argument Requirements (T)

Any type that can be used by the Tables System can also be used by this class.

Definition at line 78 of file ExtendLattice.h.

Constructor & Destructor Documentation

template<class T>

casacore::ExtendLattice< T >::ExtendLattice ( )

The default constructor creates a ExtendLattice that is useless for just about everything, except that it can be assigned to with the assignment operator.

template<class T>

casacore::ExtendLattice< T >::ExtendLattice	(	const Lattice< T > &	lattice,
		const IPosition &	newShape,
		const IPosition &	extendAxes,
		const IPosition &	stretchAxes
	)

Create a ExtendLattice from a Lattice.

newShape gives the new shape.
newAxes gives the new axes in newShape.
stretchAxes gives the stretched axes in newShape.
E.g. lattice has shape [32,1,5,1], newShape=[32,1,4,5,10], newAxes=[2], and stretchAxes=[4]. It means that axes 2 in the newShape is a new axes and that axes 4 in the new shape is stretched. The other axes in the new shape have to match the other axes in the old shape. Note that stretched axes have to have length 1 in the old shape.

template<class T>

casacore::ExtendLattice< T >::ExtendLattice	(	const MaskedLattice< T > &	lattice,
		const IPosition &	newShape,
		const IPosition &	newAxes,
		const IPosition &	stretchAxes
	)

template<class T>

casacore::ExtendLattice< T >::ExtendLattice ( const ExtendLattice< T > & other )

Copy constructor (reference semantics).

template<class T>

virtual casacore::ExtendLattice< T >::~ExtendLattice ( ) [virtual]

Member Function Documentation

template<class T>

virtual uInt casacore::ExtendLattice< T >::advisedMaxPixels ( ) const [virtual]

This function returns the recommended maximum number of pixels to include in the cursor of an iterator.

Reimplemented from casacore::Lattice< T >.

template<class T>

virtual MaskedLattice<T>* casacore::ExtendLattice< T >::cloneML ( ) const [virtual]

Make a copy of the object (reference semantics).

Implements casacore::MaskedLattice< T >.

template<class T>

virtual Bool casacore::ExtendLattice< T >::doGetMaskSlice	(	Array< Bool > &	buffer,
		const Slicer &	section
	)			`[virtual]`

Get a section of the mask.

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

virtual Bool casacore::ExtendLattice< T >::doGetSlice	(	Array< T > &	buffer,
		const Slicer &	section
	)			`[virtual]`

Do the actual getting of an array of values.

Implements casacore::Lattice< T >.

template<class T>

virtual IPosition casacore::ExtendLattice< T >::doNiceCursorShape ( uInt maxPixels ) const [virtual]

Get the best cursor shape.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual void casacore::ExtendLattice< T >::doPutSlice	(	const Array< T > &	sourceBuffer,
		const IPosition &	where,
		const IPosition &	stride
	)			`[virtual]`

Putting data is not possible.

Implements casacore::Lattice< T >.

template<class T>

virtual void casacore::ExtendLattice< T >::flush ( ) [virtual]

Flush the data.

Reimplemented from casacore::LatticeBase.

template<class T>

Bool casacore::ExtendLattice< T >::getMaskDataSlice	(	Array< Bool > &	buffer,
		const Slicer &	section
	)			`[private]`

Get mask data from mask.

template<class T>

virtual const LatticeRegion* casacore::ExtendLattice< T >::getRegionPtr ( ) const [virtual]

Get the region used (always returns 0).

Implements casacore::MaskedLattice< T >.

template<class T>

virtual Bool casacore::ExtendLattice< T >::hasLock ( FileLocker::LockType ) const [virtual]

Reimplemented from casacore::LatticeBase.

template<class T>

virtual Bool casacore::ExtendLattice< T >::hasPixelMask ( ) const [virtual]

Does the ExtendLattice have a pixelmask?

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

virtual Bool casacore::ExtendLattice< T >::isMasked ( ) const [virtual]

Is the lattice masked? It is if its parent lattice is masked.

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

virtual Bool casacore::ExtendLattice< T >::isPaged ( ) const [virtual]

Is the ExtendLattice paged to disk?

Reimplemented from casacore::LatticeBase.

template<class T>

virtual Bool casacore::ExtendLattice< T >::isPersistent ( ) const [virtual]

An ExtendLattice is not persistent.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual Bool casacore::ExtendLattice< T >::isWritable ( ) const [virtual]

An ExtendLattice is not writable.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual Bool casacore::ExtendLattice< T >::lock	(	FileLocker::LockType	,
		uInt	nattempts
	)			`[virtual]`

Handle locking of the ExtendLattice which is delegated to its parent.

It is strongly recommended to use class LatticeLocker to handle lattice locking. It also contains a more detailed explanation of the locking process.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual String casacore::ExtendLattice< T >::name ( Bool stripPath = False ) const [virtual]

Return the name of the parent lattice.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual Bool casacore::ExtendLattice< T >::ok ( ) const [virtual]

Check class internals - used for debugging.

Should always return True

Reimplemented from casacore::LatticeBase.

template<class T>

ExtendLattice<T>& casacore::ExtendLattice< T >::operator= ( const ExtendLattice< T > & other )

Assignment (reference semantics).

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

virtual Lattice<Bool>& casacore::ExtendLattice< T >::pixelMask ( ) [virtual]

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

virtual const Lattice<Bool>& casacore::ExtendLattice< T >::pixelMask ( ) const [virtual]

Get access to the pixelmask.

An exception is thrown if the ExtendLattice does not have a pixelmask.

Reimplemented from casacore::MaskedLattice< T >.

template<class T>

virtual void casacore::ExtendLattice< T >::reopen ( ) [virtual]

If needed, reopen a temporarily closed Lattice.

Reimplemented from casacore::LatticeBase.

template<class T>

virtual void casacore::ExtendLattice< T >::resync ( ) [virtual]

Resynchronize the Lattice object with the lattice file.

This function is only useful if no read-locking is used, ie. if the table lock option is UserNoReadLocking or AutoNoReadLocking. In that cases the table system does not acquire a read-lock, thus does not synchronize itself automatically.

Reimplemented from casacore::LatticeBase.

template<class T>