casacore::LCRegionFixed Class Reference

Abstract base class to define a fixed region. More...

#include <LCRegionFixed.h>

Inheritance diagram for casacore::LCRegionFixed:

Public Member Functions
	LCRegionFixed ()
	LCRegionFixed (const IPosition &latticeShape)
	Construct with the lattice shape only.
	LCRegionFixed (const LCRegionFixed &other)
	Copy constructor (copy semantics).
virtual	~LCRegionFixed ()
	Destructor.
virtual Bool	operator== (const LCRegion &other) const
	Comparison.
Protected Member Functions
LCRegionFixed &	operator= (const LCRegionFixed &other)
	Assignment (copy semantics) is only useful for derived classes.
void	setMask (const Array< Bool > &mask)
	Set the mask.
Private Attributes
ArrayLattice< Bool >	itsMask

Detailed Description

Abstract base class to define a fixed region.

Intended use:

Public interface

Prerequisite

Slicer

Synopsis

The LCRegion class is the abstract base class for various types of LCRegion's (e.g. LCRegionEllipsoid, LCRegionBox). It contains the minimal bounding box of the region and, if needed, a mask with the same shape as the bounding box. A mask element is true if the element is inside the box.

Each LCRegion object must be able to convert itself to and from a record. In that way they can be made persistent (in for example a Table).

The LCRegion can be used in several Lattices and Images classes and functions to limit the area to operate on.

Example

Motivation

The Slicer class is too limited as a region, because it can only describe a rectangular region. Specialized classes are needed to describe arbitrary regions. They need a base class to combine them.

Definition at line 81 of file LCRegionFixed.h.

Constructor & Destructor Documentation

casacore::LCRegionFixed::LCRegionFixed ( )

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

Construct with the lattice shape only.

casacore::LCRegionFixed::LCRegionFixed ( const LCRegionFixed & other )

Copy constructor (copy semantics).

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

Destructor.

Member Function Documentation

LCRegionFixed& casacore::LCRegionFixed::operator= ( const LCRegionFixed & other ) [protected]

Assignment (copy semantics) is only useful for derived classes.

Reimplemented from casacore::LCRegionSingle.

Reimplemented in casacore::LCBox, casacore::LCEllipsoid, casacore::LCPixelSet, and casacore::LCPolygon.

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

Comparison.

Mask is not checked. Use the LCRegionSingle::masksEqual function as well if you want to check the masks

Reimplemented in casacore::LCBox, casacore::LCEllipsoid, casacore::LCPixelSet, and casacore::LCPolygon.

void casacore::LCRegionFixed::setMask ( const Array< Bool > & mask ) [protected]

Set the mask.

Member Data Documentation

ArrayLattice<Bool> casacore::LCRegionFixed::itsMask [private]

Definition at line 108 of file LCRegionFixed.h.

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

casacore/lattices/LRegions/LCRegionFixed.h