Ancillary information for the LEL letter classes. More...

#include <LELAttribute.h>

Public Member Functions
	LELAttribute ()
	Default constructor sets it as a scalar. More...

	LELAttribute (Bool isMasked, const IPosition &shape, const IPosition &tileShape, const LELCoordinates &coordinates, Bool isReduced=False)
	Constructor sets it as lattice with given attributes. More...

	LELAttribute (uInt regionNdim)
	Constructor sets it as a region with given attributes. More...

	LELAttribute (const LELAttribute &attr)
	Copy constructor (copy semantics) More...

	LELAttribute (const LELAttribute &attrLeft, const LELAttribute &attrRight, Bool matchAxes=True)
	Constructor that combines the two attributes given. More...

	~LELAttribute ()
	Destructor. More...

LELAttribute &	operator= (const LELAttribute &other)
	Assignment (copy semantics) More...

Bool	isScalar () const
	Is expression a scalar? More...

Bool	isReduced () const
	Is expression a reduced array? A scalar is always reduced. More...

Bool	isRegion () const
	Is expression a region? More...

Bool	isMasked () const
	Is the expression result masked? More...

const IPosition &	shape () const
	What is the shape of the expression? More...

const IPosition &	tileShape () const
	What is the tile shape of the expression? More...

const LELCoordinates &	coordinates () const
	What are the coordinates of the expression? More...

Int	compareCoord (const LELAttribute &other) const
	Compare the coordinates and shapes to see if this is a subset of other. More...

Private Attributes
Bool	isScalar_p

Bool	isReduced_p

Bool	isRegion_p

Bool	isMasked_p

IPosition	shape_p

IPosition	tileShape_p

LELCoordinates	coords_p

Detailed Description

Ancillary information for the LEL letter classes.

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Etymology

Holds attribute information for the Lattice Expression Language letter classes.

Synopsis

The Lattice Expression Language letter classes provide expression objects. There is ancilliary information or attributes associated with these objects:

Scalar or lattice (i.e. array) or region.
In case of an array, is it a reduced array. I.e. is it an array that has to be calculated beforehand (e.g. partialMax). A scalar is always reduced.
Shape and tile shape of a lattice. This can be undefined.
Is the lattice masked?
Optionally coordinates of the lattice.

Two attribute objects can be combined mirroring the combination of two expressions (like the addition of two lattices). Regions cannot be combined.

Definition at line 81 of file LELAttribute.h.

Constructor & Destructor Documentation

casacore::LELAttribute::LELAttribute ( )

Default constructor sets it as a scalar.

casacore::LELAttribute::LELAttribute	(	Bool	isMasked,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const LELCoordinates &	coordinates,
		Bool	isReduced = `False`
	)

Constructor sets it as lattice with given attributes.

An empty shape indicates that the shape is not known.

casacore::LELAttribute::LELAttribute ( uInt regionNdim )

explicit

Constructor sets it as a region with given attributes.

casacore::LELAttribute::LELAttribute ( const LELAttribute & attr )

Copy constructor (copy semantics)

casacore::LELAttribute::LELAttribute	(	const LELAttribute &	attrLeft,
		const LELAttribute &	attrRight,
		Bool	matchAxes = `True`
	)

Constructor that combines the two attributes given.

An array can be combined with a scalar. If matchAxes is True and if two arrays are given, the shapes and coordinates have to match exactly, otherwise one can be a subset of the other (and LEL will auto-extend).

casacore::LELAttribute::~LELAttribute ( )

Destructor.

Member Function Documentation

Int casacore::LELAttribute::compareCoord ( const LELAttribute & other ) const

Compare the coordinates and shapes to see if this is a subset of other.

const LELCoordinates& casacore::LELAttribute::coordinates ( ) const

inline

What are the coordinates of the expression?

Definition at line 135 of file LELAttribute.h.

References coords_p.

Bool casacore::LELAttribute::isMasked ( ) const

inline

Is the expression result masked?

Definition at line 126 of file LELAttribute.h.

References isMasked_p.

Referenced by casacore::LatticeExprNode::isMasked().

Bool casacore::LELAttribute::isReduced ( ) const

inline

Is expression a reduced array? A scalar is always reduced.

Definition at line 120 of file LELAttribute.h.

References isReduced_p.

Bool casacore::LELAttribute::isRegion ( ) const

inline

Is expression a region?

Definition at line 123 of file LELAttribute.h.

References isRegion_p.

Referenced by casacore::LatticeExprNode::isRegion().

Bool casacore::LELAttribute::isScalar ( ) const

inline

Is expression a scalar?

Definition at line 117 of file LELAttribute.h.

References isScalar_p.

Referenced by casacore::LELInterface< Complex >::isScalar(), and casacore::LatticeExprNode::isScalar().

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

Assignment (copy semantics)

const IPosition& casacore::LELAttribute::shape ( ) const

inline

What is the shape of the expression?

Definition at line 129 of file LELAttribute.h.

References shape_p.

Referenced by casacore::LELInterface< Complex >::shape(), and casacore::LatticeExprNode::shape().

const IPosition& casacore::LELAttribute::tileShape ( ) const

inline

What is the tile shape of the expression?

Definition at line 132 of file LELAttribute.h.

References tileShape_p.

Member Data Documentation

LELCoordinates casacore::LELAttribute::coords_p

private

Definition at line 147 of file LELAttribute.h.

Referenced by coordinates().

Bool casacore::LELAttribute::isMasked_p

private

Definition at line 144 of file LELAttribute.h.

Referenced by isMasked().

Bool casacore::LELAttribute::isReduced_p

private

Definition at line 142 of file LELAttribute.h.

Referenced by isReduced().

Bool casacore::LELAttribute::isRegion_p

private

Definition at line 143 of file LELAttribute.h.

Referenced by isRegion().

Bool casacore::LELAttribute::isScalar_p

private

Definition at line 141 of file LELAttribute.h.

Referenced by isScalar().

IPosition casacore::LELAttribute::shape_p

private

Definition at line 145 of file LELAttribute.h.

Referenced by shape().

IPosition casacore::LELAttribute::tileShape_p

private

Definition at line 146 of file LELAttribute.h.

Referenced by tileShape().

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

casa/casacore/lattices/LEL/LELAttribute.h

Public Member Functions

Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation