casacore
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::ExtendLattice< T > Class Template Reference

More...

#include <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. More...
 
 ExtendLattice (const Lattice< T > &lattice, const IPosition &newShape, const IPosition &extendAxes, const IPosition &stretchAxes)
 Create a ExtendLattice from a Lattice. More...
 
 ExtendLattice (const MaskedLattice< T > &lattice, const IPosition &newShape, const IPosition &newAxes, const IPosition &stretchAxes)
 
 ExtendLattice (const ExtendLattice< T > &other)
 Copy constructor (reference semantics). More...
 
virtual ~ExtendLattice ()
 
ExtendLattice< T > & operator= (const ExtendLattice< T > &other)
 Assignment (reference semantics). More...
 
virtual MaskedLattice< T > * cloneML () const
 Make a copy of the object (reference semantics). More...
 
virtual Bool isMasked () const
 Is the lattice masked? It is if its parent lattice is masked. More...
 
virtual Bool isPersistent () const
 An ExtendLattice is not persistent. More...
 
virtual Bool isPaged () const
 Is the ExtendLattice paged to disk? More...
 
virtual Bool isWritable () const
 An ExtendLattice is not writable. More...
 
virtual Bool lock (FileLocker::LockType, uInt nattempts)
 Handle locking of the ExtendLattice which is delegated to its parent. More...
 
virtual void unlock ()
 
virtual Bool hasLock (FileLocker::LockType) const
 
virtual void resync ()
 Resynchronize the Lattice object with the lattice file. More...
 
virtual void flush ()
 Flush the data. More...
 
virtual void tempClose ()
 Close the Lattice temporarily (if it is paged to disk). More...
 
virtual void reopen ()
 If needed, reopen a temporarily closed Lattice. More...
 
virtual Bool hasPixelMask () const
 Does the ExtendLattice have a pixelmask? More...
 
virtual const Lattice< Bool > & pixelMask () const
 Get access to the pixelmask. More...
 
virtual Lattice< Bool > & pixelMask ()
 
virtual const LatticeRegiongetRegionPtr () const
 Get the region used (always returns 0). More...
 
virtual IPosition shape () const
 Returns the shape of the ExtendLattice. More...
 
virtual String name (Bool stripPath=False) const
 Return the name of the parent lattice. More...
 
virtual uInt advisedMaxPixels () const
 This function returns the recommended maximum number of pixels to include in the cursor of an iterator. More...
 
virtual Bool ok () const
 Check class internals - used for debugging. More...
 
virtual Bool doGetSlice (Array< T > &buffer, const Slicer &section)
 Do the actual getting of an array of values. More...
 
virtual void doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride)
 Putting data is not possible. More...
 
virtual Bool doGetMaskSlice (Array< Bool > &buffer, const Slicer &section)
 Get a section of the mask. More...
 
virtual IPosition doNiceCursorShape (uInt maxPixels) const
 Get the best cursor shape. More...
 

Private Member Functions

void setPtr (Lattice< T > *latticePtr, MaskedLattice< T > *maskLatPtr)
 Set the various pointer needed to construct the object. More...
 
Bool getMaskDataSlice (Array< Bool > &buffer, const Slicer &section)
 Get mask data from mask. More...
 

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)

Definition at line 78 of file ExtendLattice.h.

Constructor & Destructor Documentation

◆ ExtendLattice() [1/4]

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.

◆ ExtendLattice() [2/4]

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.

◆ ExtendLattice() [3/4]

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

◆ ExtendLattice() [4/4]

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

Copy constructor (reference semantics).

◆ ~ExtendLattice()

template<class T >
virtual casacore::ExtendLattice< T >::~ExtendLattice ( )
virtual

Member Function Documentation

◆ advisedMaxPixels()

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.

◆ cloneML()

template<class T >
virtual MaskedLattice<T>* casacore::ExtendLattice< T >::cloneML ( ) const
virtual

Make a copy of the object (reference semantics).

◆ doGetMaskSlice()

