AnnLine.h

Go to the documentation of this file.

//# ComponentShape.h: Base class for component shapes
//# Copyright (C) 1998,1999,2000,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//# $Id: ComponentShape.h 20739 2009-09-29 01:15:15Z Malte.Marquarding $

#ifndef ANNOTATIONS_ANNLINE_H
#define ANNOTATIONS_ANNLINE_H

#include <imageanalysis/Annotations/AnnotationBase.h>

#include <casa/Arrays/Vector.h>
#include <measures/Measures/MDirection.h>

namespace casa {

// <summary>Represents a line annotation</summary>

// <use visibility=export>

// <reviewed reviewer="" date="yyyy/mm/dd">
// </reviewed>

// <synopsis>

// Represents an ascii line annotation
// </synopsis>

class AnnLine: public AnnotationBase {
public:

        AnnLine(
                const casacore::Quantity& xPoint1,
                const casacore::Quantity& yPoint1,
                const casacore::Quantity& xPoint2,
                const casacore::Quantity& yPoint2,
                const casacore::String& dirRefFrameString,
                const casacore::CoordinateSystem& csys,
                const casacore::Quantity& beginFreq,
                const casacore::Quantity& endFreq,
                const casacore::String& freqRefFrame,
                const casacore::String& dopplerString,
                const casacore::Quantity& restfreq,
                const casacore::Vector<casacore::Stokes::StokesTypes>& stokes
        );

        // simplified constructor. Direction quantities must be in the same reference frame as
        // <src>csys</src> and all frequencies are valid.
        AnnLine(
                const casacore::Quantity& xPoint1,
                const casacore::Quantity& yPoint1,
                const casacore::Quantity& xPoint2,
                const casacore::Quantity& yPoint2,
                const casacore::CoordinateSystem& csys,
                const casacore::Vector<casacore::Stokes::StokesTypes>& stokes
        );

        // implicit copy constructor and destructor are fine

        AnnLine& operator=(const AnnLine& other);

        // get the end point directions, transformed to
        // the input coordinate system if necessary
        casacore::Vector<casacore::MDirection> getEndPoints() const;

        virtual std::ostream& print(std::ostream &os) const;

protected:
        AnnotationBase::Direction _inputPoints;

};

}

#endif