AnnCenterBox.h

Go to the documentation of this file.
00001 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00002 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00003 //# License for more details.
00004 //#
00005 //# You should have received a copy of the GNU Library General Public License
00006 //# along with this library; if not, write to the Free Software Foundation,
00007 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00008 //#
00009 //# Correspondence concerning AIPS++ should be addressed as follows:
00010 //#        Internet email: aips2-request@nrao.edu.
00011 //#        Postal address: AIPS++ Project Office
00012 //#                        National Radio Astronomy Observatory
00013 //#                        520 Edgemont Road
00014 //#                        Charlottesville, VA 22903-2475 USA
00015 //#
00016 
00017 #ifndef ANNOTATIONS_ANNCENTERBOX_H
00018 #define ANNOTATIONS_ANNCENTERBOX_H
00019 
00020 #include <casa/aips.h>
00021 #include <imageanalysis/Annotations/AnnPolygon.h>
00022 
00023 namespace casa {
00024 
00025 // <summary>
00026 // This class represents a annotation for rectangular (in position coordinates) region specified
00027 // in an ascii region file as proposed in CAS-2285. It is specified by its center position
00028 // and side widths.
00029 // </summary>
00030 // <author>Dave Mehringer</author>
00031 // <use visibility=export>
00032 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
00033 // </reviewed>
00034 // <prerequisite>
00035 
00036 // </prerequisite>
00037 
00038 // <etymology>
00039 // Holds the specification of an annotation of a rectangular region as specified in ASCII format.
00040 // Specified by center position and widths of sides.
00041 // </etymology>
00042 
00043 // <synopsis>
00044 // This class represents an annotation of rectangular region in coordinate space specified by
00045 // center and widths of sides. In general, in order
00046 // to preserve the region through a rotation (eg from one coordinate frame to another), all four corners
00047 // must be tracked through the rotation. Hence, this region is effectively a four corner polygon.
00048 // </synopsis>
00049 
00050 
00051 class AnnCenterBox: public AnnPolygon {
00052 
00053 public:
00054 
00055         AnnCenterBox(
00056                 const Quantity& centerx,
00057                 const Quantity& centery,
00058                 const Quantity& xwidth,
00059                 const Quantity& ywidth,
00060                 const String& dirRefFrameString,
00061                 const CoordinateSystem& csys,
00062                 const IPosition& imShape,
00063                 const Quantity& beginFreq,
00064                 const Quantity& endFreq,
00065                 const String& freqRefFrameString,
00066                 const String& dopplerString,
00067                 const Quantity& restfreq,
00068                 const Vector<Stokes::StokesTypes> stokes,
00069                 const Bool annotationOnly
00070         );
00071 
00072         // Simplified constructor.
00073         // all frequencies are used (these can be set after construction).
00074         // centerx and centery
00075         // must be in the same frame as the csys direction coordinate.
00076         // is a region (not just an annotation), although this value can be changed after
00077         // construction.
00078         AnnCenterBox(
00079                 const Quantity& centerx,
00080                 const Quantity& centery,
00081                 const Quantity& xwidth,
00082                 const Quantity& ywidth,
00083                 const CoordinateSystem& csys,
00084                 const IPosition& imShape,
00085                 const Vector<Stokes::StokesTypes>& stokes
00086         );
00087 
00088         // implicit copy constructor and destructor are fine
00089 
00090         AnnCenterBox& operator=(const AnnCenterBox& other);
00091 
00092         ostream& print(ostream &os) const;
00093 
00094 private:
00095         Quantity _inpXCenter, _inpYCenter, _inpXWidth, _inpYWidth;
00096 
00097 };
00098 
00099 }
00100 
00101 #endif /* ASCIICENTERBOXREGION_H_ */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1