Class to define a rectangular mask as a temporary region. More...

#include <LCMask.h>

Public Member Functions
	LCMask ()

	LCMask (const IPosition &latticeShape)
	Construct an LCMask object for a full lattice with the given shape. More...

	LCMask (Lattice< Bool > &mask)
	Construct an LCMask object for a full lattice with the shape of the mask. More...

	LCMask (const IPosition &maskShape, const LCBox &box)
	Construct an LCMask object for the part of a lattice given by the box. More...

	LCMask (Lattice< Bool > &mask, const LCBox &box)
	Construct an LCMask object for the part of a lattice given by the box. More...

	LCMask (const LCMask &other)
	Copy constructor (copy semantics). More...

virtual	~LCMask ()
	Destructor. More...

LCMask &	operator= (const LCMask &other)
	Assignment (reference semantics). More...

virtual Bool	operator== (const LCRegion &other) const
	Comparison. More...

virtual LCRegion *	cloneRegion () const
	Make a copy of the derived object. More...

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 this Lattice. More...

virtual uInt	advisedMaxPixels () const
	Returns the maximum recommended number of pixels for a cursor. More...

virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	Help the user pick a cursor for most efficient access. More...

virtual uInt	maximumCacheSize () const
	Maximum size - not necessarily all used. More...

virtual void	setMaximumCacheSize (uInt howManyPixels)
	Set the maximum (allowed) cache size as indicated. 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	setCacheSizeInTiles (uInt howManyTiles)
	Set the actual cache size for this Array to be be big enough for the indicated number of tiles. 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...

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 object with the contenta tof the possible file. More...

virtual void	flush ()
	Flush the data (but do not unlock). More...

virtual void	tempClose ()
	Temporarily close the lattice. More...

virtual void	reopen ()
	Explicitly reopen the temporarily closed lattice. More...

virtual String	type () const
	Region type. More...

virtual TableRecord	toRecord (const String &tableName) const
	Convert the (derived) object to a record. More...

virtual Bool	isWritable () const
	An LCMask is writable if the underlying Lattice is. More...

Public Member Functions inherited from casacore::LCRegionSingle
	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...

Public Member Functions inherited from casacore::LCRegion
	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...

Public Member Functions inherited from casacore::Lattice< Bool >
virtual	~Lattice ()
	a virtual destructor is needed so that it will use the actual destructor in the derived class More...

virtual Lattice< Bool > *	clone () const=0
	Make a copy of the derived object (reference semantics). 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 &section, 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 &section, 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 &section, 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...

Static Public Member Functions
static String	className ()
	Get the class name (to store in the record). More...

Static Public Member Functions inherited from casacore::LCRegion
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
	Construct another LCMask (for e.g. More...

Protected Member Functions inherited from casacore::LCRegionSingle
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 &section)
	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...

Protected Member Functions inherited from casacore::LCRegion
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...

Protected Member Functions inherited from casacore::Lattice< Bool >
	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

void	handleMathTo (Lattice< Bool > &, int) const

Lattice< Bool > &	operator= (const Lattice< Bool > &)

Private Attributes
LCBox	itsBox

Lattice< Bool > *	itsMask

Detailed Description

Class to define a rectangular mask as a temporary region.

Intended use:

Public interface

Prerequisite

LCRegion

Synopsis

The LCMask class is a specialization of class LCRegion.
It can be used to define a temporary mask (e.g. for a TempImage). It is possible to define the mask for the full lattice, but one can also define it for part of a lattice. In the latter case a LCBox has to be given as well to define for which part of the image the mask has to be used.

Example

Definition at line 73 of file LCMask.h.

Constructor & Destructor Documentation

◆ LCMask() [1/6]

casacore::LCMask::LCMask ( )

◆ LCMask() [2/6]

casacore::LCMask::LCMask ( const IPosition & latticeShape )

explicit

Construct an LCMask object for a full lattice with the given shape.

It creates a TempLattice<Bool> to hold the mask.

◆ LCMask() [3/6]

casacore::LCMask::LCMask ( Lattice< Bool > & mask )

explicit

Construct an LCMask object for a full lattice with the shape of the mask.

It clones the mask object.

◆ LCMask() [4/6]

casacore::LCMask::LCMask	(	const IPosition &	maskShape,
		const LCBox &	box
	)

Construct an LCMask object for the part of a lattice given by the box.

The box defines the position of the mask in the lattice. The box shape and given mask shape should be equal. It creates a TempImage<Bool> to hold the mask.

◆ LCMask() [5/6]

casacore::LCMask::LCMask	(	Lattice< Bool > &	mask,
		const LCBox &	box
	)

Construct an LCMask object for the part of a lattice given by the box.

The box defines the position of the mask in the lattice. The box shape and given mask shape should be equal. It clones the mask object.

◆ LCMask() [6/6]

casacore::LCMask::LCMask ( const LCMask & other )

Copy constructor (copy semantics).

◆ ~LCMask()

virtual casacore::LCMask::~LCMask ( )

virtual

Destructor.

Member Function Documentation

◆ advisedMaxPixels()

virtual uInt casacore::LCMask::advisedMaxPixels ( ) const

virtual

Returns the maximum recommended number of pixels for a cursor.

This is the number of pixels in a tile.

◆ className()

static String casacore::LCMask::className ( )

static

Get the class name (to store in the record).

◆ clearCache()

virtual void casacore::LCMask::clearCache ( )

virtual

Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called.

◆ cloneRegion()

virtual LCRegion* casacore::LCMask::cloneRegion ( ) const

virtual

Make a copy of the derived object.

Implements casacore::LCRegion.

◆ doNiceCursorShape()

virtual IPosition casacore::LCMask::doNiceCursorShape ( uInt maxPixels ) const

virtual

Help the user pick a cursor for most efficient access.

Reimplemented from casacore::LCRegionSingle.

◆ doTranslate()

virtual LCRegion* casacore::LCMask::doTranslate	(	const Vector< Float > &	translateVector,
		const IPosition &	newLatticeShape
	)		const

protectedvirtual

Construct another LCMask (for e.g.

another lattice) by moving this one. It recalculates the bounding mask. A positive translation value indicates "to right".

Implements casacore::LCRegion.

◆ flush()

virtual void casacore::LCMask::flush ( )

virtual

Flush the data (but do not unlock).

◆ hasLock()

virtual Bool casacore::LCMask::hasLock ( FileLocker::LockType ) const

virtual

◆ isWritable()

virtual Bool casacore::LCMask::isWritable ( ) const

virtual

An LCMask is writable if the underlying Lattice is.

Reimplemented from casacore::LCRegion.

◆ lock()

virtual Bool casacore::LCMask::lock	(	FileLocker::LockType	,
		uInt	nattempts
	)

virtual

Handle the (un)locking.

◆ makeIter()

virtual LatticeIterInterface<Bool>* casacore::LCMask::makeIter	(	const LatticeNavigator &	navigator,
		Bool	useRef
	)		const

virtual

This function is used by the LatticeIterator class to generate an iterator of the correct type for this Lattice.

Not recommended for general use.

Reimplemented from casacore::LCRegionSingle.

◆ maximumCacheSize()

virtual uInt casacore::LCMask::maximumCacheSize ( ) const

virtual

Maximum size - not necessarily all used.

In pixels.

◆ operator=()

LCMask& casacore::LCMask::operator= ( const LCMask & other )

Assignment (reference semantics).

◆ operator==()

virtual Bool casacore::LCMask::operator== ( const LCRegion & other ) const

virtual

Comparison.

Reimplemented from casacore::LCRegion.

◆ reopen()

virtual void casacore::LCMask::reopen ( )

virtual

Explicitly reopen the temporarily closed lattice.

◆ resync()

virtual void casacore::LCMask::resync ( )

virtual

Resynchronize the object with the contenta tof the possible 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.

◆ setCacheSizeFromPath()

virtual void casacore::LCMask::setCacheSizeFromPath	(	const IPosition &	sliceShape,
		const IPosition &	windowStart,
		const IPosition &	windowLength,
		const IPosition &	axisPath
	)

virtual

Set the cache size as to "fit" the indicated path.

◆ setCacheSizeInTiles()

virtual void casacore::LCMask::setCacheSizeInTiles ( uInt howManyTiles )

virtual

Set the actual cache size for this Array to be be big enough for the indicated number of tiles.

This cache is not shared with PagedArrays in other rows and is always clipped to be less than the maximum value set using the setMaximumCacheSize member function. tiles. Tiles are cached using a first in first out algorithm.

◆ setMaximumCacheSize()

virtual void casacore::LCMask::setMaximumCacheSize ( uInt howManyPixels )

virtual

Set the maximum (allowed) cache size as indicated.

◆ showCacheStatistics()

virtual void casacore::LCMask::showCacheStatistics ( ostream & os ) const

virtual

Report on cache success.

◆ tempClose()

virtual void casacore::LCMask::tempClose ( )

virtual

Temporarily close the lattice.

It will be reopened automatically on the next access.

◆ toRecord()

virtual TableRecord casacore::LCMask::toRecord ( const String & tableName ) const

virtual

Convert the (derived) object to a record.

This cannot be done and results in an exception.

Implements casacore::LCRegion.

◆ type()

virtual String casacore::LCMask::type ( ) const

virtual

Region type.

Returns class name.

Implements casacore::LCRegion.

◆ unlock()

virtual void casacore::LCMask::unlock ( )

virtual

Member Data Documentation

◆ itsBox

LCBox casacore::LCMask::itsBox

private

Definition at line 198 of file LCMask.h.

◆ itsMask

Lattice<Bool>* casacore::LCMask::itsMask

private

Definition at line 199 of file LCMask.h.

The documentation for this class was generated from the following file:

lattices/LRegions/LCMask.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Intended use:

Prerequisite

Synopsis

Example

Constructor & Destructor Documentation

◆ LCMask() [1/6]

◆ LCMask() [2/6]

◆ LCMask() [3/6]

◆ LCMask() [4/6]

◆ LCMask() [5/6]

◆ LCMask() [6/6]

◆ ~LCMask()

Member Function Documentation

◆ advisedMaxPixels()

◆ className()

◆ clearCache()

◆ cloneRegion()

◆ doNiceCursorShape()

◆ doTranslate()

◆ flush()

◆ hasLock()

◆ isWritable()

◆ lock()

◆ makeIter()

◆ maximumCacheSize()

◆ operator=()

◆ operator==()

◆ reopen()

◆ resync()

◆ setCacheSizeFromPath()

◆ setCacheSizeInTiles()

◆ setMaximumCacheSize()

◆ showCacheStatistics()

◆ tempClose()

◆ toRecord()

◆ type()

◆ unlock()

Member Data Documentation

◆ itsBox

◆ itsMask