casa::AnnEllipse Class Reference

This class represents an annotation of an elliptical (in position coordinates) region specified in an ascii region file as proposed in CAS-2285. It is specified by its center position semi-major and semi-minor axes, and position angle. <author>Dave Mehringer</author>. More...

#include <AnnEllipse.h>

Inheritance diagram for casa::AnnEllipse:

List of all members.

Public Member Functions
	AnnEllipse (const Quantity &xcenter, const Quantity &ycenter, const Quantity &semiMajorAxis, const Quantity &semiMinorAxis, 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 defined as the angle between north and the ellipse major axis.
	AnnEllipse (const Quantity &xcenter, const Quantity &ycenter, const Quantity &semiMajorAxis, const Quantity &semiMinorAxis, const Quantity &positionAngle, const CoordinateSystem &csys, const IPosition &imShape, const Vector< Stokes::StokesTypes > &stokes)
	Simplified constructor.
AnnEllipse &	operator= (const AnnEllipse &other)
	implicit copy constructor and destructor are fine
Bool	operator== (const AnnEllipse &other) const
MDirection	getCenter () const
	Get the center position, tranformed to the reference from of the coordinate system if necessary.
Quantity	getSemiMajorAxis () const
	get semi-major axis.
Quantity	getSemiMinorAxis () const
	get semi-minor axis.
Quantity	getPositionAngle () const
	get position angle.
virtual ostream &	print (ostream &os) const
Private Member Functions
void	_init (const Quantity &xcenter, const Quantity &ycenter)
Private Attributes
AnnotationBase::Direction	_inputCenter
Quantity	_inputSemiMajorAxis
Quantity	_inputSemiMinorAxis
Quantity	_inputPositionAngle
Quantity	_convertedSemiMajorAxis
Quantity	_convertedSemiMinorAxis
Quantity	_convertedPositionAngle

Detailed Description

This class represents an annotation of an elliptical (in position coordinates) region specified in an ascii region file as proposed in CAS-2285. It is specified by its center position semi-major and semi-minor axes, and position angle. <author>Dave Mehringer</author>.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Holds the specification of a an annotation of an elliptical region as specified in ASCII format. Specified by center position, semi-major and semi-minor axes, and position angle.

Synopsis

This class represents an annotation of an elliptical region in coordinate space specified by center, semi-major and semi-minor axes, and position angle

Definition at line 50 of file AnnEllipse.h.

Constructor & Destructor Documentation

casa::AnnEllipse::AnnEllipse	(	const Quantity &	xcenter,
		const Quantity &	ycenter,
		const Quantity &	semiMajorAxis,
		const Quantity &	semiMinorAxis,
		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 defined as the angle between north and the ellipse major axis.

Note the lengths are for the semi-major and semi-minor axes, not the major and minor axes

casa::AnnEllipse::AnnEllipse	(	const Quantity &	xcenter,
		const Quantity &	ycenter,
		const Quantity &	semiMajorAxis,
		const Quantity &	semiMinorAxis,
		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.