casacore::LCPagedMask Class Reference

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

#include <LCPagedMask.h>

Inheritance diagram for casacore::LCPagedMask:

Public Member Functions
	LCPagedMask ()
	LCPagedMask (const TiledShape &latticeShape, const String &tableName)
	Construct a PagedMask object for (part of) a lattice.
	LCPagedMask (const TiledShape &maskShape, const LCBox &box, const String &tableName)
	LCPagedMask (PagedArray< Bool > &mask, const LCBox &box)
	LCPagedMask (const LCPagedMask &other)
	Copy constructor (copy semantics).
virtual	~LCPagedMask ()
	Destructor.
LCPagedMask &	operator= (const LCPagedMask &other)
	Assignment (reference semantics).
virtual Bool	operator== (const LCRegion &other) const
	Comparison.
virtual LCRegion *	cloneRegion () const
	Make a copy of the derived object.
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.
virtual uInt	advisedMaxPixels () const
	Returns the maximum recommended number of pixels for a cursor.
virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	Help the user pick a cursor for most efficient access.
virtual uInt	maximumCacheSize () const
	Maximum size - not necessarily all used.
virtual void	setMaximumCacheSize (uInt howManyPixels)
	Set the maximum (allowed) cache size as indicated.
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.
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 void	clearCache ()
	Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called.
virtual void	showCacheStatistics (ostream &os) const
	Report on cache success.
virtual void	handleDelete ()
	Handle deletion of the region by deleting the associated table.
virtual void	handleRename (const String &newName, Bool overwrite)
	Handle renaming the region by renaming the associated table.
virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Handle the (un)locking.
virtual void	unlock ()
virtual Bool	hasLock (FileLocker::LockType) const
virtual void	resync ()
	Resynchronize the PagedArray object with the lattice file.
virtual void	flush ()
	Flush the data (but do not unlock).
virtual void	tempClose ()
	Temporarily close the lattice.
virtual void	reopen ()
	Explicitly reopen the temporarily closed lattice.
virtual String	type () const
	Region type.
virtual TableRecord	toRecord (const String &tableName) const
	Convert the (derived) object to a record.
virtual Bool	isWritable () const
	An LCPagedMask is writable if the underlying PagedArray is.
Static Public Member Functions
static String	className ()
	Get the class name (to store in the record).
static LCPagedMask *	fromRecord (const TableRecord &, const String &tablename)
	Convert correct object from a record.
