casa::AnnCircle Class Reference

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

#include <AnnCircle.h>

Inheritance diagram for casa::AnnCircle:

List of all members.

Public Member Functions
	AnnCircle (const Quantity &xcenter, const Quantity &ycneter, const Quantity &radius, 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)
	AnnCircle (const Quantity &xcenter, const Quantity &ycneter, const Quantity &radius, const CoordinateSystem &csys, const IPosition &imShape, const Vector< Stokes::StokesTypes > &stokes)
	Simplified constructor.
AnnCircle &	operator= (const AnnCircle &other)
	implicit copy constructor and destructor are fine
MDirection	getCenter () const
	get center position, converted to the reference frame of the coordinate system if necessary
Quantity	getRadius () const
	get the radius of the circle with angular units
virtual ostream &	print (ostream &os) const
Private Member Functions
void	_init (const Quantity &xcenter, const Quantity &ycenter)
Private Attributes
AnnotationBase::Direction	_inputCenter
Quantity	_inputRadius
Quantity	_convertedRadius

Detailed Description

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

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Holds the specification of an annotation of a circular region as specified in ASCII format. Specified by center position and radius.

Synopsis

This class represents an annotation of a circular region in coordinate space specified by center and radius. Note that this represents a world coordinate region, even if the input radius is in pixels. If the direction coordinate does not have square pixels, then AnnEllipse should be used instead.

Definition at line 50 of file AnnCircle.h.

Constructor & Destructor Documentation

casa::AnnCircle::AnnCircle	(	const Quantity &	xcenter,
		const Quantity &	ycneter,
		const Quantity &	radius,
		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::AnnCircle::AnnCircle	(	const Quantity &	xcenter,
		const Quantity &	ycneter,
		const Quantity &	radius,
		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

void casa::AnnCircle::_init	(	const Quantity &	xcenter,
		const Quantity &	ycenter
	)			`[private]`

MDirection casa::AnnCircle::getCenter ( ) const

get center position, converted to the reference frame of the coordinate system if necessary

Quantity casa::AnnCircle::getRadius ( ) const

get the radius of the circle with angular units

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

implicit copy constructor and destructor are fine

Reimplemented from casa::AnnRegion.

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

Implements casa::AnnotationBase.

Member Data Documentation

Quantity casa::AnnCircle::_convertedRadius [private]

Definition at line 100 of file AnnCircle.h.

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

Definition at line 99 of file AnnCircle.h.

Quantity casa::AnnCircle::_inputRadius [private]