casacore
|
Class to define a mask as a LEL expression. More...
#include <LCLELMask.h>
Public Member Functions | |
LCLELMask () | |
LCLELMask (const LatticeExpr< Bool > &expr) | |
Construct from vectors of world coordinates defining the box corners. More... | |
LCLELMask (const LCLELMask &other) | |
Copy constructor (copy semantics). More... | |
virtual | ~LCLELMask () |
Destructor. More... | |
LCLELMask & | operator= (const LCLELMask &other) |
Assignment (copy semantics) More... | |
virtual Bool | operator== (const LCRegion &other) const |
Comparison. More... | |
virtual LCRegion * | cloneRegion () const |
Clone a LCLELMask object. More... | |
virtual Bool | lock (FileLocker::LockType, uInt nattempts) |
Handle the (un)locking. More... | |
virtual void | unlock () |
virtual Bool | hasLock (FileLocker::LockType) const |
virtual void | resync () |
Resynchronize the PagedArray object with the lattice file. More... | |
virtual void | tempClose () |
Temporarily close the lattice. More... | |
virtual void | reopen () |
Explicitly reopen the temporarily closed lattice. More... | |
virtual String | type () const |
Return region type. More... | |
virtual TableRecord | toRecord (const String &tableName) const |
Convert the LCLELMask object to a record. More... | |
![]() | |
LCRegionSingle () | |
LCRegionSingle (const IPosition &latticeShape) | |
Construct with the lattice shape only. More... | |
LCRegionSingle (const LCRegionSingle &other) | |
Copy constructor (copy semantics). More... | |
virtual | ~LCRegionSingle () |
virtual Bool | hasMask () const |
Does the region have a mask? More... | |
const Array< Bool > | maskArray () const |
Get the mask (as an array). More... | |
Bool | masksEqual (const LCRegion &other) const |
Is the mask of this region the same as the mask of the other. More... | |
virtual void | set (const Bool &value) |
The following "put" functions are described in detail in class Lattice . More... | |
virtual void | apply (Bool(*function)(Bool)) |
Replace every element, x, of the Lattice with the result of f(x). More... | |
virtual void | apply (Bool(*function)(const Bool &)) |
virtual void | apply (const Functional< Bool, Bool > &function) |
virtual void | putAt (const Bool &value, const IPosition &where) |
Put the value of a single element. More... | |
virtual void | copyData (const Lattice< Bool > &from) |
Copy the data from the given lattice to this one. More... | |
![]() | |
LCRegion () | |
LCRegion (const IPosition &latticeShape) | |
Construct with the lattice shape only. More... | |
LCRegion (const LCRegion &other) | |
Copy constructor (copy semantics). More... | |
virtual | ~LCRegion () |
Bool | operator!= (const LCRegion &other) const |
Non-equality. More... | |
virtual Lattice< Bool > * | clone () const |
Make a copy of the derived object. More... | |
virtual void | handleDelete () |
Handle deletion of the region by deleting possible tables. More... | |
virtual void | handleRename (const String &newName, Bool overwrite) |
Handle renaming the region by renaming possible tables. More... | |
const String & | comment () const |
Get or set the comment. More... | |
void | setComment (const String &comment) |
LCRegion * | translate (const IPosition &translateVector) const |
Construct another LCRegion (for e.g. More... | |
LCRegion * | translate (const IPosition &translateVector, const IPosition &newLatticeShape) const |
LCRegion * | translate (const Vector< Float > &translateVector) const |
LCRegion * | translate (const Vector< Float > &translateVector, const IPosition &newLatticeShape) const |
const IPosition & | latticeShape () const |
Give the full lattice shape. More... | |
const Slicer & | boundingBox () const |
Give the bounding box. More... | |
Slicer | expand (const Slicer &slicer) const |
Expand a slicer or position in the region to the full lattice. More... | |
IPosition | expand (const IPosition &index) const |
virtual uInt | ndim () const |
Return the dimensionality of the region. More... | |
virtual IPosition | shape () const |
Return the shape of the region (i.e. More... | |
virtual Bool | isWritable () const |
Usually the lattice (i.e. More... | |
![]() | |
virtual | ~Lattice () |
a virtual destructor is needed so that it will use the actual destructor in the derived class More... | |
virtual DataType | dataType () const |
Get the data type of the lattice. More... | |
Bool | operator() (const IPosition &where) const |
Return the value of the single element located at the argument IPosition. More... | |
virtual Bool | getAt (const IPosition &where) const |
Bool | get (COWPtr< Array< Bool > > &buffer, Bool removeDegenerateAxes=False) const |
Functions which extract an Array of values from a Lattice. More... | |
Bool | get (Array< Bool > &buffer, Bool removeDegenerateAxes=False) |
Array< Bool > | get (Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< Bool > > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
Bool | getSlice (Array< Bool > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) |
Bool | getSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) |
Bool | getSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) |
Array< Bool > | getSlice (const Slicer §ion, Bool removeDegenerateAxes=False) const |
Array< Bool > | getSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Array< Bool > | getSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
void | putSlice (const Array< Bool > &sourceBuffer, const IPosition &where, const IPosition &stride) |
A function which places an Array of values within this instance of the Lattice at the location specified by the IPosition "where", incrementing by "stride". More... | |
void | putSlice (const Array< Bool > &sourceBuffer, const IPosition &where) |
void | put (const Array< Bool > &sourceBuffer) |
void | operator+= (const Lattice< Bool > &other) |
Add, subtract, multiple, or divide by another Lattice. More... | |
void | operator-= (const Lattice< Bool > &other) |
void | operator*= (const Lattice< Bool > &other) |
void | operator/= (const Lattice< Bool > &other) |
virtual void | copyDataTo (Lattice< Bool > &to) const |
Copy the data from this lattice to the given lattice. More... | |
virtual uInt | advisedMaxPixels () const |
This function returns the advised maximum number of pixels to include in the cursor of an iterator. More... | |
![]() | |
virtual | ~LatticeBase () |
A virtual destructor is needed so that it will use the actual destructor in the derived class. More... | |
virtual String | imageType () const |
Get the image type (returns name of derived class). More... | |
virtual Bool | isPersistent () const |
Is the lattice persistent and can it be loaded by other processes as well? That is the case for a PagedArray or PagedImage and for an ImageExpr which does not use transient lattices or regions. More... | |
virtual Bool | isPaged () const |
Is the lattice paged to disk? The default implementation returns False. More... | |
virtual Bool | canReferenceArray () const |
Can the lattice data be referenced as an array section? That is the case for an ArrayLattice or a Temp/SubLattice using it. More... | |
virtual void | save (const String &fileName) const |
Save the image in an AipsIO file with the given name. More... | |
virtual void | flush () |
Flush the data (but do not unlock). More... | |
virtual String | name (Bool stripPath=False) const |
Return the name of the current Lattice object. More... | |
virtual size_t | nelements () const |
Return the total number of elements in this Lattice. More... | |
size_t | size () const |
Bool | conform (const LatticeBase &other) const |
Return a value of "True" if this instance of Lattice and 'other' have the same shape, otherwise returns a value of "False". More... | |
virtual LELCoordinates | lelCoordinates () const |
Return the coordinates of the lattice. More... | |
IPosition | niceCursorShape (uInt maxPixels) const |
Returns a recommended cursor shape for iterating through all the pixels in the Lattice. More... | |
IPosition | niceCursorShape () const |
virtual Bool | ok () const |
Check class internals - used for debugging. More... | |
virtual uInt | maximumCacheSize () const |
Maximum cache size - not necessarily all used. More... | |
virtual void | setMaximumCacheSize (uInt howManyPixels) |
Set the maximum (allowed) cache size as indicated. More... | |
virtual void | setCacheSizeInTiles (uInt howManyTiles) |
Set the actual cache size for this Array to be big enough for the indicated number of tiles. More... | |
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. More... | |
virtual void | clearCache () |
Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called. More... | |
virtual void | showCacheStatistics (ostream &os) const |
Report on cache success. More... | |
Static Public Member Functions | |
static String | className () |
Returns LCLELMask. More... | |
![]() | |
static LCRegion * | fromRecord (const TableRecord &, const String &tableName) |
Convert correct object from a record. More... | |
Protected Member Functions | |
virtual LCRegion * | doTranslate (const Vector< Float > &translateVector, const IPosition &newLatticeShape) const |
Translating an LCLELMask is not possible, so it throws an exception. More... | |
![]() | |
LCRegionSingle & | operator= (const LCRegionSingle &other) |
Assignment (copy semantics) is only useful for derived classes. More... | |
void | setMaskPtr (Lattice< Bool > &mask) |
Set the pointer to the mask in the derived class. More... | |
virtual Bool | doGetSlice (Array< Bool > &buffer, const Slicer §ion) |
Do the actual getting of the mask. More... | |
virtual void | doPutSlice (const Array< Bool > &sourceBuffer, const IPosition &where, const IPosition &stride) |
Do the actual putting of the mask. More... | |
virtual IPosition | doNiceCursorShape (uInt maxPixels) const |
Get the best cursor shape. More... | |
virtual LatticeIterInterface< Bool > * | makeIter (const LatticeNavigator &navigator, Bool useRef) const |
Make an iterator. More... | |
![]() | |
LCRegion & | operator= (const LCRegion &other) |
Assignment (copy semantics) is only useful for derived classes. More... | |
void | setBoundingBox (const Slicer &boundingBox) |
Sometimes it is inconvenient for a derived class to set the bounding box in the constructor. More... | |
void | setShapeAndBoundingBox (const IPosition &latticeShape, const Slicer &boundingBox) |
void | defineRecordFields (RecordInterface &record, const String &className) const |
Define the type and class name in the record. More... | |
![]() | |
Lattice () | |
Define default constructor to satisfy compiler. More... | |
Lattice (const Lattice< Bool > &) | |
Copy constructor and assignment can only be used by derived classes. More... | |
virtual void | handleMath (const Lattice< Bool > &from, int oper) |
Handle the Math operators (+=, -=, *=, /=). More... | |
virtual void | handleMathTo (Lattice< Bool > &to, int oper) const |
Lattice< Bool > & | operator= (const Lattice< Bool > &) |
![]() | |
LatticeBase () | |
Define default constructor to be used by derived classes. More... | |
LatticeBase (const LatticeBase &) | |
Copy constructor and assignment can only be used by derived classes. More... | |
LatticeBase & | operator= (const LatticeBase &) |
void | throwBoolMath () const |
Throw an exception for arithmetic on a Bool Lattice. More... | |
Private Attributes | |
LCBox | itsBox |
LatticeExpr< Bool > | itsExpr |
Class to define a mask as a LEL expression.
Public interface
The LCLELMask class is a specialization of class LCRegion .
It can be used to define an on-the-fly mask for a lattice using a boolean LatticeExpr . The contents of the mask are calculated on the fly from the expression. Thus the mask may change if the data in the lattice(s) used in the expression change.
Caution: This mask is not persistent, thus it cannot be saved with an image; Use class WCLELMask to have a persistent on-the-fly mask; It means that normally a WCLELMask should be used (which gets converted to an LCLELMask when applied to an image);
LCLELMask is needed to make
Definition at line 88 of file LCLELMask.h.
casacore::LCLELMask::LCLELMask | ( | ) |
|
explicit |
Construct from vectors of world coordinates defining the box corners.
It is assumed that the order of the values is in the order of the pixel axes.
casacore::LCLELMask::LCLELMask | ( | const LCLELMask & | other | ) |
Copy constructor (copy semantics).
|
virtual |
Destructor.
|
virtual |
Clone a LCLELMask object.
Implements casacore::LCRegion.
|
protectedvirtual |
Translating an LCLELMask is not possible, so it throws an exception.
Implements casacore::LCRegion.
|
virtual |
Reimplemented from casacore::LatticeBase.
|
virtual |
Handle the (un)locking.
Reimplemented from casacore::LatticeBase.
Comparison.
Reimplemented from casacore::LCRegion.
|
virtual |
Explicitly reopen the temporarily closed lattice.
Reimplemented from casacore::LatticeBase.
|
virtual |
Resynchronize the PagedArray 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.
Reimplemented from casacore::LatticeBase.
|
virtual |
Temporarily close the lattice.
It will be reopened automatically on the next access.
Reimplemented from casacore::LatticeBase.
|
virtual |
Convert the LCLELMask object to a record.
This cannot be done as a Lattice expression cannot be made persistent (only Image expressions can, thus only WCLELMask is persistent).
So this function throws an exception.
Implements casacore::LCRegion.
|
virtual |
|
virtual |
Reimplemented from casacore::LatticeBase.
|
private |
Definition at line 153 of file LCLELMask.h.
|
private |
Definition at line 154 of file LCLELMask.h.