itkBSplineDecompositionImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkBSplineDecompositionImageFilter_h
#define itkBSplineDecompositionImageFilter_h
 
#include <vector>
 
#include "itkImageLinearIteratorWithIndex.h"
#include "vnl/vnl_matrix.h"
 
#include "itkImageToImageFilter.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT BSplineDecompositionImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BSplineDecompositionImageFilter);

  using Self = BSplineDecompositionImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(BSplineDecompositionImageFilter);

  itkNewMacro(Self);

  using typename Superclass::InputImageType;
  using typename Superclass::InputImagePointer;
  using typename Superclass::InputImageConstPointer;
  using typename Superclass::OutputImagePointer;
 
  using CoeffType = typename itk::NumericTraits<typename TOutputImage::PixelType>::RealType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  using OutputLinearIterator = ImageLinearIteratorWithIndex<TOutputImage>;
 
  using SplinePolesVectorType = std::vector<double>;

  void
  SetSplineOrder(unsigned int SplineOrder);
 
  itkGetConstMacro(SplineOrder, unsigned int);

  itkGetConstMacro(SplinePoles, SplinePolesVectorType);

  itkGetConstMacro(NumberOfPoles, unsigned int);
 
 
  itkConceptMacro(DimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(InputConvertibleToOutputCheck,
                  (Concept::Convertible<typename TInputImage::PixelType, typename TOutputImage::PixelType>));
  itkConceptMacro(DoubleConvertibleToOutputCheck, (Concept::Convertible<double, typename TOutputImage::PixelType>));
 
protected:
  BSplineDecompositionImageFilter();
  ~BSplineDecompositionImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;

  void
  GenerateInputRequestedRegion() override;

  void
  EnlargeOutputRequestedRegion(DataObject * output) override;
 
private:
  using CoefficientsVectorType = std::vector<CoeffType>;

  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 &);
 
  // Variables needed by the smoothing spline routine.

  CoefficientsVectorType m_Scratch{};

  typename TInputImage::SizeType m_DataLength{};

  unsigned int m_SplineOrder{ 0 };
 
  SplinePolesVectorType m_SplinePoles{};
 
  unsigned int m_NumberOfPoles{};

  double m_Tolerance{ 1e-10 };

  unsigned int m_IteratorDirection{ 0 };
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBSplineDecompositionImageFilter.hxx"
#endif
 
#endif