RebinLattice.h

    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

Member Description

RebinLattice()

Default constructor (Object is unuseable)

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(const RebinLattice<T>& other)

Copy constructor (reference semantics)

RebinLattice<T>& operator=(const RebinLattice<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 isPaged() const

Is the lattice paged to disk?

virtual Bool isWritable() const

The lattice is not writable.

virtual Bool lock (FileLocker::LockType, uInt nattempts)
virtual void unlock()
virtual Bool hasLock (FileLocker::LockType) const

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.

virtual void resync()

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.

virtual void flush()

Flush the data.

virtual void tempClose()

Close the Lattice temporarily (if it is paged to disk). It'll be reopened automatically when needed or when reopen is called explicitly.

virtual void reopen()

If needed, reopen a temporarily closed Lattice.

virtual const LatticeRegion* getRegionPtr() const

Get a pointer the region/mask object. It returns 0.

virtual IPosition shape() const

Returns the shape of the lattice.

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. Should always return True

virtual Bool doGetSlice (Array<T>& buffer, const Slicer& section)

Do the actual getting of an array of values. Slicers with non-unit stride are not yet supported

virtual void doPutSlice (const Array<T>& sourceBuffer, const IPosition& where, const IPosition& stride)

Do the actual putting of an array of values. The lattice is not writable.

virtual Bool doGetMaskSlice (Array<Bool>& buffer, const Slicer& section)

Get a section of the mask. Slicers with non-unit stride are not yet supported

static IPosition rebinShape (const IPosition& shapeLatticeIn, const IPosition& bin)

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'