casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Member Functions | Private Attributes
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 major and minor axes, and position angle. <author>Dave Mehringer</author> More...

#include <AnnEllipse.h>

Inheritance diagram for casa::AnnEllipse:
casa::AnnRegion casa::AnnotationBase

List of all members.

Public Member Functions

 AnnEllipse (const Quantity &xcenter, const Quantity &ycenter, const Quantity &majorAxis, const Quantity &minorAxis, 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 &majorAxis, const Quantity &minorAxis, const Quantity &positionAngle, const CoordinateSystem &csys, const IPosition &imShape, const Vector< Stokes::StokesTypes > &stokes)
 Simplified constructor.
AnnEllipseoperator= (const AnnEllipse &other)
 implicit copy constructor and destructor are fine
MDirection getCenter () const
 Get the center position, tranformed to the reference from of the coordinate system if necessary.
Quantity getMajorAxis () const
 get major axis.
Quantity getMinorAxis () const
 get 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 _inputMajorAxis
Quantity _inputMinorAxis
Quantity _inputPositionAngle
Quantity _convertedMajorAxis
Quantity _convertedMinorAxis

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 major and 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 annular region as specified in ASCII format. Specified by center position, major and minor axes, and position angle.

Synopsis

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

Definition at line 51 of file AnnEllipse.h.


Constructor & Destructor Documentation

casa::AnnEllipse::AnnEllipse ( const Quantity xcenter,
const Quantity ycenter,
const Quantity majorAxis,
const Quantity minorAxis,
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.

casa::AnnEllipse::AnnEllipse ( const Quantity xcenter,
const Quantity ycenter,
const Quantity majorAxis,
const Quantity minorAxis,
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

void casa::AnnEllipse::_init ( const Quantity xcenter,
const Quantity ycenter 
) [private]

Get the center position, tranformed to the reference from of the coordinate system if necessary.

get major axis.

The quantity will have units of angular measure

get minor axis.

The quantity will have units of angular measure

get position angle.

The quantity will have units of angular measure

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

implicit copy constructor and destructor are fine

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

Implements casa::AnnotationBase.


Member Data Documentation

Definition at line 118 of file AnnEllipse.h.

Definition at line 118 of file AnnEllipse.h.

Definition at line 117 of file AnnEllipse.h.

Definition at line 118 of file AnnEllipse.h.

Definition at line 118 of file AnnEllipse.h.

Definition at line 118 of file AnnEllipse.h.


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