otbBSplineInterpolateImageFunction.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 otbBSplineInterpolateImageFunction_h
#define otbBSplineInterpolateImageFunction_h
 
#include <vector>
 
#include "itkInterpolateImageFunction.h"
#include "vnl/vnl_matrix.h"
 
#include "otbBSplineDecompositionImageFilter.h"
#include "itkConceptChecking.h"
#include "itkCovariantVector.h"
 
namespace otb
{
template <class TImageType, class TCoordRep = double, class TCoefficientType = double>
class ITK_EXPORT BSplineInterpolateImageFunction : public itk::InterpolateImageFunction<TImageType, TCoordRep>
{
public:
  typedef BSplineInterpolateImageFunction Self;
  typedef itk::InterpolateImageFunction<TImageType, TCoordRep> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(BSplineInterpolateImageFunction, InterpolateImageFunction);
 
  itkNewMacro(Self);
 
  typedef typename Superclass::OutputType OutputType;
 
  typedef typename Superclass::InputImageType InputImageType;
 
  itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);
 
  typedef typename Superclass::IndexType IndexType;
 
  typedef typename InputImageType::RegionType RegionType;
 
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
 
  typedef typename Superclass::PointType PointType;
 
  typedef typename Superclass::SizeType SizeType;
 
  typedef itk::ImageLinearIteratorWithIndex<TImageType> Iterator;
 
  typedef TCoefficientType CoefficientDataType;
  typedef itk::Image<CoefficientDataType, itkGetStaticConstMacro(ImageDimension)> CoefficientImageType;
 
  typedef otb::BSplineDecompositionImageFilter<TImageType, CoefficientImageType> CoefficientFilter;
  typedef typename CoefficientFilter::Pointer CoefficientFilterPointer;
 
  OutputType EvaluateAtContinuousIndex(const ContinuousIndexType& index) const override;
 
  typedef itk::CovariantVector<OutputType, itkGetStaticConstMacro(ImageDimension)> CovariantVectorType;
 
  CovariantVectorType EvaluateDerivative(const PointType& point) const
  {
    ContinuousIndexType index;
    this->GetInputImage()->TransformPhysicalPointToContinuousIndex(point, index);
    return (this->EvaluateDerivativeAtContinuousIndex(index));
  }
 
  CovariantVectorType EvaluateDerivativeAtContinuousIndex(const ContinuousIndexType& x) const;
 
  void SetSplineOrder(unsigned int SplineOrder);
  itkGetMacro(SplineOrder, int);
 
  void SetInputImage(const TImageType* inputData) override;
 
  virtual void UpdateCoefficientsFilter(void);
 
  virtual SizeType GetRadius() const
  {
    typename itk::InterpolateImageFunction<TImageType, TCoordRep>::SizeType radius({2,2});
    return radius;
  }
 
protected:
  BSplineInterpolateImageFunction();
  ~BSplineInterpolateImageFunction() override = default;
 
  void operator=(const Self&) = delete;
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  // These are needed by the smoothing spline routine.
  std::vector<CoefficientDataType> m_Scratch;     // temp storage for processing of Coefficients
  typename TImageType::SizeType    m_DataLength;  // Image size
  unsigned int                     m_SplineOrder; // User specified spline order (3rd or cubic is the default)
 
  typename CoefficientImageType::ConstPointer m_Coefficients; // Spline coefficients
 
private:
  BSplineInterpolateImageFunction(const Self&) = delete;
  void SetInterpolationWeights(const ContinuousIndexType& x, const vnl_matrix<long>& EvaluateIndex, vnl_matrix<double>& weights,
                               unsigned int splineOrder) const;
 
  void SetDerivativeWeights(const ContinuousIndexType& x, const vnl_matrix<long>& EvaluateIndex, vnl_matrix<double>& weights, unsigned int splineOrder) const;
 
  void GeneratePointsToIndex();
 
  void DetermineRegionOfSupport(vnl_matrix<long>& evaluateIndex, const ContinuousIndexType& x, unsigned int splineOrder) const;
 
  void ApplyMirrorBoundaryConditions(vnl_matrix<long>& evaluateIndex, unsigned int splineOrder) const;
 
  Iterator               m_CIterator;                    // Iterator for traversing spline coefficients.
  unsigned long          m_MaxNumberInterpolationPoints; // number of neighborhood points used for interpolation
  std::vector<IndexType> m_PointsToIndex;                // Preallocation of interpolation neighborhood indices
 
  CoefficientFilterPointer m_CoefficientFilter;
 
  RegionType m_CurrentBufferedRegion;
};
 
} // namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbBSplineInterpolateImageFunction.hxx"
#endif
 
#endif