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

Rebin a masked lattice. More...

#include <RebinImage.h>

Public Member Functions

 RebinLattice ()
 Default constructor (Object is unuseable) More...
 
 RebinLattice (const MaskedLattice< T > &lattice, const IPosition &bin)
 Constructor. More...
 
 RebinLattice (const RebinLattice< T > &other)
 Copy constructor (reference semantics) More...
 
virtual ~RebinLattice ()
 Destructor. More...
 
RebinLattice< T > & operator= (const RebinLattice< 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 isPaged () const
 Is the lattice paged to disk? More...
 
virtual Bool isWritable () const
 The lattice is not writable. More...
 
virtual Bool lock (FileLocker::LockType, uInt nattempts)
 Handle locking of the lattice 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 const LatticeRegiongetRegionPtr () const
 Get a pointer the region/mask object. More...
 
virtual IPosition shape () const
 Returns the shape of the lattice. 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)
 Do the actual putting of an array of values. More...
 
virtual Bool doGetMaskSlice (Array< Bool > &buffer, const Slicer &section)
 Get a section of the mask. More...
 

Static Public Member Functions

static IPosition rebinShape (const IPosition &shapeLatticeIn, const IPosition &bin)
 Static function needed by LEL. More...
 

Private Member Functions

Slicer findOriginalSlicer (const Slicer &section) const
 
void getDataAndMask (const Slicer &section)
 
void bin (const Array< T > &dataIn)
 
void bin (const Array< T > &dataIn, const Array< Bool > &maskIn)
 

Private Attributes

MaskedLattice< T > * itsLatticePtr
 
IPosition itsBin
 
Bool itsAllUnity
 
Array< T > itsData
 Cache. More...
 
Array< BoolitsMask
 
Slicer itsSlicer
 

Detailed Description

template<class T>
class casacore::RebinLattice< T >

Rebin a masked lattice.

Intended use:

Internal

Review Status

Test programs:
tRebinLattice

Prerequisite

Synopsis

This class enables you to rebin (data are averaged over bin) a MaskedLattice by a given factor per axis

Example

IPosition shape(2, 10, 20);
TiledShape tShape(shape);
TempLattice<Float> latIn(tShape);
IPosition factors(2, 2, 5);
RebinLattice<Float> rl(latIn, factors);
cerr << "Binned data = " << rl.get() << endl;

Motivation

Definition at line 39 of file RebinImage.h.

Constructor & Destructor Documentation

◆ RebinLattice() [1/3]

template<class T >
casacore::RebinLattice< T >::RebinLattice ( )

Default constructor (Object is unuseable)

◆ RebinLattice() [2/3]

template<class T >
casacore::RebinLattice< T >::RebinLattice ( const MaskedLattice< T > &  lattice,
const IPosition bin 
)

Constructor.

The bins don't have to fit integrally. Whatever is left over at the end is treated as a full bin.

◆ RebinLattice() [3/3]

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

Copy constructor (reference semantics)

◆ ~RebinLattice()

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

Destructor.

Member Function Documentation

◆ advisedMaxPixels()

template<class T >
virtual uInt casacore::RebinLattice< T >::advisedMaxPixels ( ) const
virtual

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

◆ bin() [1/2]

template<class T >
void casacore::RebinLattice< T >::bin ( const Array< T > &  dataIn)
private

◆ bin() [2/2]

template<class T >
void casacore::RebinLattice< T >::bin ( const Array< T > &  dataIn,
const Array< Bool > &  maskIn 
)
private

◆ cloneML()

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

Make a copy of the object (reference semantics).

◆ doGetMaskSlice()

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

Get a section of the mask.

Slicers with non-unit stride are not yet supported

◆ doGetSlice()

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

Do the actual getting of an array of values.

Slicers with non-unit stride are not yet supported

◆ doPutSlice()

template<class T >
virtual void casacore::RebinLattice< T >::doPutSlice ( const Array< T > &  sourceBuffer,
const IPosition where,
const IPosition stride 
)
virtual

Do the actual putting of an array of values.

The lattice is not writable.

◆ findOriginalSlicer()

template<class T >
Slicer casacore::RebinLattice< T >::findOriginalSlicer ( const Slicer section) const
private

◆ flush()

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

Flush the data.

◆ getDataAndMask()

template<class T >
void casacore::RebinLattice< T >::getDataAndMask ( const Slicer section)
private

◆ getRegionPtr()

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

Get a pointer the region/mask object.

It returns 0.

◆ hasLock()

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

◆ isMasked()

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

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

◆ isPaged()

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

Is the lattice paged to disk?

◆ isWritable()

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

The lattice is not writable.

◆ lock()

template<class T >
virtual Bool casacore::RebinLattice< T >::lock ( FileLocker::LockType  ,
uInt  nattempts 
)
virtual

Handle locking of the lattice 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::RebinLattice< T >::name ( Bool  stripPath = False) const
virtual

Return the name of the parent lattice.

◆ ok()

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

Check class internals - used for debugging.

Should always return True

◆ operator=()

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

Assignment (reference semantics)

◆ rebinShape()

template<class T >
static IPosition casacore::RebinLattice< T >::rebinShape ( const IPosition shapeLatticeIn,
const IPosition bin 
)
static

Static function needed by LEL.

Applies binning factors to shape to give the shape of the output lattice. Will give the same result as function 'shape'

◆ reopen()

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

If needed, reopen a temporarily closed Lattice.

◆ resync()

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

◆ shape()

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

Returns the shape of the lattice.

◆ tempClose()

template<class T >
virtual void casacore::RebinLattice< 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::RebinLattice< T >::unlock ( )
virtual

Member Data Documentation

◆ itsAllUnity

template<class T >
Bool casacore::RebinLattice< T >::itsAllUnity
private

Definition at line 186 of file RebinLattice.h.

◆ itsBin

template<class T >
IPosition casacore::RebinLattice< T >::itsBin
private

Definition at line 185 of file RebinLattice.h.

◆ itsData

template<class T >
Array<T> casacore::RebinLattice< T >::itsData
private

Cache.

Definition at line 188 of file RebinLattice.h.

◆ itsLatticePtr

template<class T >
MaskedLattice<T>* casacore::RebinLattice< T >::itsLatticePtr
private

Definition at line 184 of file RebinLattice.h.

◆ itsMask

template<class T >
Array<Bool> casacore::RebinLattice< T >::itsMask
private

Definition at line 189 of file RebinLattice.h.

◆ itsSlicer

template<class T >
Slicer casacore::RebinLattice< T >::itsSlicer
private

Definition at line 190 of file RebinLattice.h.


The documentation for this class was generated from the following files:
casacore::RebinLattice::shape
virtual IPosition shape() const
Returns the shape of the lattice.