casacore::LCPixelSet Class Reference

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

#include <LCPixelSet.h>

Inheritance diagram for casacore::LCPixelSet:

List of all members.

Public Member Functions
	LCPixelSet ()
	LCPixelSet (const Array< Bool > &mask, const LCBox &region)
	Construct from the box defining the position of the mask.
	LCPixelSet (const LCPixelSet &other)
	Copy constructor (copy semantics).
virtual	~LCPixelSet ()
LCPixelSet &	operator= (const LCPixelSet &other)
	Assignment (copy semantics).
virtual Bool	operator== (const LCRegion &other) const
	Comparison.
virtual LCRegion *	cloneRegion () const
	Make a copy of the derived object.
virtual String	type () const
	Get the region type.
virtual TableRecord	toRecord (const String &tableName) const
	Convert the (derived) object to a record.
Static Public Member Functions
static String	className ()
	Get the class name (to store in the record).
static LCPixelSet *	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 LCPixelSet (for e.g.
Private Attributes
LCBox	itsBox

---

Detailed Description

Class to define a rectangular mask as a region.

Intended use:

Public interface

Prerequisite

• LCRegion

Synopsis

The LCPixelSet class is a specialization of class LCRegion . It makes it possible to define a rectangular region of interest.

Example

Definition at line 66 of file LCPixelSet.h.

---

Constructor & Destructor Documentation

casacore::LCPixelSet::LCPixelSet

(

)

casacore::LCPixelSet::LCPixelSet	(	const Array< Bool > &	mask,
		const LCBox &	region
	)

Construct from the box defining the position of the mask.

The shape of the region and mask must be the same.

casacore::LCPixelSet::LCPixelSet

(

const LCPixelSet &

other

)

Copy constructor (copy semantics).

virtual casacore::LCPixelSet::~LCPixelSet

(

)

[virtual]

---

Member Function Documentation

static String casacore::LCPixelSet::className

(

)

[static]

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

virtual LCRegion* casacore::LCPixelSet::cloneRegion

(

)

const [virtual]

Make a copy of the derived object.

Implements casacore::LCRegion.

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

Construct another LCPixelSet (for e.g.

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

Implements casacore::LCRegion.

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

Convert correct object from a record.

Reimplemented from casacore::LCRegion.

LCPixelSet& casacore::LCPixelSet::operator=

(

const LCPixelSet &

other

)

Assignment (copy semantics).

Reimplemented from casacore::LCRegionFixed.

virtual Bool casacore::LCPixelSet::operator==

(

const LCRegion &

other

)

const [virtual]

Comparison.

Reimplemented from casacore::LCRegionFixed.

virtual TableRecord casacore::LCPixelSet::toRecord

(

const String &

tableName

)

const [virtual]

Convert the (derived) object to a record.

Implements casacore::LCRegion.

virtual String casacore::LCPixelSet::type

(

)

const [virtual]

Get the region type.

Returns className().

Implements casacore::LCRegion.

---

Member Data Documentation

LCBox casacore::LCPixelSet::itsBox [private]

Definition at line 110 of file LCPixelSet.h.

---

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

• casacore/lattices/LRegions/LCPixelSet.h