casacore::WCLELMask Class Reference

Class to define a mask as a LEL expression. More...

#include <WCLELMask.h>

Inheritance diagram for casacore::WCLELMask:

Public Member Functions
	WCLELMask ()
	WCLELMask (const String &command)
	Construct from the given expression command.
	WCLELMask (const char *command)
	WCLELMask (const ImageExpr< Bool > &expr)
	Construct from the given image expression.
	WCLELMask (const LatticeExpr< Bool > &expr)
	Construct from the given lattice expression.
	WCLELMask (const LatticeExprNode &expr)
	Construct from the given lattice expression.
	WCLELMask (const WCLELMask &other)
	Copy constructor (copy semantics).
virtual	~WCLELMask ()
	Destructor.
WCLELMask &	operator= (const WCLELMask &other)
	Assignment (copy semantics).
virtual Bool	operator== (const WCRegion &other) const
	Comparison.
virtual WCRegion *	cloneRegion () const
	Clone a WCLELMask object.
virtual uInt	ndim () const
	Get the dimensionality (i.e.
virtual Bool	canExtend () const
	WCLELMask cannot extend a region.
virtual LCRegion *	toLCRegion (const CoordinateSystem &cSys, const IPosition &latticeShape) const
	Convert to an LCRegion using the given new coordinate system and shape.
virtual LCRegion *	doToLCRegion (const CoordinateSystem &cSys, const IPosition &latticeShape, const IPosition &pixelAxesMap, const IPosition &outOrder) const
	Convert to an LCRegion using the supplied `CoordinateSystem` and shape.
virtual TableRecord	toRecord (const String &tableName) const
	Convert the WCLELMask object to a record.
virtual String	type () const
	Return region type.
const ImageExpr< Bool > *	getImageExpr () const
Static Public Member Functions
static WCLELMask *	fromRecord (const TableRecord &rec, const String &tableName)
	Convert to a WCLELMask from a record.
static String	className ()
	Returns WCLELMask.
Private Member Functions
void	processCommand ()
	Process the command.
void	init (const LatticeExprNode &expr)
	Initialize as a LatticeExprNode if expression's shape is unknown.
Private Attributes
String	itsCommand
ImageExpr< Bool > *	itsImageExpr
LatticeExpr< Bool > *	itsLattExpr
LatticeExprNode *	itsLattNode

Detailed Description

Class to define a mask as a LEL expression.

Intended use:

Public interface

Prerequisite

Synopsis

The WCLELMask class is a specialization of class WCRegion .
It can be used to define an on-the-fly mask for an image 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 image(s) used in the expression change.
Caution: This mask is only persistent if constructed from an expression string; When constructed from an ImageExpr the mask is not persistent;

Example

Motivation

Users must be able to specify a mask based on an expression.

Definition at line 92 of file WCLELMask.h.

Constructor & Destructor Documentation

casacore::WCLELMask::WCLELMask ( )

casacore::WCLELMask::WCLELMask ( const String & command ) [explicit]

Construct from the given expression command.

The command will be parsed and converted to an ImageExpr.

casacore::WCLELMask::WCLELMask ( const char * command ) [explicit]

casacore::WCLELMask::WCLELMask ( const ImageExpr< Bool > & expr ) [explicit]

Construct from the given image expression.

casacore::WCLELMask::WCLELMask ( const LatticeExpr< Bool > & expr ) [explicit]

Construct from the given lattice expression.

casacore::WCLELMask::WCLELMask ( const LatticeExprNode & expr ) [explicit]

Construct from the given lattice expression.

This constructor makes it possible to have an expression with an unknown shape (e.g. using LEL function INDEXIN). If the shape is known, the LatticeExprNode will be converted to a LatticeExpr<Bool>.

casacore::WCLELMask::WCLELMask ( const WCLELMask & other )

Copy constructor (copy semantics).

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

Destructor.

Member Function Documentation

virtual Bool casacore::WCLELMask::canExtend ( ) const [virtual]

WCLELMask cannot extend a region.

Reimplemented from casacore::WCRegion.

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

Returns WCLELMask.

virtual WCRegion* casacore::WCLELMask::cloneRegion ( ) const [virtual]

Clone a WCLELMask object.

Implements casacore::WCRegion.

virtual LCRegion* casacore::WCLELMask::doToLCRegion	(	const CoordinateSystem &	cSys,
		const IPosition &	latticeShape,
		const IPosition &	pixelAxesMap,
		const IPosition &	outOrder
	)			const `[virtual]`

Convert to an LCRegion using the supplied CoordinateSystem and shape.

It checks that coordinates match and that axes are not swapped.

Implements casacore::WCRegion.

static WCLELMask* casacore::WCLELMask::fromRecord	(	const TableRecord &	rec,
		const String &	tableName
	)			`[static]`

Convert to a WCLELMask from a record.

Reimplemented from casacore::WCRegion.

const ImageExpr<Bool>* casacore::WCLELMask::getImageExpr ( ) const [inline]

Definition at line 169 of file WCLELMask.h.

References itsImageExpr.

void casacore::WCLELMask::init ( const LatticeExprNode & expr ) [private]

Initialize as a LatticeExprNode if expression's shape is unknown.

Otherwise as a LatticeExpr<Bool> if coordinates are unknown. Otherwise as an ImageExpr<Bool>.

virtual uInt casacore::WCLELMask::ndim ( ) const [virtual]

Get the dimensionality (i.e.

the number of axes).

Reimplemented from casacore::WCRegion.

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

Assignment (copy semantics).

Reimplemented from casacore::WCRegion.

virtual Bool casacore::WCLELMask::operator== ( const WCRegion & other ) const [virtual]

Comparison.

void casacore::WCLELMask::processCommand ( ) [private]

Process the command.

virtual LCRegion* casacore::WCLELMask::toLCRegion	(	const CoordinateSystem &	cSys,
		const IPosition &	latticeShape
	)			const `[virtual]`

Convert to an LCRegion using the given new coordinate system and shape.

If the region has coordinates, the WCRegion implementation will be called. Otherwise the LatticeExpr is returned after checking that the shape matches.

Reimplemented from casacore::WCRegion.

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

Convert the WCLELMask object to a record.

The record can be used to make the object persistent. The tableName argument can be used by derived classes (e.g. LCPagedMask) to put very large objects.

Implements casacore::WCRegion.

virtual String casacore::WCLELMask::type ( ) const [virtual]

Return region type.

Returns the class name

Implements casacore::WCRegion.