otbLeastSquareAffineTransformEstimator.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt for details.


     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __otbLeastSquareAffineTransformEstimator_h
#define __otbLeastSquareAffineTransformEstimator_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkMatrix.h"
#include "itkVector.h"
#include "itkAffineTransform.h"

namespace otb {

template <class TPoint>
class ITK_EXPORT LeastSquareAffineTransformEstimator :
  public itk::Object
{
public:
  typedef LeastSquareAffineTransformEstimator Self;
  typedef itk::Object                         Superclass;
  typedef itk::SmartPointer<Self>             Pointer;
  typedef itk::SmartPointer<const Self>       ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(LeastSquareAffineTransformEstimator, Object);

  itkStaticConstMacro(PointDimension, unsigned int,
                      TPoint::PointDimension);

  typedef TPoint                           PointType;
  typedef typename PointType::CoordRepType PrecisionType;
  typedef itk::CovariantVector<PrecisionType,
      PointDimension>  CovariantVectorType;
  typedef std::pair<PointType, PointType> TiePointsType;
  typedef std::vector<TiePointsType>      TiePointsContainerType;

  typedef itk::Matrix<PrecisionType,
      PointDimension,
      PointDimension>           MatrixType;
  typedef itk::Vector<PrecisionType,
      PointDimension>           VectorType;
  typedef itk::AffineTransform<PrecisionType,
      PointDimension>  AffineTransformType;
  typedef typename AffineTransformType::Pointer AffineTransformPointerType;

  itkGetConstReferenceMacro(Matrix, MatrixType);

  itkGetConstReferenceMacro(Offset, VectorType);

  itkGetObjectMacro(AffineTransform, AffineTransformType);

  itkGetConstReferenceMacro(RMSError, CovariantVectorType);

  itkGetConstReferenceMacro(RelativeResidual, CovariantVectorType);

  TiePointsContainerType& GetTiePointsContainer();

  void SetTiePointsContainer(const TiePointsContainerType& container);

  void AddTiePoints(const PointType& src, const PointType& dst);

  void ClearTiePoints();

  void Compute();

protected:
  LeastSquareAffineTransformEstimator();
  virtual ~LeastSquareAffineTransformEstimator();

  virtual void PrintSelf(std::ostream& os, itk::Indent indent) const;

private:
  LeastSquareAffineTransformEstimator (const Self &);   // purposely not implemented
  void operator =(const Self&);    // purposely not implemented

  TiePointsContainerType m_TiePointsContainer;

  CovariantVectorType m_RMSError;

  CovariantVectorType m_RelativeResidual;

  MatrixType m_Matrix;

  VectorType m_Offset;

  AffineTransformPointerType m_AffineTransform;

}; // end of class

} // end of namespace otb

#ifndef OTB_MANUAL_INSTANTIATION
#include "otbLeastSquareAffineTransformEstimator.txx"
#endif

#endif