LCStretch.h

The LCStretch class is a specialization of class LCRegion. It makes it possible to stretch a LCRegion along straight lines to other dimensions. E.g. a circle in the xy-plane can be stretched to a cylinder in the xyz-space. It can be used for a lattice of any dimensionality as long as the dimensionality of the (hyper-)stretch matches the dimensionality of the lattice.

Example

To Do

Stretch along (slanted) cone lines

Member Description

LCStretch()

LCStretch (const LCRegion& region, const IPosition& stretchAxes, const LCBox& stretchBox)
LCStretch (Bool takeOver, const LCRegion* region, const IPosition& stretchAxes, const LCBox& stretchBox)

Stretch the given region along axes as given by stretchAxes from the bottom left corner (blc) to the top right corner (trc) as given by stretchBox. The axes to be stretched need to have length 1 in the original region. Every kind of box (absolute, relative, fractional, unspecified) can be used to define the stretch blc and trc. The dimensionality of the LCStretch region is the same as the dimensionality of the original region.
The second version takes over the pointer when the switch is true.

LCStretch (const LCStretch& other)

Copy constructor (copy semantics).

virtual ~LCStretch()

LCStretch& operator= (const LCStretch& other)

Assignment (copy semantics).

virtual Bool operator== (const LCRegion& other) const

Comparison

virtual LCRegion* cloneRegion() const

Make a copy of the derived object.

const LCRegion& region() const

Get the original region.

const IPosition& stretchAxes() const

Get the stretch axes.

const LCBox& stretchBox() const

Get the stretch box.

static String className()

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

virtual String type() const

Get the region type. Returns the class name.

virtual TableRecord toRecord (const String& tableName) const

Convert the (derived) object to a record.

static LCStretch* fromRecord (const TableRecord&, const String& tableName)

Convert correct object from a record.

virtual LCRegion* doTranslate (const Vector<Float>& translateVector, const IPosition& newLatticeShape) const

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".

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).

void fill (const IPosition& stretchAxes, const LCBox& stretchBox)

Fill the object.