itkBSplineResampleImageFilterBase.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 itkBSplineResampleImageFilterBase_h
#define itkBSplineResampleImageFilterBase_h
 
#include <vector>
 
#include "itkImageLinearIteratorWithIndex.h"
#include "itkImageRegionIterator.h" // Used for the output iterator needs to
                                    // match filter program
#include "itkProgressReporter.h"
#include "itkImageToImageFilter.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT BSplineResampleImageFilterBase : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BSplineResampleImageFilterBase);

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

  itkOverrideGetNameOfClassMacro(BSplineResampleImageFilterBase);

  //  Must be instantiated through another class. itkNewMacro( Self );

  using typename Superclass::InputImageType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using IndexType = typename TInputImage::IndexType;

  using SizeType = typename TInputImage::SizeType;

  using RegionType = typename TInputImage::RegionType;

  using typename Superclass::OutputImagePixelType;

  using ConstInputImageIterator = itk::ImageLinearConstIteratorWithIndex<TInputImage>;

  using ConstOutputImageIterator = itk::ImageLinearConstIteratorWithIndex<TOutputImage>;

  using OutputImageIterator = itk::ImageLinearIteratorWithIndex<TOutputImage>;

  void
  SetSplineOrder(int splineOrder);

  itkGetConstMacro(SplineOrder, int);
 
protected:
  void
  ReduceNDImage(OutputImageIterator & outItr);

  void
  ExpandNDImage(OutputImageIterator & outItr);

  virtual void
  InitializePyramidSplineFilter(int SplineOrder);

  virtual void
  Reduce1DImage(const std::vector<double> & in,
                OutputImageIterator &       out,
                unsigned int                inTraverseSize,
                ProgressReporter &          progress);

  virtual void
  Expand1DImage(const std::vector<double> & in,
                OutputImageIterator &       out,
                unsigned int                inTraverseSize,
                ProgressReporter &          progress);
 
  BSplineResampleImageFilterBase();
  ~BSplineResampleImageFilterBase() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  int m_SplineOrder{}; // User specified spline order
  int m_GSize{};       // downsampling filter size
  int m_HSize{};       // upsampling filter size
 
  std::vector<double> m_G{}; // downsampling filter coefficients
  std::vector<double> m_H{}; // upsampling filter coefficients
 
private:
  void
  InitializeScratch(SizeType DataLength);

  void
  CopyInputLineToScratch(ConstInputImageIterator & Iter);
 
  void
  CopyOutputLineToScratch(ConstOutputImageIterator & Iter);
 
  void
  CopyLineToScratch(ConstInputImageIterator & Iter);
 
  std::vector<double> m_Scratch{}; // temp storage for processing
                                   // of Coefficients
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBSplineResampleImageFilterBase.hxx"
#endif
 
#endif