casacore::LCExtension Class Reference

Extend an LCRegion along straight lines to other dimensions. More...

#include <LCExtension.h>

Inheritance diagram for casacore::LCExtension:

Public Member Functions
	LCExtension ()
	LCExtension (const LCRegion &region, const IPosition &extendAxes, const LCBox &extendBox)
	Extend the given region along axes as given by `extendAxes` from the bottom left corner (blc) to the top right corner (trc) as given by `extendBox`.
	LCExtension (Bool takeOver, const LCRegion *region, const IPosition &extendAxes, const LCBox &extendBox)
	LCExtension (const LCExtension &other)
	Copy constructor (copy semantics).
virtual	~LCExtension ()
LCExtension &	operator= (const LCExtension &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 &	extendAxes () const
	Get the extend axes.
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 LCExtension *	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 (const IPosition &stretchAxes, const LCBox &stretchBox)
Private Attributes
IPosition	itsExtendAxes
IPosition	itsRegionAxes
LCBox	itsExtendBox

Detailed Description

Extend an LCRegion along straight lines to other dimensions.

Intended use:

Public interface

Prerequisite

LCRegion

Synopsis

The LCExtension class is a specialization of class LCRegion . It makes it possible to extend a LCRegion along straight lines to other dimensions. E.g. a circle in the xy-plane can be extended 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-)extension matches the dimensionality of the lattice.

Example

To Do

Extend along (slanted) cone lines

Definition at line 72 of file LCExtension.h.

Constructor & Destructor Documentation

casacore::LCExtension::LCExtension ( )

casacore::LCExtension::LCExtension	(	const LCRegion &	region,
		const IPosition &	extendAxes,
		const LCBox &	extendBox
	)

Extend the given region along axes as given by extendAxes from the bottom left corner (blc) to the top right corner (trc) as given by extendBox.

Every kind of box (absolute, relative, fractional, unspecified) can be used to define the extension blc and trc. The sum of the dimensionality of the region and the extend box make up the dimensionality of the LCExtension region. Similarly the lattice shapes in region and box are combined.
The second version takes over the pointer when the switch is true.

casacore::LCExtension::LCExtension	(	Bool	takeOver,
		const LCRegion *	region,
		const IPosition &	extendAxes,
		const LCBox &	extendBox
	)

casacore::LCExtension::LCExtension ( const LCExtension & other )

Copy constructor (copy semantics).

virtual casacore::LCExtension::~LCExtension ( ) [virtual]

Member Function Documentation

static String casacore::LCExtension::className ( ) [static]

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

virtual LCRegion* casacore::LCExtension::cloneRegion ( ) const [virtual]

Make a copy of the derived object.

Implements casacore::LCRegion.

virtual IPosition casacore::LCExtension::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 casacore::LCRegionMulti.

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