#include <ExtendLattice.h>
Inheritance diagram for casa::ExtendLattice< T >:
Part of API
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).
Definition at line 78 of file ExtendLattice.h.
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 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 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 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 §ion) |
| 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 §ion) |
| Get a section of the mask. | |
| virtual IPosition | doNiceCursorShape (uInt maxPixels) const |
| Get the best cursor shape. | |
| 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) | |
| 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 const Lattice< Bool > & | pixelMask () const |
| Get access to the pixelmask. | |
| virtual Lattice< Bool > & | pixelMask () |
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 §ion) |
| Get mask data from mask. | |
Private Attributes | |
| Lattice< T > * | itsLatticePtr |
| MaskedLattice< T > * | itsMaskLatPtr |
| Bool | itsHasPixelMask |
| ExtendLattice< Bool > * | itsPixelMask |
| ExtendSpecifier | itsExtendSpec |
| casa::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.
| casa::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.
| casa::ExtendLattice< T >::ExtendLattice | ( | const MaskedLattice< T > & | lattice, | |
| const IPosition & | newShape, | |||
| const IPosition & | newAxes, | |||
| const IPosition & | stretchAxes | |||
| ) |
| casa::ExtendLattice< T >::ExtendLattice | ( | const ExtendLattice< T > & | other | ) |
Copy constructor (reference semantics).
| virtual casa::ExtendLattice< T >::~ExtendLattice | ( | ) | [virtual] |
| ExtendLattice<T>& casa::ExtendLattice< T >::operator= | ( | const ExtendLattice< T > & | other | ) |
Assignment (reference semantics).
| virtual MaskedLattice<T>* casa::ExtendLattice< T >::cloneML | ( | ) | const [virtual] |
| virtual Bool casa::ExtendLattice< T >::isMasked | ( | ) | const [virtual] |
Is the lattice masked? It is if its parent lattice is masked.
Reimplemented from casa::MaskedLattice< T >.
| virtual Bool casa::ExtendLattice< T >::isPersistent | ( | ) | const [virtual] |
| virtual Bool casa::ExtendLattice< T >::isPaged | ( | ) | const [virtual] |
| virtual Bool casa::ExtendLattice< T >::isWritable | ( | ) | const [virtual] |
| virtual Bool casa::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 casa::LatticeBase.
| virtual void casa::ExtendLattice< T >::unlock | ( | ) | [virtual] |
Reimplemented from casa::LatticeBase.
| virtual Bool casa::ExtendLattice< T >::hasLock | ( | FileLocker::LockType | ) | const [virtual] |
Reimplemented from casa::LatticeBase.
| virtual void casa::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 casa::LatticeBase.
| virtual void casa::ExtendLattice< T >::flush | ( | ) | [virtual] |
| virtual void casa::ExtendLattice< T >::tempClose | ( | ) | [virtual] |
Close the Lattice temporarily (if it is paged to disk).
It'll be reopened automatically when needed or when reopen is called explicitly.
Reimplemented from casa::LatticeBase.
| virtual void casa::ExtendLattice< T >::reopen | ( | ) | [virtual] |
| virtual Bool casa::ExtendLattice< T >::hasPixelMask | ( | ) | const [virtual] |
| virtual const Lattice<Bool>& casa::ExtendLattice< T >::pixelMask | ( | ) | const [virtual] |
Get access to the pixelmask.
An exception is thrown if the ExtendLattice does not have a pixelmask.
Reimplemented from casa::MaskedLattice< T >.
| virtual Lattice<Bool>& casa::ExtendLattice< T >::pixelMask | ( | ) | [virtual] |
Reimplemented from casa::MaskedLattice< T >.
| virtual const LatticeRegion* casa::ExtendLattice< T >::getRegionPtr | ( | ) | const [virtual] |
| virtual IPosition casa::ExtendLattice< T >::shape | ( | ) | const [virtual] |
| virtual String casa::ExtendLattice< T >::name | ( | Bool | stripPath = False |
) | const [virtual] |
| virtual uInt casa::ExtendLattice< T >::advisedMaxPixels | ( | ) | const [virtual] |
This function returns the recommended maximum number of pixels to include in the cursor of an iterator.
Reimplemented from casa::Lattice< T >.
| virtual Bool casa::ExtendLattice< T >::ok | ( | ) | const [virtual] |
Check class internals - used for debugging.
Should always return True
Reimplemented from casa::LatticeBase.
| virtual Bool casa::ExtendLattice< T >::doGetSlice | ( | Array< T > & | buffer, | |
| const Slicer & | section | |||
| ) | [virtual] |
| virtual void casa::ExtendLattice< T >::doPutSlice | ( | const Array< T > & | sourceBuffer, | |
| const IPosition & | where, | |||
| const IPosition & | stride | |||
| ) | [virtual] |
| virtual Bool casa::ExtendLattice< T >::doGetMaskSlice | ( | Array< Bool > & | buffer, | |
| const Slicer & | section | |||
| ) | [virtual] |
| virtual IPosition casa::ExtendLattice< T >::doNiceCursorShape | ( | uInt | maxPixels | ) | const [virtual] |
| void casa::ExtendLattice< T >::setPtr | ( | Lattice< T > * | latticePtr, | |
| MaskedLattice< T > * | maskLatPtr | |||
| ) | [private] |
Set the various pointer needed to construct the object.
One of the pointers should be zero. It takes over the pointer and deletes the object in the destructor.
| Bool casa::ExtendLattice< T >::getMaskDataSlice | ( | Array< Bool > & | buffer, | |
| const Slicer & | section | |||
| ) | [private] |
Get mask data from mask.
Lattice<T>* casa::ExtendLattice< T >::itsLatticePtr [private] |
Definition at line 204 of file ExtendLattice.h.
MaskedLattice<T>* casa::ExtendLattice< T >::itsMaskLatPtr [private] |
Definition at line 205 of file ExtendLattice.h.
Bool casa::ExtendLattice< T >::itsHasPixelMask [private] |
Definition at line 206 of file ExtendLattice.h.
ExtendLattice<Bool>* casa::ExtendLattice< T >::itsPixelMask [private] |
Definition at line 207 of file ExtendLattice.h.
ExtendSpecifier casa::ExtendLattice< T >::itsExtendSpec [private] |
Definition at line 208 of file ExtendLattice.h.
1.5.1