casa::AnnRotBox Class Reference

This class represents an annotation for rectangular (in position coordinates) region specified in an ascii region file as proposed in CAS-2285. It is specified by its center position and side widths and a position angle. <author>Dave Mehringer</author>. More...

#include <AnnRotBox.h>

Inheritance diagram for casa::AnnRotBox:

List of all members.

Public Member Functions
	AnnRotBox (const Quantity &xcenter, const Quantity &ycenter, const Quantity &xwidth, const Quantity &ywidth, const Quantity &positionAngle, 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)
	`positionAngle` is measured in the usual astronomical way; starting at north through east (counterclockwise)
	AnnRotBox (const Quantity &xcenter, const Quantity &ycenter, const Quantity &xwidth, const Quantity &ywidth, const Quantity &positionAngle, const CoordinateSystem &csys, const IPosition &imShape, const Vector< Stokes::StokesTypes > &stokes)
	Simplified constructor.
AnnRotBox &	operator= (const AnnRotBox &other)
	implicit copy constructor and destructor are fine
virtual ostream &	print (ostream &os) const
Private Attributes
AnnotationBase::Direction	_inputCenter
Vector< Quantity >	_inputWidths
Quantity	_positionAngle

Detailed Description

This class represents an annotation for rectangular (in position coordinates) region specified in an ascii region file as proposed in CAS-2285. It is specified by its center position and side widths and a position angle. <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. Specified by center position and widths of sides and a position angle

Synopsis

This class represents an annotation for a rectangular region in coordinate space specified by center and widths of sides and a position angle.

Definition at line 49 of file AnnRotBox.h.

Constructor & Destructor Documentation

casa::AnnRotBox::AnnRotBox	(	const Quantity &	xcenter,
		const Quantity &	ycenter,
		const Quantity &	xwidth,
		const Quantity &	ywidth,
		const Quantity &	positionAngle,
		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
	)

positionAngle is measured in the usual astronomical way; starting at north through east (counterclockwise)

casa::AnnRotBox::AnnRotBox	(	const Quantity &	xcenter,
		const Quantity &	ycenter,
		const Quantity &	xwidth,
		const Quantity &	ywidth,
		const Quantity &	positionAngle,
		const CoordinateSystem &	csys,
		const IPosition &	imShape,
		const Vector< Stokes::StokesTypes > &	stokes
	)

Simplified constructor.

all frequencies are used (these can be set after construction). xcenter and ycenter 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

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

implicit copy constructor and destructor are fine

Reimplemented from casa::AnnPolygon.

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

Reimplemented from casa::AnnPolygon.

Member Data Documentation

AnnotationBase::Direction casa::AnnRotBox::_inputCenter [private]

Definition at line 95 of file AnnRotBox.h.

Vector<Quantity> casa::AnnRotBox::_inputWidths [private]

Definition at line 96 of file AnnRotBox.h.

Quantity casa::AnnRotBox::_positionAngle [private]

Definition at line 97 of file AnnRotBox.h.

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

code/imageanalysis/Annotations/AnnRotBox.h