Go to the documentation of this file.
29 #ifndef LATTICES_LATTICEREGION_H
30 #define LATTICES_LATTICEREGION_H
34 #include <casacore/casa/aips.h>
35 #include <casacore/lattices/Lattices/Lattice.h>
36 #include <casacore/casa/Arrays/Slicer.h>
Specify which elements to extract from an n-dimensional array.
virtual size_t nelements() const
Returns the total number of elements in this LatticeRegion.
A Vector of integers, for indexing into Array<T> objects.
virtual Bool doGetSlice(Array< Bool > &buffer, const Slicer §ion)
Do the actual getting of the mask.
virtual void flush()
Flush the data (but do not unlock).
Bool hasMask() const
Has the region a mask?
virtual void putAt(const Bool &value, const IPosition &where)
Put the value of a single element.
LatticeRegion(const LatticeRegion &other)
Copy constructor (reference semantics).
virtual void showCacheStatistics(ostream &os) const
Report on cache success.
LatticeRegion & operator=(const LatticeRegion &other)
Assignment (reference semantics).
LatticeRegion(const Slicer &slicer, const IPosition &latticeShape)
Construct from the given slicer.
Map a domain object into a range object via operator().
LockType
Define the possible lock types.
virtual void reopen()
Explicitly reopen the temporarily closed lattice.
virtual void set(const Bool &value)
The following "put" functions are described in detail in class Lattice.
An optionally strided region in a Lattice.
virtual void apply(const Functional< Bool, Bool > &function)
virtual uInt maximumCacheSize() const
Maximum size - not necessarily all used.
virtual IPosition doNiceCursorShape(uInt maxPixels) const
Help the user pick a cursor for most efficient access.
LatticeRegion(const LCRegion ®ion)
Create from the given region.
virtual void apply(Bool(*function)(const Bool &))
virtual uInt ndim() const
Returns the number of axes in this LatticeRegion.
virtual Bool hasLock(FileLocker::LockType) const
LatticeRegion(LCRegion *region)
Create from the given region and take over the pointer.
virtual IPosition shape() const
Returns the shape of the LatticeRegion including all degenerate axes (i.e.
LatticeExprNode value(const LatticeExprNode &expr)
This function returns the value of the expression without a mask.
Abstract base class to steer lattice iterators.
virtual void setMaximumCacheSize(uInt howManyPixels)
Set the maximum (allowed) cache size as indicated.
virtual void resync()
Resynchronize the PagedArray object with the lattice file.
virtual Bool lock(FileLocker::LockType, uInt nattempts)
Handle the (un)locking.
IPosition convert(const IPosition &position) const
virtual void copyData(const Lattice< Bool > &from)
Copy the data from the given lattice to this one.
Abstract base class to define a region of interest in lattice coordinates.
virtual LatticeIterInterface< Bool > * makeIter(const LatticeNavigator &navigator, Bool useRef) const
This function is used by the LatticeIterator class to generate an iterator of the correct type for th...
virtual void setCacheSizeFromPath(const IPosition &sliceShape, const IPosition &windowStart, const IPosition &windowLength, const IPosition &axisPath)
Set the cache size as to "fit" the indicated path.
const Slicer & slicer() const
Get the Slicer object describing the region.
virtual Bool isWritable() const
Is the LatticeRegion writable?
this file contains all the compiler specific defines
Slicer convert(const Slicer &slicer) const
Convert positions to positions in the parent object.
virtual Lattice< Bool > * clone() const
Make a copy of the object (reference semantics).
virtual void clearCache()
Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSiz...
A templated, abstract base class for array-like objects.
virtual uInt advisedMaxPixels() const
Returns the maximum recommended number of pixels for a cursor.
virtual void doPutSlice(const Array< Bool > &sourceBuffer, const IPosition &where, const IPosition &stride)
Do the actual putting of the mask.
virtual void apply(Bool(*function)(Bool))
Replace every element, x, of the Lattice with the result of f(x).
bool Bool
Define the standard types used by Casacore.
virtual void tempClose()
Temporarily close the lattice.
LatticeRegion()
The default constructor creates a LatticeRegion that is useless for just about everything,...
const LCRegion & region() const
Get the LCRegion object describing the region.
virtual void setCacheSizeInTiles(uInt howManyTiles)
Set the actual cache size for this Array to be be big enough for the indicated number of tiles.
A base class for Lattice iterators.
virtual Bool ok() const
Check class internals - used for debugging.