otbBCOInterpolateImageFunction.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2020 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 otbBCOInterpolateImageFunction_h
#define otbBCOInterpolateImageFunction_h

#include <boost/version.hpp>
#if BOOST_VERSION >= 105800
#include <boost/container/small_vector.hpp>
#else
#include "vnl/vnl_vector.h"
#endif

#include "itkInterpolateImageFunction.h"
#include "otbMath.h"

#include "otbVectorImage.h"

namespace otb
{
template <class TInputImage, class TCoordRep = double>
class ITK_EXPORT BCOInterpolateImageFunctionBase : public itk::InterpolateImageFunction<TInputImage, TCoordRep>
{
public:
  typedef BCOInterpolateImageFunctionBase                       Self;
  typedef itk::InterpolateImageFunction<TInputImage, TCoordRep> Superclass;

  itkTypeMacro(BCOInterpolateImageFunctionBase, InterpolateImageFunction);

  typedef typename Superclass::OutputType OutputType;

  typedef typename Superclass::InputImageType InputImageType;

  typedef typename Superclass::InputPixelType InputPixelType;

  typedef typename Superclass::RealType RealType;

  itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);

  typedef typename Superclass::IndexType      IndexType;
  typedef typename Superclass::IndexValueType IndexValueType;

  typedef typename Superclass::PointType PointType;

  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
  typedef TCoordRep                                ContinuousIndexValueType;

#if BOOST_VERSION >= 105800
  // Faster path for small radii.
  typedef boost::container::small_vector<double, 7> CoefContainerType;
#else

  typedef vnl_vector<double> CoefContainerType;
#endif

  virtual void         SetRadius(unsigned int radius);
  virtual unsigned int GetRadius() const;

  virtual void   SetAlpha(double alpha);
  virtual double GetAlpha() const;

  OutputType EvaluateAtContinuousIndex(const ContinuousIndexType& index) const override = 0;

protected:
  BCOInterpolateImageFunctionBase() : m_Radius(2), m_WinSize(5), m_Alpha(-0.5){};
  ~BCOInterpolateImageFunctionBase() override{};
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
  CoefContainerType EvaluateCoef(const ContinuousIndexValueType& indexValue) const;

  unsigned int m_Radius;

  unsigned int m_WinSize;

  double m_Alpha;

private:
  BCOInterpolateImageFunctionBase(const Self&) = delete;
  void operator=(const Self&) = delete;
};


template <class TInputImage, class TCoordRep = double>
class ITK_EXPORT BCOInterpolateImageFunction : public otb::BCOInterpolateImageFunctionBase<TInputImage, TCoordRep>
{
public:
  typedef BCOInterpolateImageFunction                             Self;
  typedef BCOInterpolateImageFunctionBase<TInputImage, TCoordRep> Superclass;
  typedef itk::SmartPointer<Self>                                 Pointer;
  typedef itk::SmartPointer<const Self>                           ConstPointer;

  itkTypeMacro(BCOInterpolateImageFunction, BCOInterpolateImageFunctionBase);
  itkNewMacro(Self);
  itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);

  typedef typename Superclass::OutputType          OutputType;
  typedef typename Superclass::InputImageType      InputImageType;
  typedef typename Superclass::InputPixelType      InputPixelType;
  typedef typename Superclass::RealType            RealType;
  typedef typename Superclass::IndexType           IndexType;
  typedef typename Superclass::IndexValueType      IndexValueType;
  typedef typename Superclass::PointType           PointType;
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
  typedef typename Superclass::CoefContainerType   CoefContainerType;

  OutputType EvaluateAtContinuousIndex(const ContinuousIndexType& index) const override;

protected:
  BCOInterpolateImageFunction(){};
  ~BCOInterpolateImageFunction() override{};
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;

private:
  BCOInterpolateImageFunction(const Self&) = delete;
  void operator=(const Self&) = delete;
};


template <typename TPixel, unsigned int VImageDimension, class TCoordRep>
class ITK_EXPORT BCOInterpolateImageFunction<otb::VectorImage<TPixel, VImageDimension>, TCoordRep>
  : public otb::BCOInterpolateImageFunctionBase<otb::VectorImage<TPixel, VImageDimension>, TCoordRep>
{
public:
  typedef BCOInterpolateImageFunction                                                           Self;
  typedef BCOInterpolateImageFunctionBase<otb::VectorImage<TPixel, VImageDimension>, TCoordRep> Superclass;
  typedef itk::SmartPointer<Self>                                                               Pointer;
  typedef itk::SmartPointer<const Self>                                                         ConstPointer;

  itkTypeMacro(BCOInterpolateImageFunction, BCOInterpolateImageFunctionBase);
  itkNewMacro(Self);
  itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);

  typedef typename Superclass::OutputType          OutputType;
  typedef typename Superclass::InputImageType      InputImageType;
  typedef typename Superclass::InputPixelType      InputPixelType;
  typedef typename Superclass::RealType            RealType;
  typedef typename Superclass::IndexType           IndexType;
  typedef typename Superclass::IndexValueType      IndexValueType;
  typedef typename Superclass::PointType           PointType;
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
  typedef typename Superclass::CoefContainerType   CoefContainerType;

  OutputType EvaluateAtContinuousIndex(const ContinuousIndexType& index) const override;

protected:
  BCOInterpolateImageFunction(){};
  ~BCOInterpolateImageFunction() override{};
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;

private:
  BCOInterpolateImageFunction(const Self&) = delete;
  void operator=(const Self&) = delete;
};

} // end namespace otb

#ifndef OTB_MANUAL_INSTANTIATION
#include "otbBCOInterpolateImageFunction.hxx"
#endif

#endif