Combine multiple LCRegion's into a new dimension. More...

#include <LCConcatenation.h>

Inheritance diagram for casa::LCConcatenation:

Public Member Functions
	LCConcatenation ()
	LCConcatenation (Bool takeOver, const PtrBlock< const LCRegion * > &regions, Int extendAxis)
	Combine the given regions.
	LCConcatenation (Bool takeOver, const PtrBlock< const LCRegion * > &regions, Int extendAxis, const LCBox &extendRange)
	LCConcatenation (const LCConcatenation &other)
	Copy constructor (copy semantics).
virtual	~LCConcatenation ()
LCConcatenation &	operator= (const LCConcatenation &other)
	Assignment (copy semantics).
virtual Bool	operator== (const LCRegion &other) const
	Comparison.
virtual LCRegion *	cloneRegion () const
	Make a copy of the derived object.
Int	extendAxis () const
	Get the extend axis.
const LCBox &	extendBox () const
	Get the extend box.
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 LCConcatenation *	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.
virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	This function is needed here because the niceCursorShape of the contributing region does not make any sense (other dimensionality).
Private Member Functions
void	fillRegionAxes ()
	Fill the object.
void	fill ()
Private Attributes
Int	itsExtendAxis

IPosition	itsRegionAxes
LCBox	itsExtendBox

Detailed Description

Combine multiple LCRegion's into a new dimension.

Intended use:

Public interface

Prerequisite

LCRegion

Synopsis

The LCConcatenation class is a specialization of class LCRegion . It makes it possible to combine multiple LCRegion's and to add a dimension on them. The range (beginning and end) in that new dimension have to be specified using an LCBox object. When the LCBox is complete, it will be checked if the given number of regions matches the length of the given range (so it could only be done after the makeComplete call). Using a fractional box does not make much sense, because it results in a varying length range when used with varying shaped lattices. However, one can use it if wanted.
LCConcatenation can be seen as a mixture of the classes LCUnion and LCExtension . Like LCUnion it combines regions and like LCExtension it increases the dimensionality for the new region (be it with only 1).
E.g. One can define a different polygon in the RA-DEC plane of each channel. LCConcatenation makes it possible to combine the polygons to one 3D region in the RA-DEC-Freq cube.

Example

This example combines n (relative) circles given in the x-z plane along the y-axis. In this example the regions used are circles with the same centers, but it is also possible to combine differently shaped regions. Note that LCConcatenation takes over the pointers to the individual regions, so they do not need to be deleted (the LCConcatenation destructor does it).

    IPosition center (2,10,20);
    PtrBlock<LCRegion*> cirPtr(n);
    for (i=0; i<n; i++) {
      // Each circle has a different radius.
      cirPtr(i) = new LCEllipsoid cir1 (center, 1 + i%(n/2));
    }
    // Construct the concatenation for a range (given as a relative box).
    // Extend along the y-axis (axis numbers start counting at 0!).
    // Take over the region pointers.
    LCConcatenation region (True, cirPtr, 1, LCBox(n/2-n, n/2-1));

Definition at line 101 of file LCConcatenation.h.

Constructor & Destructor Documentation

casa::LCConcatenation::LCConcatenation ( )

casa::LCConcatenation::LCConcatenation	(	Bool	takeOver,
		const PtrBlock< const LCRegion * > &	regions,
		Int	extendAxis
	)

Combine the given regions.

When takeOver is True, the destructor will delete the given regions. Otherwise a copy of the regions is made. The extend range has to be given as a 1-dimensional box. The default range is the entire axis.

casa::LCConcatenation::LCConcatenation	(	Bool	takeOver,
		const PtrBlock< const LCRegion * > &	regions,
		Int	extendAxis,
		const LCBox &	extendRange
	)

casa::LCConcatenation::LCConcatenation ( const LCConcatenation & other )

Copy constructor (copy semantics).

virtual casa::LCConcatenation::~LCConcatenation ( ) [virtual]

Member Function Documentation

static String casa::LCConcatenation::className ( ) [static]

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

virtual LCRegion* casa::LCConcatenation::cloneRegion ( ) const [virtual]

Make a copy of the derived object.

Implements casa::LCRegion.

virtual IPosition casa::LCConcatenation::doNiceCursorShape ( uInt maxPixels ) const [protected, virtual]

This function is needed here because the niceCursorShape of the contributing region does not make any sense (other dimensionality).

Reimplemented from casa::LCRegionMulti.

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