Protected Member Functions
virtual LCRegion *	doTranslate (const Vector< Float > &translateVector, const IPosition &newLatticeShape) const
	Construct another LCPagedMask (for e.g.
Private Member Functions
	LCPagedMask (PagedArray< Bool > &mask, const IPosition &blc, const IPosition &latticeShape)
	Create the object from a record (for an existing mask).
Private Attributes
LCBox	itsBox
PagedArray< Bool >	itsMask

Detailed Description

Class to define a rectangular mask as a region.

Intended use:

Public interface

Prerequisite

LCRegion

Synopsis

The LCPagedMask class is a specialization of class LCRegion .

Example

Definition at line 66 of file LCPagedMask.h.

Constructor & Destructor Documentation

casacore::LCPagedMask::LCPagedMask ( )

casacore::LCPagedMask::LCPagedMask	(	const TiledShape &	latticeShape,
		const String &	tableName
	)

Construct a PagedMask object for (part of) a lattice.

The box defines the position of the mask. The default mask shape is the lattice shape.

casacore::LCPagedMask::LCPagedMask	(	const TiledShape &	maskShape,
		const LCBox &	box,
		const String &	tableName
	)

casacore::LCPagedMask::LCPagedMask	(	PagedArray< Bool > &	mask,
		const LCBox &	box
	)

casacore::LCPagedMask::LCPagedMask ( const LCPagedMask & other )

Copy constructor (copy semantics).

virtual casacore::LCPagedMask::~LCPagedMask ( ) [virtual]

Destructor.

casacore::LCPagedMask::LCPagedMask	(	PagedArray< Bool > &	mask,
		const IPosition &	blc,
		const IPosition &	latticeShape
	)			`[private]`

Create the object from a record (for an existing mask).

Member Function Documentation

virtual uInt casacore::LCPagedMask::advisedMaxPixels ( ) const [virtual]

Returns the maximum recommended number of pixels for a cursor.

This is the number of pixels in a tile.

Reimplemented from casacore::Lattice< Bool >.

static String casacore::LCPagedMask::className ( ) [static]

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

virtual void casacore::LCPagedMask::clearCache ( ) [virtual]

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

Reimplemented from casacore::LatticeBase.

virtual LCRegion* casacore::LCPagedMask::cloneRegion ( ) const [virtual]

Make a copy of the derived object.

Implements casacore::LCRegion.

virtual IPosition casacore::LCPagedMask::doNiceCursorShape ( uInt maxPixels ) const [virtual]

Help the user pick a cursor for most efficient access.

Reimplemented from casacore::LCRegionSingle.

virtual LCRegion* casacore::LCPagedMask::doTranslate	(	const Vector< Float > &	translateVector,
		const IPosition &	newLatticeShape
	)			const `[protected, virtual]`

Construct another LCPagedMask (for e.g.

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

Implements casacore::LCRegion.

virtual void casacore::LCPagedMask::flush ( ) [virtual]

Flush the data (but do not unlock).

Reimplemented from casacore::LatticeBase.

static LCPagedMask* casacore::LCPagedMask::fromRecord	(	const TableRecord &	,
		const String &	tablename
	)			`[static]`

Convert correct object from a record.

Reimplemented from casacore::LCRegion.

virtual void casacore::LCPagedMask::handleDelete ( ) [virtual]

Handle deletion of the region by deleting the associated table.

Reimplemented from casacore::LCRegion.

virtual void casacore::LCPagedMask::handleRename	(	const String &	newName,
		Bool	overwrite
	)			`[virtual]`

Handle renaming the region by renaming the associated table.

If overwrite=False, an exception will be thrown if a table with the new name already exists.

Reimplemented from casacore::LCRegion.

virtual Bool casacore::LCPagedMask::hasLock ( FileLocker::LockType ) const [virtual]

Reimplemented from casacore::LatticeBase.

virtual Bool casacore::LCPagedMask::isWritable ( ) const [virtual]

An LCPagedMask is writable if the underlying PagedArray is.

Reimplemented from casacore::LCRegion.

virtual Bool casacore::LCPagedMask::lock	(	FileLocker::LockType	,
		uInt	nattempts
	)			`[virtual]`

Handle the (un)locking.

Reimplemented from casacore::LatticeBase.

virtual LatticeIterInterface<Bool>* casacore::LCPagedMask::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.

virtual uInt casacore::LCPagedMask::maximumCacheSize ( ) const [virtual]

Maximum size - not necessarily all used.

In pixels.

Reimplemented from casacore::LatticeBase.

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

Assignment (reference semantics).

Reimplemented from casacore::LCRegionSingle.

virtual Bool casacore::LCPagedMask::operator== ( const LCRegion & other ) const [virtual]

Comparison.

virtual void casacore::LCPagedMask::reopen ( ) [virtual]

Explicitly reopen the temporarily closed lattice.

Reimplemented from casacore::LatticeBase.

virtual void casacore::LCPagedMask::resync ( ) [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 void casacore::LCPagedMask::setCacheSizeFromPath	(	const IPosition &	sliceShape,
		const IPosition &	windowStart,
		const IPosition &	windowLength,
		const IPosition &	axisPath
	)			`[virtual]`

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

Reimplemented from casacore::LatticeBase.

virtual void casacore::LCPagedMask::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.

Reimplemented from casacore::LatticeBase.

virtual void casacore::LCPagedMask::setMaximumCacheSize ( uInt howManyPixels ) [virtual]

Set the maximum (allowed) cache size as indicated.

Reimplemented from casacore::LatticeBase.

virtual void casacore::LCPagedMask::showCacheStatistics ( ostream & os ) const [virtual]

Report on cache success.

Reimplemented from casacore::LatticeBase.

virtual void casacore::LCPagedMask::tempClose ( ) [virtual]

Temporarily close the lattice.

It will be reopened automatically on the next access.

Reimplemented from casacore::LatticeBase.

virtual TableRecord casacore::LCPagedMask::toRecord ( const String & tableName ) const [virtual]