casacore::RegionHandlerMemory Class Reference

Class for keeping regions in memory. More...

#include <RegionHandlerMemory.h>

Inheritance diagram for casacore::RegionHandlerMemory:

Public Member Functions
	RegionHandlerMemory ()
	RegionHandlerMemory (const RegionHandlerMemory &)
virtual	~RegionHandlerMemory ()
RegionHandlerMemory &	operator= (const RegionHandlerMemory &)
virtual RegionHandlerMemory *	clone () const
	Make a copy of the object.
virtual Bool	canDefineRegion () const
	Can the class indeed define and handle regions? The default implementation returns False.
virtual void	setDefaultMask (const String &maskName)
	Set the default mask to the mask with the given name.
virtual String	getDefaultMask () const
	Get the name of the default mask.
virtual Bool	defineRegion (const String &name, const ImageRegion &region, RegionHandler::GroupType, Bool overwrite=False)
	Define a region belonging to the table.
virtual Bool	hasRegion (const String &name, RegionHandler::GroupType=RegionHandler::Any) const
	Does the table have a region with the given name?
virtual ImageRegion *	getRegion (const String &name, RegionHandler::GroupType=Any, Bool throwIfUnknown=True) const
	Get a region belonging to the table.
virtual Bool	renameRegion (const String &newName, const String &oldName, RegionHandler::GroupType=Any, Bool overwrite=False)
	Rename a region.
virtual Bool	removeRegion (const String &name, RegionHandler::GroupType=Any, Bool throwIfUnknown=True)
	Remove a region belonging to the table.
virtual Vector< String >	regionNames (RegionHandler::GroupType=Any) const
	Get the names of all regions/masks.
virtual ImageRegion	makeMask (const LatticeBase &lattice, const String &name)
	Make a mask for a lattice (e.g.
Private Member Functions
Int	findRegionGroup (const String &regionName, RegionHandler::GroupType=Any, Bool throwIfUnknown=True) const
virtual ImageRegion *	findRegion (const String &name, RegionHandler::GroupType=Any, Bool throwIfUnknown=True) const
void	clear ()
Private Attributes
String	itsDefaultName
SimpleOrderedMap< String, void * > *	itsMaps [2]

Detailed Description

Class for keeping regions in memory.

Intended use:

Internal

Review Status

Test programs:: tPagedImage2

Prerequisite

Synopsis

Persistent regions are stored as subrecords of the table keywords "regions" and "masks". The user can choose one of both keywords. Keyword "masks" is meant for true image masks, i.e. telling for each pixel if it is good or bad. Keyword "regions" is meant for true regions in an image.

This class handles defining, getting and removing such regions. It is used by class

Definition at line 88 of file RegionHandlerMemory.h.

Constructor & Destructor Documentation

casacore::RegionHandlerMemory::RegionHandlerMemory ( )

casacore::RegionHandlerMemory::RegionHandlerMemory ( const RegionHandlerMemory & )

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

Member Function Documentation

virtual Bool casacore::RegionHandlerMemory::canDefineRegion ( ) const [virtual]

Can the class indeed define and handle regions? The default implementation returns False.

Reimplemented from casacore::RegionHandler.

void casacore::RegionHandlerMemory::clear ( ) [private]

virtual RegionHandlerMemory* casacore::RegionHandlerMemory::clone ( ) const [virtual]

Make a copy of the object.

Reimplemented from casacore::RegionHandler.

virtual Bool casacore::RegionHandlerMemory::defineRegion	(	const String &	name,
		const ImageRegion &	region,
		RegionHandler::GroupType	,
		Bool	overwrite = `False`
	)			`[virtual]`

Define a region belonging to the table.

The group type determines if it stored as a region or mask. If overwrite=False, an exception will be thrown if the region already exists in the "regions" or "masks" keyword. Otherwise the region will be removed first.
A False status is returned if the table is not writable

Reimplemented from casacore::RegionHandler.

virtual ImageRegion* casacore::RegionHandlerMemory::findRegion	(	const String &	name,
		RegionHandler::GroupType	= `Any`,
		Bool	throwIfUnknown = `True`
	)			const `[private, virtual]`

Int casacore::RegionHandlerMemory::findRegionGroup	(	const String &	regionName,
		RegionHandler::GroupType	= `Any`,
		Bool	throwIfUnknown = `True`
	)			const `[private]`

virtual String casacore::RegionHandlerMemory::getDefaultMask ( ) const [virtual]

Get the name of the default mask.

An empty string is returned if no default mask.

Reimplemented from casacore::RegionHandler.

virtual ImageRegion* casacore::RegionHandlerMemory::getRegion	(	const String &	name,
		RegionHandler::GroupType	= `Any`,
		Bool	throwIfUnknown = `True`
	)			const `[virtual]`

Get a region belonging to the table.

A zero pointer is returned if the region does not exist. The caller has to delete the ImageRegion object created.
No exception is thrown if the region does not exist.

Reimplemented from casacore::RegionHandler.

virtual Bool casacore::RegionHandlerMemory::hasRegion	(	const String &	name,
		RegionHandler::GroupType	= `RegionHandler::Any`
	)			const `[virtual]`

Does the table have a region with the given name?

Reimplemented from casacore::RegionHandler.

virtual ImageRegion casacore::RegionHandlerMemory::makeMask	(	const LatticeBase &	lattice,
		const String &	name
	)			`[virtual]`

Make a mask for a lattice (e.g.

a PagedImage or TempImage). It creates it with the shape and tile shape of the lattice.

Reimplemented from casacore::RegionHandler.

RegionHandlerMemory& casacore::RegionHandlerMemory::operator= ( const RegionHandlerMemory & )

virtual Vector<String> casacore::RegionHandlerMemory::regionNames ( RegionHandler::GroupType = Any ) const [virtual]

Get the names of all regions/masks.

Reimplemented from casacore::RegionHandler.

virtual Bool casacore::RegionHandlerMemory::removeRegion	(	const String &	name,
		RegionHandler::GroupType	= `Any`,
		Bool	throwIfUnknown = `True`
	)			`[virtual]`

Remove a region belonging to the table.

Optionally an exception is thrown if the region does not exist.
A False status is returned if the table is not writable

Reimplemented from casacore::RegionHandler.

virtual Bool casacore::RegionHandlerMemory::renameRegion	(	const String &	newName,
		const String &	oldName,
		RegionHandler::GroupType	= `Any`,
		Bool	overwrite = `False`
	)			`[virtual]`

Rename a region.

If a region with the new name already exists, it is deleted or an exception is thrown (depending on overwrite). The region name is looked up in the given group(s).
An exception is thrown if the old region name does not exist.

Reimplemented from casacore::RegionHandler.

virtual void casacore::RegionHandlerMemory::setDefaultMask ( const String & maskName ) [virtual]

Set the default mask to the mask with the given name.

It constructs a ImageRegion object for the new default mask. If the table is writable, the setting is persistent by writing the name as a keyword. If the given maskName is the empty string, the default mask is unset.

Reimplemented from casacore::RegionHandler.