otbLeastSquareAffineTransformEstimator.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#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;
 
  LeastSquareAffineTransformEstimator();
 
  ~LeastSquareAffineTransformEstimator() override;
 
  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:
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  LeastSquareAffineTransformEstimator(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  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.hxx"
#endif
 
#endif