casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Member Functions | Private Attributes
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::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
MDirection getCenter () const
Vector< QuantitygetWidths () const
Vector< MDirectiongetCorners () const
 get the blc and trc direction coords for the box which have been converted to the coordinate frame specified when the object was constructed.
virtual ostream & print (ostream &os) const

Private Member Functions

void _init ()
void _doCorners ()

Private Attributes

Vector< Quantity_widths
Vector< MDirection_corners
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.

Definition at line 49 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

void casa::AnnCenterBox::_doCorners ( ) [private]
void casa::AnnCenterBox::_init ( ) [private]

Reimplemented from casa::AnnRegion.

get the blc and trc direction coords for the box which have been converted to the coordinate frame specified when the object was constructed.

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

implicit copy constructor and destructor are fine

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

Implements casa::AnnotationBase.


Member Data Documentation

Definition at line 103 of file AnnCenterBox.h.

Definition at line 104 of file AnnCenterBox.h.

Definition at line 104 of file AnnCenterBox.h.

Definition at line 104 of file AnnCenterBox.h.

Definition at line 104 of file AnnCenterBox.h.

Definition at line 102 of file AnnCenterBox.h.


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