template<class T >
virtual Bool casacore::ExtendLattice< T >::doGetMaskSlice ( Array< Bool > &  buffer,
const Slicer section 
)
virtual

Get a section of the mask.

◆ doGetSlice()

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.

◆ doNiceCursorShape()

template<class T >
virtual IPosition casacore::ExtendLattice< T >::doNiceCursorShape ( uInt  maxPixels) const
virtual

Get the best cursor shape.

◆ doPutSlice()

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.

◆ flush()

template<class T >
virtual void casacore::ExtendLattice< T >::flush ( )
virtual

Flush the data.

◆ getMaskDataSlice()

template<class T >
Bool casacore::ExtendLattice< T >::getMaskDataSlice ( Array< Bool > &  buffer,
const Slicer section 
)
private

Get mask data from mask.

◆ getRegionPtr()

template<class T >
virtual const LatticeRegion* casacore::ExtendLattice< T >::getRegionPtr ( ) const
virtual

Get the region used (always returns 0).

◆ hasLock()

template<class T >
virtual Bool casacore::ExtendLattice< T >::hasLock ( FileLocker::LockType  ) const
virtual

◆ hasPixelMask()

template<class T >
virtual Bool casacore::ExtendLattice< T >::hasPixelMask ( ) const
virtual

Does the ExtendLattice have a pixelmask?

◆ isMasked()

template<class T >
virtual Bool casacore::ExtendLattice< T >::isMasked ( ) const
virtual

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

◆ isPaged()

template<class T >
virtual Bool casacore::ExtendLattice< T >::isPaged ( ) const
virtual

Is the ExtendLattice paged to disk?

◆ isPersistent()

template<class T >
virtual Bool casacore::ExtendLattice< T >::isPersistent ( ) const
virtual

An ExtendLattice is not persistent.

◆ isWritable()

template<class T >
virtual Bool casacore::ExtendLattice< T >::isWritable ( ) const
virtual

An ExtendLattice is not writable.

◆ lock()

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.

◆ name()

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

Return the name of the parent lattice.

◆ ok()

template<class T >
virtual Bool casacore::ExtendLattice< T >::ok ( ) const
virtual

Check class internals - used for debugging.

Should always return True

◆ operator=()

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

Assignment (reference semantics).

◆ pixelMask() [1/2]

template<class T >
virtual Lattice<Bool>& casacore::ExtendLattice< T >::pixelMask ( )
virtual

◆ pixelMask() [2/2]

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.

◆ reopen()

template<class T >
virtual void casacore::ExtendLattice< T >::reopen ( )
virtual

If needed, reopen a temporarily closed Lattice.

◆ resync()

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.

◆ setPtr()

template<class T >
void casacore::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.

◆ shape()

template<class T >
virtual IPosition casacore::ExtendLattice< T >::shape ( ) const
virtual

Returns the shape of the ExtendLattice.

◆ tempClose()

template<class T >
virtual void casacore::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.

◆ unlock()

template<class T >
virtual void casacore::ExtendLattice< T >::unlock ( )
virtual

Member Data Documentation

◆ itsExtendSpec

template<class T >
ExtendSpecifier casacore::ExtendLattice< T >::itsExtendSpec
private

Definition at line 208 of file ExtendLattice.h.

◆ itsHasPixelMask

template<class T >
Bool casacore::ExtendLattice< T >::itsHasPixelMask
private

Definition at line 206 of file ExtendLattice.h.

◆ itsLatticePtr

template<class T >
Lattice<T>* casacore::ExtendLattice< T >::itsLatticePtr
private

Definition at line 204 of file ExtendLattice.h.

◆ itsMaskLatPtr

template<class T >
MaskedLattice<T>* casacore::ExtendLattice< T >::itsMaskLatPtr
private

Definition at line 205 of file ExtendLattice.h.

◆ itsPixelMask

template<class T >
ExtendLattice<Bool>* casacore::ExtendLattice< T >::itsPixelMask
private

Definition at line 207 of file ExtendLattice.h.


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