casa::AnnRectBox Class Reference

This class represents an annotation for rectangular (in position coordinates) region specified in an ascii region file as proposed in CAS-2285 <author>Dave Mehringer</author>. More...

#include <AnnRectBox.h>

Inheritance diagram for casa::AnnRectBox:

List of all members.

Public Member Functions
	AnnRectBox (const Quantity &blcx, const Quantity &blcy, const Quantity &trcx, const Quantity &trcy, const String &dirRefFrameString, const CoordinateSystem &csys, const IPosition &imShape, const Quantity &beginFreq, const Quantity &endFreq, const String &freqRefFrameString, const String &dopplerString, const Quantity &restfreq, const Vector< Stokes::StokesTypes > stokes, const Bool annotationOnly)
	AnnRectBox (const Quantity &blcx, const Quantity &blcy, const Quantity &trcx, const Quantity &trcy, const CoordinateSystem &csys, const IPosition &imShape, const Vector< Stokes::StokesTypes > &stokes)
	Simplified constructor.
AnnRectBox &	operator= (const AnnRectBox &other)
	implicit copy constructor and destructor are fine
ostream &	print (ostream &os) const
	get the blc and trc direction coords for the box.
Private Attributes
AnnotationBase::Direction	_inputCorners

---

Detailed Description

This class represents an annotation for rectangular (in position coordinates) region specified in an ascii region file as proposed in CAS-2285 <author>Dave Mehringer</author>.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

Holds the specification of an annotation for a rectangular region as specified in ASCII format.

Synopsis

This class represents an annotation for a rectangular region in coordinate space. In general, in order to preserve the region through a rotation (eg from one coordinate frame to another), all four corners must be tracked through the rotation. Hence, this region is effectively a four corner polygon.

Definition at line 48 of file AnnRectBox.h.

---

Constructor & Destructor Documentation

casa::AnnRectBox::AnnRectBox	(	const Quantity &	blcx,
		const Quantity &	blcy,
		const Quantity &	trcx,
		const Quantity &	trcy,
		const String &	dirRefFrameString,
		const CoordinateSystem &	csys,
		const IPosition &	imShape,
		const Quantity &	beginFreq,
		const Quantity &	endFreq,
		const String &	freqRefFrameString,
		const String &	dopplerString,
		const Quantity &	restfreq,
		const Vector< Stokes::StokesTypes >	stokes,
		const Bool	annotationOnly
	)

casa::AnnRectBox::AnnRectBox	(	const Quantity &	blcx,
		const Quantity &	blcy,
		const Quantity &	trcx,
		const Quantity &	trcy,
		const CoordinateSystem &	csys,
		const IPosition &	imShape,
		const Vector< Stokes::StokesTypes > &	stokes
	)

Simplified constructor.

all frequencies are used (these can be set after construction). blcx, blcy, trcx, and trcy must be in the same frame as the csys direction coordinate. is a region (not just an annotation), although this value can be changed after construction.

---

Member Function Documentation

AnnRectBox& casa::AnnRectBox::operator=

(

const AnnRectBox &

other

)

implicit copy constructor and destructor are fine

Reimplemented from casa::AnnPolygon.

ostream& casa::AnnRectBox::print

(

ostream &

os

)

const [virtual]

get the blc and trc direction coords for the box.

The output directions will be converted from the input reference frame to the reference frame of the input coordinate system if necessary. blc is the 0th component, trc the 1st in the returned vector.

Vector<MDirection> getCorners() const;

Reimplemented from casa::AnnPolygon.

---

Member Data Documentation

AnnotationBase::Direction casa::AnnRectBox::_inputCorners [private]

Definition at line 100 of file AnnRectBox.h.

---

The documentation for this class was generated from the following file:

• code/imageanalysis/Annotations/AnnRectBox.h