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
Vector< MDirection >	getCorners () const
	get the blc and trc direction coords for the box.
ostream &	print (ostream &os) const
Private Member Functions
void	_init (const Quantity &blcx, const Quantity &blcy, const Quantity &trcx, const Quantity &trcy)
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 annotaton for a rectangular region in coordinate space.

Definition at line 46 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

void casa::AnnRectBox::_init	(	const Quantity &	blcx,
		const Quantity &	blcy,
		const Quantity &	trcx,
		const Quantity &	trcy
	)		`[private]`

Vector<MDirection> casa::AnnRectBox::getCorners ( ) const

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.

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

implicit copy constructor and destructor are fine

ostream& casa::AnnRectBox::print ( ostream & os ) const [virtual]

Implements casa::AnnotationBase.

Member Data Documentation

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

Definition at line 98 of file AnnRectBox.h.

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

code/imageanalysis/Annotations/AnnRectBox.h

Public Member Functions

Private Member Functions

Private Attributes