casa::AnnPolyline Class Reference

This class represents a single polyline (in position coordinates) annotation specified in an ascii region file as proposed in CAS-2285. More...

#include <AnnPolyline.h>

Inheritance diagram for casa::AnnPolyline:

List of all members.

Public Member Functions
	AnnPolyline (const Vector< Quantity > &xPositions, const Vector< Quantity > &yPositions, 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)
	AnnPolyline (const Vector< Quantity > &xPositions, const Vector< Quantity > &yPositions, const CoordinateSystem &csys, const IPosition &imShape, const Vector< Stokes::StokesTypes > &stokes)
	Simplified constructor.
AnnPolyline &	operator= (const AnnPolyline &other)
	implicit copy constructor and destructor are fine
Vector< MDirection >	getCorners () const
	get the vertices converted to the coordinate system used at construction.
void	worldVertices (vector< Quantity > &x, vector< Quantity > &y) const
	get the world coordinates of the polygon vertices
void	pixelVertices (vector< Double > &x, vector< Double > &y) const
	get the pixel coordinates of the polygon vertices
virtual ostream &	print (ostream &os) const
Private Member Functions
void	_init ()
Private Attributes
Vector< Quantity >	_origXPos
Vector< Quantity >	_origYPos

Detailed Description

This class represents a single polyline (in position coordinates) annotation specified in an ascii region file as proposed in CAS-2285.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Holds the specification of a polyline annotation.

Synopsis

This class represents a polyline annotation.

Definition at line 45 of file AnnPolyline.h.

Constructor & Destructor Documentation

casa::AnnPolyline::AnnPolyline	(	const Vector< Quantity > &	xPositions,
		const Vector< Quantity > &	yPositions,
		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::AnnPolyline::AnnPolyline	(	const Vector< Quantity > &	xPositions,
		const Vector< Quantity > &	yPositions,
		const CoordinateSystem &	csys,
		const IPosition &	imShape,
		const Vector< Stokes::StokesTypes > &	stokes
	)

Simplified constructor.

all frequencies are used (these can be set after construction). xPositions and yPositions 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::AnnPolyline::_init ( ) [private]

Reimplemented from casa::AnnRegion.

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

get the vertices converted to the coordinate system used at construction.

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

implicit copy constructor and destructor are fine

Reimplemented from casa::AnnRegion.

void casa::AnnPolyline::pixelVertices	(	vector< Double > &	x,
		vector< Double > &	y
	)			const

get the pixel coordinates of the polygon vertices

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

Implements casa::AnnotationBase.

void casa::AnnPolyline::worldVertices	(	vector< Quantity > &	x,
		vector< Quantity > &	y
	)			const

get the world coordinates of the polygon vertices

Member Data Documentation

Vector<Quantity> casa::AnnPolyline::_origXPos [private]

Definition at line 95 of file AnnPolyline.h.

Vector<Quantity> casa::AnnPolyline::_origYPos [private]