casa::AnnCenterBox Class Reference

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

#include <AnnCenterBox.h>

Inheritance diagram for casa::AnnCenterBox:
casa::AnnPolygon casa::AnnRegion casa::AnnotationBase

List of all members.

Public Member Functions

 AnnCenterBox (const Quantity &centerx, const Quantity &centery, const Quantity &xwidth, const Quantity &ywidth, 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)
 AnnCenterBox (const Quantity &centerx, const Quantity &centery, const Quantity &xwidth, const Quantity &ywidth, const CoordinateSystem &csys, const IPosition &imShape, const Vector< Stokes::StokesTypes > &stokes)
 Simplified constructor.
AnnCenterBoxoperator= (const AnnCenterBox &other)
 implicit copy constructor and destructor are fine
ostream & print (ostream &os) const

Private Attributes

Quantity _inpXCenter
Quantity _inpYCenter
Quantity _inpXWidth
Quantity _inpYWidth

Detailed Description

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

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Etymology

Holds the specification of an annotation of a rectangular region as specified in ASCII format. Specified by center position and widths of sides.

Synopsis

This class represents an annotation of rectangular region in coordinate space specified by center and widths of sides. In general, in order to preserve the region through a rotation (eg from one coordinate frame to another), all four corners must be tracked through the rotation. Hence, this region is effectively a four corner polygon.

Definition at line 51 of file AnnCenterBox.h.


Constructor & Destructor Documentation

casa::AnnCenterBox::AnnCenterBox ( const Quantity &  centerx,
const Quantity &  centery,
const Quantity &  xwidth,
const Quantity &  ywidth,
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::AnnCenterBox::AnnCenterBox ( const Quantity &  centerx,
const Quantity &  centery,
const Quantity &  xwidth,
const Quantity &  ywidth,
const CoordinateSystem &  csys,
const IPosition &  imShape,
const Vector< Stokes::StokesTypes > &  stokes 
)

Simplified constructor.

all frequencies are used (these can be set after construction). centerx and centery 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

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

implicit copy constructor and destructor are fine

Reimplemented from casa::AnnPolygon.

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

Reimplemented from casa::AnnPolygon.


Member Data Documentation

Quantity casa::AnnCenterBox::_inpXCenter [private]

Definition at line 95 of file AnnCenterBox.h.

Quantity casa::AnnCenterBox::_inpXWidth [private]

Definition at line 95 of file AnnCenterBox.h.

Quantity casa::AnnCenterBox::_inpYCenter [private]

Definition at line 95 of file AnnCenterBox.h.

Quantity casa::AnnCenterBox::_inpYWidth [private]

Definition at line 95 of file AnnCenterBox.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1