casa::QtWCBox Class Reference

#include <QtWCBox.h>

Public Member Functions
	QtWCBox ()
	QtWCBox (const Vector< Quantum< Double > > &blc, const Vector< Quantum< Double > > &trc, const DisplayCoordinateSystem &cSys, const Vector< Int > &absRel)
	Construct from vectors of world coordinates defining the box corners.
	QtWCBox (const Vector< Quantum< Double > > &blc, const Vector< Quantum< Double > > &trc, const IPosition &pixelAxes, const DisplayCoordinateSystem &cSys, const Vector< Int > &absRel)
	Construct from vectors of world coordinates defining the box corners.
	QtWCBox (const LCRegion &region, const DisplayCoordinateSystem &cSys)
	Construct from the bounding box of an `LCRegion`.
	QtWCBox (const QtWCBox &other)
	Copy constructor (reference semantics [except for `DisplayCoordinateSystem`]).
virtual	~QtWCBox ()
	Destructor.
QtWCBox &	operator= (const QtWCBox &other)
	Assignment (copy semantics).
virtual Bool	operator== (const WCRegion &other) const
	Comparison.
virtual WCRegion *	cloneRegion () const
	Clone a QtWCBox object.
virtual Bool	canExtend () const
	QtWCBox can extend a region.
QtWCBox	splitBox (const IPosition &axes) const
	Make a new box from the given axesin this box.
virtual LCRegion *	doToLCRegion (const CoordinateSystem &cSys, const IPosition &latticeShape, const IPosition &pixelAxesMap, const IPosition &outOrder) const
	Convert to an LCRegion using the supplied `DisplayCoordinateSystem` and shape.
virtual TableRecord	toRecord (const String &tableName) const
	Convert the QtWCBox object to a record.
virtual String	type () const
	Return region type.
String	toBoxString () const
	Convert from/to boxit format string.
void	setChanExt (const Double, const Double)
	FIXME: refactor to someplace more appropriate get/set chan extension.
Bool	getChanExt (Double &, Double &)
void	setPolExt (const Double, const Double)
	FIXME: refactor to someplace more appropriate get/set pol extension.
Bool	getPolExt (Double &, Double &)
Static Public Member Functions
static QtWCBox *	fromRecord (const TableRecord &rec, const String &tableName)
	Convert to a QtWCBox from a record.
static String	className ()
	Returns QtWCBox.
static QtWCBox *	fromBoxString (const String &, const DisplayCoordinateSystem &cSys, String &err)
static void	unitInit ()
Private Member Functions
void	checkUnits (const IPosition &pixelAxes, const Vector< Quantum< Double > > &values, const DisplayCoordinateSystem &cSys)
	Check units of quanta are consistent with DisplayCoordinateSystem.
void	convertPixel (Double &pixel, const Quantum< Double > &value, const Int absRel, const Double refPix, const Int shape, const Bool isBlc) const
	Convert relative pixels to absolute or fill in defaults.
Private Attributes
Vector< Quantum< Double > >	itsBlc
Vector< Quantum< Double > >	itsTrc
IPosition	itsPixelAxes
DisplayCoordinateSystem	itsCSys
Vector< Int >	itsAbsRel
Bool	itsNull

Detailed Description

Definition at line 48 of file QtWCBox.h.

Constructor & Destructor Documentation

casa::QtWCBox::QtWCBox ( )

casa::QtWCBox::QtWCBox	(	const Vector< Quantum< Double > > &	blc,
		const Vector< Quantum< Double > > &	trc,
		const DisplayCoordinateSystem &	cSys,
		const Vector< Int > &	absRel
	)

Construct from vectors of world coordinates defining the box corners.

It is assumed that the order of the values is in the order of the pixel axes in the given coordinate system.

casa::QtWCBox::QtWCBox	(	const Vector< Quantum< Double > > &	blc,
		const Vector< Quantum< Double > > &	trc,
		const IPosition &	pixelAxes,
		const DisplayCoordinateSystem &	cSys,
		const Vector< Int > &	absRel
	)

Construct from vectors of world coordinates defining the box corners.

You specify the pixel axis order of the world values.

casa::QtWCBox::QtWCBox	(	const LCRegion &	region,
		const DisplayCoordinateSystem &	cSys
	)

Construct from the bounding box of an LCRegion.

casa::QtWCBox::QtWCBox ( const QtWCBox & other )

Copy constructor (reference semantics [except for DisplayCoordinateSystem]).

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

Destructor.

Member Function Documentation

virtual Bool casa::QtWCBox::canExtend ( ) const [virtual]

QtWCBox can extend a region.

void casa::QtWCBox::checkUnits	(	const IPosition &	pixelAxes,
		const Vector< Quantum< Double > > &	values,
		const DisplayCoordinateSystem &	cSys
	)			`[private]`

Check units of quanta are consistent with DisplayCoordinateSystem.

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

Returns QtWCBox.

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

Clone a QtWCBox object.

void casa::QtWCBox::convertPixel	(	Double &	pixel,
		const Quantum< Double > &	value,
		const Int	absRel,
		const Double	refPix,
		const Int	shape,
		const Bool	isBlc
	)			const `[private]`

Convert relative pixels to absolute or fill in defaults.

virtual LCRegion* casa::QtWCBox::doToLCRegion	(	const CoordinateSystem &	cSys,
		const IPosition &	latticeShape,
		const IPosition &	pixelAxesMap,
		const IPosition &	outOrder
	)			const `[virtual]`

Convert to an LCRegion using the supplied DisplayCoordinateSystem and shape.

static QtWCBox* casa::QtWCBox::fromBoxString	(	const String &	,
		const DisplayCoordinateSystem &	cSys,
		String &	err
	)			`[static]`

static QtWCBox* casa::QtWCBox::fromRecord	(	const TableRecord &	rec,
		const String &	tableName
	)			`[static]`

Convert to a QtWCBox from a record.

Bool casa::QtWCBox::getChanExt	(	Double &	,
		Double &
	)

Bool casa::QtWCBox::getPolExt	(	Double &	,
		Double &
	)

QtWCBox& casa::QtWCBox::operator= ( const QtWCBox & other )

Assignment (copy semantics).

virtual Bool casa::QtWCBox::operator== ( const WCRegion & other ) const [virtual]

Comparison.

void casa::QtWCBox::setChanExt	(	const	Double,
		const	Double
	)

FIXME: refactor to someplace more appropriate get/set chan extension.

void casa::QtWCBox::setPolExt	(	const	Double,
		const	Double
	)

FIXME: refactor to someplace more appropriate get/set pol extension.

QtWCBox casa::QtWCBox::splitBox ( const IPosition & axes ) const

Make a new box from the given axesin this box.

String casa::QtWCBox::toBoxString ( ) const

Convert from/to boxit format string.

virtual TableRecord casa::QtWCBox::toRecord ( const String & tableName ) const [virtual]

Convert the QtWCBox object to a record.

The record can be used to make the object persistent. The tableName argument can be used by derived classes (e.g. LCPagedMask) to put very large objects.

virtual String casa::QtWCBox::type ( ) const [virtual]

Return region type.

Returns the class name

static void casa::QtWCBox::unitInit ( ) [static]