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

#include <WCConcatenation.h>

Inheritance diagram for casa::WCConcatenation:

Public Member Functions
	WCConcatenation (const PtrBlock< const ImageRegion * > &regions, const WCBox &extendRange)
	Combine the given regions.
	WCConcatenation (Bool takeOver, const PtrBlock< const WCRegion * > &regions, const WCBox &extendRange)
	WCConcatenation (const WCConcatenation &other)
	Copy constructor (copy semantics).
virtual	~WCConcatenation ()
WCConcatenation &	operator= (const WCConcatenation &other)
	Assignment (copy semantics).
virtual Bool	operator== (const WCRegion &other) const
	Comparison.
virtual WCRegion *	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 WCConcatenation *	fromRecord (const TableRecord &, const String &tableName)
	Convert correct object from a record.
Protected Member Functions
virtual LCRegion *	doToLCRegion (const CoordinateSystem &cSys, const IPosition &shape, const IPosition &pixelAxesMap, const IPosition &outOrder) const
	Convert to an LCRegion using the given coordinate system and shape.
Private Member Functions
void	fill ()
	Do a check and fill the remainder of the object.
Private Attributes
WCBox	itsExtendBox

Detailed Description

Combine multiple ImageRegion's into a new dimension.

Intended use:

Public interface

Prerequisite

WCCompound

Synopsis

The WCConcatenation class is a specialization of class WCCompound . It makes it possible to combine multiple regions and to add a dimension on them. The axis and the range (beginning and end) of that new dimension have to be specified using an WCBox object. That axes should not be an axis in the given regions.

WCConcatenation can be seen as a mixture of the classes WCUnion and WCExtension . Like WCUnion it combines regions and like WCExtension it increases the dimensionality for the new region (be it with only 1).
Unlike WCUnion the axes have to be the same in all regions, because creating a WCConcatenation means combining similar regions.

E.g. One can define a different polygon in the RA-DEC plane of each channel. WCConcatenation 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 RA,DEC plane along the FREQ-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 WCConcatenation takes over the pointers to the individual regions, so they do not need to be deleted (the WCConcatenation destructor does it).

    IPosition center (2,10,20);
    PtrBlock<ImageRegion*> cirPtr(n);
    for (i=0; i<n; i++) {
      // Each circle has a different radius.
      cirPtr(i) = new WCEllipsoid cir1 (center, 1 + i%(n/2));
    }
    // Construct the concatenation for a range (given as a box in fractions).
    // Extend along the FREQ-axis (the 2nd axis in the given cSys).\.
    // Take over the region pointers.
    Vector<Quantity> blc(1);
    Vector<Quantity> trc(1);
    blc(0) = Quantity (0.25, "frac");
    trc(0) = Quantity (0.75, "frac");
    WCConcatenation region (True, cirPtr, WCBox(blc, trc, cSys, IPosition(1,2));

This example is artificial in the sense that WCEllipsoid does not exist yet and the WCBox constructor looks a bit different. One should probably also do a bit more trouble to find out if FREQ is indeed the 2nd axis in the coordinate system.

Definition at line 108 of file WCConcatenation.h.

Constructor & Destructor Documentation

casa::WCConcatenation::WCConcatenation	(	const PtrBlock< const ImageRegion * > &	regions,
		const WCBox &	extendRange
	)

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.

casa::WCConcatenation::WCConcatenation	(	Bool	takeOver,
		const PtrBlock< const WCRegion * > &	regions,
		const WCBox &	extendRange
	)

casa::WCConcatenation::WCConcatenation ( const WCConcatenation & other )

Copy constructor (copy semantics).

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

Member Function Documentation

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

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

virtual WCRegion* casa::WCConcatenation::cloneRegion ( ) const [virtual]

Make a copy of the derived object.

Implements casa::WCRegion.

virtual LCRegion* casa::WCConcatenation::doToLCRegion	(	const CoordinateSystem &	cSys,
		const IPosition &	shape,
		const IPosition &	pixelAxesMap,
		const IPosition &	outOrder
	)		const `[protected, virtual]`