casacore::LCComplement Class Reference

Make the complement of a region. More...

#include <LCComplement.h>

Inheritance diagram for casacore::LCComplement:

List of all members.

Public Member Functions
	LCComplement ()
	LCComplement (const LCRegion &region1)
	Construct the complement of the given region.
	LCComplement (Bool takeOver, const PtrBlock< const LCRegion * > &regions)
	Construct from multiple regions given as a Block.
	LCComplement (const LCComplement &other)
	Copy constructor (copy semantics).
virtual	~LCComplement ()
LCComplement &	operator= (const LCComplement &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 LCComplement *	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 LCRegion (for e.g.
virtual void	multiGetSlice (Array< Bool > &buffer, const Slicer &section)
	Do the actual getting of the mask.
Private Member Functions
void	defineBox ()
	Make the bounding box and determine the offsets.

---

Detailed Description

Make the complement of a region.

Intended use:

Public interface

Prerequisite

• LCRegion

Synopsis

The LCComplement class is a specialization of class LCRegion . It makes it possible to take the complement of a region with respect to a given lattice shape.

The center of the complement must be inside the lattice

Example

To Do

• Expand along (slanted) cone lines

Definition at line 69 of file LCComplement.h.

---

Constructor & Destructor Documentation

casacore::LCComplement::LCComplement

(

)

casacore::LCComplement::LCComplement

(

const LCRegion &

region1

)

Construct the complement of the given region.

casacore::LCComplement::LCComplement	(	Bool	takeOver,
		const PtrBlock< const LCRegion * > &	regions
	)

Construct from multiple regions given as a Block.

When takeOver is True, the destructor will delete the given regions. Otherwise a copy of the regions is made.

casacore::LCComplement::LCComplement

(

const LCComplement &

other

)

Copy constructor (copy semantics).

virtual casacore::LCComplement::~LCComplement

(

)

[virtual]

---

Member Function Documentation

static String casacore::LCComplement::className

(

)

[static]

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

virtual LCRegion* casacore::LCComplement::cloneRegion

(

)

const [virtual]

Make a copy of the derived object.

Implements casacore::LCRegion.

void casacore::LCComplement::defineBox

(

)

[private]

Make the bounding box and determine the offsets.

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

Construct another LCRegion (for e.g.

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

Implements casacore::LCRegion.

static LCComplement* casacore::LCComplement::fromRecord	(	const TableRecord &	,
		const String &	tableName
	)			[static]

Convert correct object from a record.

Reimplemented from casacore::LCRegion.

virtual void casacore::LCComplement::multiGetSlice	(	Array< Bool > &	buffer,
		const Slicer &	section
	)			[protected, virtual]

Do the actual getting of the mask.

Implements casacore::LCRegionMulti.

LCComplement& casacore::LCComplement::operator=

(

const LCComplement &

other

)

Assignment (copy semantics).

Reimplemented from casacore::LCRegionMulti.

virtual Bool casacore::LCComplement::operator==

(

const LCRegion &

other

)

const [virtual]

Comparison.

Reimplemented from casacore::LCRegionMulti.

virtual TableRecord casacore::LCComplement::toRecord

(

const String &

tableName

)

const [virtual]

Convert the (derived) object to a record.

Implements casacore::LCRegion.

virtual String casacore::LCComplement::type

(

)

const [virtual]

Get the region type.

Returns className()

Implements casacore::LCRegion.

---

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

• casacore/lattices/LRegions/LCComplement.h