WCConcatenation.h
Classes
- WCConcatenation -- Combine multiple ImageRegion's into a new dimension. (full description)
Interface
- Public Members
- WCConcatenation (const PtrBlock<const ImageRegion*>& regions, const WCBox& extendRange)
- WCConcatenation (Bool takeOver, const PtrBlock<const WCRegion*>& regions, const WCBox& extendRange)
- WCConcatenation (const WCConcatenation& other)
- virtual ~WCConcatenation()
- WCConcatenation& operator= (const WCConcatenation& other)
- virtual Bool operator== (const WCRegion& other) const
- virtual WCRegion* cloneRegion() const
- static String className()
- virtual String type() const
- virtual TableRecord toRecord (const String& tableName) const
- static WCConcatenation* fromRecord (const TableRecord&, const String& tableName)
- Protected Members
- virtual LCRegion* doToLCRegion (const CoordinateSystem& cSys, const IPosition& shape, const IPosition& pixelAxesMap, const IPosition& outOrder) const
- Private Members
- void fill()
Prerequisite
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.
Member Description
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.
WCConcatenation (const WCConcatenation& other)
Copy constructor (copy semantics).
WCConcatenation& operator= (const WCConcatenation& other)
Assignment (copy semantics).
Comparison
Make a copy of the derived object.
Get the class name (to store in the record).
Get the region type. Returns className()
Convert the (derived) object to a record.
Convert correct object from a record.
Convert to an LCRegion using the given coordinate system and shape.
pixelAxesMap(i) gives the pixel axis in cSys of axes i
in the axesDesc.
Do a check and fill the remainder of the object.