casa::AnnAnnulus Class Reference

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

#include <AnnAnnulus.h>

Inheritance diagram for casa::AnnAnnulus:

List of all members.

Public Member Functions
	AnnAnnulus ()
	avoid using the default constructor, it's behavior is subject to change
	AnnAnnulus (const Quantity &xcenter, const Quantity &ycenter, const Quantity &innerRadius, const Quantity &outerRadius, 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)
	AnnAnnulus (const Quantity &xcenter, const Quantity &ycenter, const Quantity &innerRadius, const Quantity &outerRadius, const CoordinateSystem &csys, const IPosition &imShape, const Vector< Stokes::StokesTypes > &stokes)
	Simplified constructor.
AnnAnnulus &	operator= (const AnnAnnulus &other)
	the default copy constructor and destructor are fine
Bool	operator== (const AnnAnnulus &other)
MDirection	getCenter () const
	get the center position, converted to the frame of the input coordinate system if necessary
Vector< Quantity >	getRadii () const
	get the radii in angular units.
virtual ostream &	print (ostream &os) const
Private Member Functions
void	_init ()
Private Attributes
Vector< Quantity >	_convertedRadii
Quantity	_xcenter
Quantity	_ycenter
Quantity	_innerRadius
Quantity	_outerRadius

Detailed Description

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

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Holds the specification of a annotation for an annular region as specified in ASCII format. Specified by center position and inner and outer radii.

Synopsis

This class represents a annotation for an annular region in specified by center and inner and outer radii.

Definition at line 49 of file AnnAnnulus.h.

Constructor & Destructor Documentation

casa::AnnAnnulus::AnnAnnulus ( )

avoid using the default constructor, it's behavior is subject to change

casa::AnnAnnulus::AnnAnnulus	(	const Quantity &	xcenter,
		const Quantity &	ycenter,
		const Quantity &	innerRadius,
		const Quantity &	outerRadius,
		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::AnnAnnulus::AnnAnnulus	(	const Quantity &	xcenter,
		const Quantity &	ycenter,
		const Quantity &	innerRadius,
		const Quantity &	outerRadius,
		const CoordinateSystem &	csys,
		const IPosition &	imShape,
		const Vector< Stokes::StokesTypes > &	stokes
	)

Simplified constructor.

all frequencies and all polarizations 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.