otbWindowedSincInterpolateImageBlackmanFunction.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 otbWindowedSincInterpolateImageBlackmanFunction_h
#define otbWindowedSincInterpolateImageBlackmanFunction_h
 
#include "otbWindowedSincInterpolateImageFunctionBase.h"
#include "vnl/vnl_math.h"
 
namespace otb
{
 
namespace Function
{
template <class TInput = double, class TOutput = double>
class BlackmanWindowFunction
{
public:
  BlackmanWindowFunction() : m_Radius(1), m_Factor1(CONST_PI), m_Factor2(2.0 * CONST_PI)
  {
  } // default radius is 1 at construction
  void SetRadius(unsigned int radius)
  {
    m_Radius  = radius;
    m_Factor1 = CONST_PI / static_cast<double>(radius);
    m_Factor2 = 2.0 * CONST_PI / static_cast<double>(radius);
  }
  unsigned int GetRadius() const
  {
    return m_Radius;
  }
  double GetFactor1()
  {
    return m_Factor1;
  }
  double GetFactor2()
  {
    return m_Factor2;
  }
 
  inline TOutput operator()(const TInput& A) const
  {
    double x    = static_cast<double>(A);
    double px   = CONST_PI * x;
    double temp = 0.42 + 0.5 * std::cos(x * m_Factor1) + 0.08 * std::cos(x * m_Factor2);
    return (x == 0.0) ? static_cast<TOutput>(temp) : static_cast<TOutput>(temp * std::sin(px) / px);
  }
 
private:
  unsigned int m_Radius;
  // Equal to \f$ \frac{\pi}{m} \f$
  double m_Factor1;
  // Equal to \f$ \frac{2 \pi}{m} \f$
  double m_Factor2;
};
} // namespace Function
 
template <class TInputImage, class TBoundaryCondition = itk::ConstantBoundaryCondition<TInputImage>, class TCoordRep = double,
          class TInputInterpolator = double, class TOutputInterpolator = double>
class ITK_EXPORT WindowedSincInterpolateImageBlackmanFunction
    : public WindowedSincInterpolateImageFunctionBase<TInputImage, typename Function::BlackmanWindowFunction<TInputInterpolator, TOutputInterpolator>,
                                                      TBoundaryCondition, TCoordRep>
{
public:
 
  typedef WindowedSincInterpolateImageBlackmanFunction Self;
  typedef WindowedSincInterpolateImageFunctionBase<TInputImage, typename Function::BlackmanWindowFunction<TInputInterpolator, TOutputInterpolator>,
                                                   TBoundaryCondition, TCoordRep>
                                        Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(WindowedSincInterpolateImageBlackmanFunction, WindowedSincInterpolateImageFunctionBase);
 
  itkNewMacro(Self);
 
  typedef typename Superclass::InputImageType InputImageType;
  typedef typename Superclass::OutputType     OutputType;
 
  itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);
 
  typedef typename Superclass::IndexType           IndexType;
  typedef typename Superclass::SizeType            SizeType;
  typedef typename Superclass::RealType            RealType;
  typedef typename Superclass::IteratorType        IteratorType;
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
 
protected:
  WindowedSincInterpolateImageBlackmanFunction(){};
  ~WindowedSincInterpolateImageBlackmanFunction() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
  }
 
private:
  WindowedSincInterpolateImageBlackmanFunction(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#endif