otbBSplineDecompositionImageFilter.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 otbBSplineDecompositionImageFilter_h
#define otbBSplineDecompositionImageFilter_h
 
#include <vector>
 
#include "itkImageLinearIteratorWithIndex.h"
#include "vnl/vnl_matrix.h"
 
#include "itkImageToImageFilter.h"
 
namespace otb
{
template <class TInputImage, class TOutputImage>
class ITK_EXPORT BSplineDecompositionImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef BSplineDecompositionImageFilter Self;
  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(BSplineDecompositionImageFilter, ImageToImageFilter);
 
  itkNewMacro(Self);
 
  typedef typename Superclass::InputImageType         InputImageType;
  typedef typename Superclass::InputImagePointer      InputImagePointer;
  typedef typename Superclass::InputImageConstPointer InputImageConstPointer;
  typedef typename Superclass::OutputImagePointer     OutputImagePointer;
 
  itkStaticConstMacro(ImageDimension, unsigned int, TInputImage::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int, TOutputImage::ImageDimension);
 
  typedef itk::ImageLinearIteratorWithIndex<TOutputImage> OutputLinearIterator;
 
  void SetSplineOrder(unsigned int SplineOrder);
  itkGetMacro(SplineOrder, int);
 
protected:
  BSplineDecompositionImageFilter();
  ~BSplineDecompositionImageFilter() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateData() override;
 
  std::vector<double>            m_Scratch;           // temp storage for processing of Coefficients
  typename TInputImage::SizeType m_DataLength;        // Image size
  unsigned int                   m_SplineOrder;       // User specified spline order (3rd or cubic is the default)
  double                         m_SplinePoles[3];    // Poles calculated for a given spline order
  int                            m_NumberOfPoles;     // number of poles
  double                         m_Tolerance;         // Tolerance used for determining initial causal coefficient
  unsigned int                   m_IteratorDirection; // Direction for iterator incrementing
 
private:
  BSplineDecompositionImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  virtual void SetPoles();
 
  virtual bool DataToCoefficients1D();
 
  void DataToCoefficientsND();
 
  virtual void SetInitialCausalCoefficient(double z);
 
  virtual void SetInitialAntiCausalCoefficient(double z);
 
  void CopyImageToImage();
 
  void CopyCoefficientsToScratch(OutputLinearIterator&);
 
  void CopyScratchToCoefficients(OutputLinearIterator&);
};
 
} // namespace itk
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbBSplineDecompositionImageFilter.hxx"
#endif
 
#endif