Go to the documentation of this file.
28 #ifndef LATTICES_LCMASK_H
29 #define LATTICES_LCMASK_H
33 #include <casacore/casa/aips.h>
34 #include <casacore/lattices/LRegions/LCBox.h>
35 #include <casacore/lattices/Lattices/Lattice.h>
virtual void setCacheSizeInTiles(uInt howManyTiles)
Set the actual cache size for this Array to be be big enough for the indicated number of tiles.
virtual uInt advisedMaxPixels() const
Returns the maximum recommended number of pixels for a cursor.
A Vector of integers, for indexing into Array<T> objects.
virtual Bool operator==(const LCRegion &other) const
Comparison.
A hierarchical collection of named fields of various types.
virtual void clearCache()
Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSiz...
Class to define a rectangular box of interest.
LockType
Define the possible lock types.
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.
LCMask(Lattice< Bool > &mask, const LCBox &box)
Construct an LCMask object for the part of a lattice given by the box.
virtual TableRecord toRecord(const String &tableName) const
Convert the (derived) object to a record.
virtual void reopen()
Explicitly reopen the temporarily closed lattice.
virtual uInt maximumCacheSize() const
Maximum size - not necessarily all used.
virtual Bool hasLock(FileLocker::LockType) const
Abstract base class to steer lattice iterators.
virtual IPosition doNiceCursorShape(uInt maxPixels) const
Help the user pick a cursor for most efficient access.
LCMask & operator=(const LCMask &other)
Assignment (reference semantics).
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 resync()
Resynchronize the object with the contenta tof the possible file.
virtual ~LCMask()
Destructor.
LCMask(const IPosition &maskShape, const LCBox &box)
Construct an LCMask object for the part of a lattice given by the box.
LCMask(const IPosition &latticeShape)
Construct an LCMask object for a full lattice with the given shape.
LCMask(Lattice< Bool > &mask)
Construct an LCMask object for a full lattice with the shape of the mask.
Abstract base class to define a region of interest in lattice coordinates.
Lattice< Bool > * itsMask
this file contains all the compiler specific defines
virtual LCRegion * doTranslate(const Vector< Float > &translateVector, const IPosition &newLatticeShape) const
Construct another LCMask (for e.g.
Class to define a rectangular mask as a temporary region.
Abstract base class to define a single region.
virtual void flush()
Flush the data (but do not unlock).
static String className()
Get the class name (to store in the record).
const IPosition & latticeShape() const
Give the full lattice shape.
LatticeExprNode mask(const LatticeExprNode &expr)
This function returns the mask of the given expression.
LCMask(const LCMask &other)
Copy constructor (copy semantics).
String: the storage and methods of handling collections of characters.
virtual LCRegion * cloneRegion() const
Make a copy of the derived object.
virtual void tempClose()
Temporarily close the lattice.
bool Bool
Define the standard types used by Casacore.
virtual Bool isWritable() const
An LCMask is writable if the underlying Lattice is.
virtual Bool lock(FileLocker::LockType, uInt nattempts)
Handle the (un)locking.
virtual void showCacheStatistics(ostream &os) const
Report on cache success.
virtual void setMaximumCacheSize(uInt howManyPixels)
Set the maximum (allowed) cache size as indicated.
virtual String type() const
Region type.
A base class for Lattice iterators.