otbTransform.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2022 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 otbTransform_h
#define otbTransform_h
 
#include "itkTransform.h"
#include "vnl/vnl_vector_fixed.h"
 
 
namespace otb
{
enum class TransformDirection {FORWARD,INVERSE};
 
template <class TScalarType, unsigned int NInputDimensions = 3,
          unsigned int NOutputDimensions = 3>
class ITK_EXPORT       Transform : public itk::Transform<TScalarType, // Data type for scalars
                                                   NInputDimensions,  // Number of dimensions in the input space
                                                   NOutputDimensions> // Number of dimensions in the output space
{
public:
  typedef Transform Self;
  typedef itk::Transform<TScalarType, NInputDimensions, NOutputDimensions> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(Transform, itk::Transform);
 
  itkStaticConstMacro(InputSpaceDimension, unsigned int, NInputDimensions);
  itkStaticConstMacro(OutputSpaceDimension, unsigned int, NOutputDimensions);
 
  unsigned int GetInputSpaceDimension(void) const override
  {
    return NInputDimensions;
  }
 
  unsigned int GetOutputSpaceDimension(void) const override
  {
    return NOutputDimensions;
  }
 
  typedef TScalarType ScalarType;
 
  typedef typename Superclass::ParametersType         ParametersType;
  typedef typename Superclass::ParametersValueType    ParametersValueType;
  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;
 
  typedef itk::Array2D<double> JacobianType;
 
  typedef itk::Vector<TScalarType, NInputDimensions>  InputVectorType;
  typedef itk::Vector<TScalarType, NOutputDimensions> OutputVectorType;
 
  typedef itk::CovariantVector<TScalarType, NInputDimensions>  InputCovariantVectorType;
  typedef itk::CovariantVector<TScalarType, NOutputDimensions> OutputCovariantVectorType;
 
  typedef vnl_vector_fixed<TScalarType, NInputDimensions>  InputVnlVectorType;
  typedef vnl_vector_fixed<TScalarType, NOutputDimensions> OutputVnlVectorType;
 
  typedef itk::Point<TScalarType, NInputDimensions>  InputPointType;
  typedef itk::Point<TScalarType, NOutputDimensions> OutputPointType;
 
  typedef typename Superclass::InverseTransformBaseType InverseTransformBaseType;
 
  typedef typename Superclass::InverseTransformBasePointer InverseTransformBasePointer;
 
  OutputPointType TransformPoint(const InputPointType&) const override
  {
    return OutputPointType();
  }
 
  using Superclass::TransformVector;
  OutputVectorType TransformVector(const InputVectorType&) const override
  {
    return OutputVectorType();
  }
 
  OutputVnlVectorType TransformVector(const InputVnlVectorType&) const override
  {
    return OutputVnlVectorType();
  }
 
  using Superclass::TransformCovariantVector;
  OutputCovariantVectorType TransformCovariantVector(const InputCovariantVectorType&) const override
  {
    return OutputCovariantVectorType();
  }
 
 
  void SetParameters(const ParametersType&) override
  {
    itkExceptionMacro(<< "Subclasses should override this method (SetParameters)")
  }
 
  void ComputeJacobianWithRespectToParameters(const InputPointType&, JacobianType&) const override
  {
    itkExceptionMacro(<< "Subclasses should override this method (ComputeJacobianWithRespectToParameters)");
  }
 
  void SetParametersByValue(const ParametersType& p) override
  {
    this->SetParameters(p);
  }
 
  const ParametersType& GetParameters(void) const override
  {
    return m_Parameters;
  }
 
  void SetFixedParameters(const ParametersType&) override
  {
    itkExceptionMacro(<< "Subclasses should override this method (SetFixedParameters)")
  }
 
  const ParametersType& GetFixedParameters(void) const override
  {
    itkExceptionMacro(<< "Subclasses should override this method (GetFixedParameters)");
    // Next line is needed to avoid errors due to:
    // "function must return a value".
    return this->m_FixedParameters;
  }
 
#ifdef ITKV3_COMPATIBILITY
  const JacobianType& GetJacobian(const InputPointType&) const override
#else
  virtual const JacobianType& GetJacobian(const InputPointType&) const
#endif
  {
    itkExceptionMacro(<< "Subclass should override this method (GetJacobian)");
    // Next line is needed to avoid errors due to:
    // "function must return a value" .
    return this->m_Jacobian;
  }
 
  NumberOfParametersType GetNumberOfParameters(void) const override
  {
    return this->m_Parameters.Size();
  }
 
protected:
  Transform() : Superclass::Transform()
  {
  }
 
  Transform(NumberOfParametersType numberOfParameters) : Superclass::Transform(numberOfParameters)
  {
  }
 
  ~Transform() override
  {
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
#if 0
    os << indent << "Parameters : " << m_Parameters << std::endl;
    os << indent << "FixedParameters : " << m_FixedParameters << std::endl;
    os << indent << "Jacobian : " << m_Jacobian << std::endl;
#endif
  }
 
 
  mutable ParametersType m_Parameters;
  mutable ParametersType m_FixedParameters;
 
  mutable JacobianType m_Jacobian;
 
private:
  Transform(const Self&) = delete;
  void operator=(const Self&) = delete;
};
} // end namespace otb
 
#endif