TranslationGT.h

Go to the documentation of this file.

/*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
 
    This file is part of the TerraLib - a Framework for building GIS enabled applications.
 
    TerraLib is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License,
    or (at your option) any later version.
 
    TerraLib 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 Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
 */
 
/*!
  \file terralib/geometry/TranslationGT.h
 
  \brief 2D translation (X,Y) Geometric transformation.
*/
 
#ifndef __TERRALIB_GEOMETRY_INTERNAL_TRANSLATIONGT_H
#define __TERRALIB_GEOMETRY_INTERNAL_TRANSLATIONGT_H
 
// TerraLib
#include "Config.h"
#include "GeometricTransformation.h"
 
namespace te
{
  namespace gm
  {
    /*!
      \class TranslationGT
 
      \brief 2D translation(X,Y) Geometric transformation.
 
      \note The transformation parameters (inside GTParameters::m_directParameters) are disposed on the following form:
 
      \code
           u = x + a
           v = y + b
 
           GTParameters::m_directParameters = [ a b ]
      \endcode
    */
    class TEGEOMEXPORT TranslationGT : public GeometricTransformation
    {
      public:
        
        /*! \brief Default constructor. */
        TranslationGT();
 
        /*! \brief Destructor. */
        ~TranslationGT();
 
        const std::string& getName() const;
 
        bool isValid( const GTParameters& params ) const;
 
        void directMap( const GTParameters& params, const double& pt1X, 
                        const double& pt1Y, double& pt2X, double& pt2Y ) const;
 
        void inverseMap( const GTParameters& params, const double& pt2X, 
                         const double& pt2Y, double& pt1X, double& pt1Y ) const;
 
        unsigned int getMinRequiredTiePoints() const;
        
        GeometricTransformation* clone() const;
 
      protected:
        
        // variables used by computeParameters
        mutable std::size_t m_computeParameters_tiepointsSize;
        mutable std::size_t m_computeParameters_tpIdx;
        mutable double m_computeParameters_diffX;
        mutable double m_computeParameters_diffY;        
        mutable double m_computeParameters_meanDiffX;
        mutable double m_computeParameters_meanDiffY;
        
        bool computeParameters( GTParameters& params ) const;
    };
 
  } // end namespace gm
}   // end namespace te
 
#endif  // __TERRALIB_GEOMETRY_INTERNAL_TRANSLATIONGT_H