itkIterativeDeconvolutionImageFilter.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.
 *
 *=========================================================================*/
#ifndef itkIterativeDeconvolutionImageFilter_h
#define itkIterativeDeconvolutionImageFilter_h
 
#include "itkFFTConvolutionImageFilter.h"
#include "itkProgressAccumulator.h"
 
namespace itk
{
template <typename TInputImage,
          typename TKernelImage = TInputImage,
          typename TOutputImage = TInputImage,
          typename TInternalPrecision = double>
class ITK_TEMPLATE_EXPORT IterativeDeconvolutionImageFilter
  : public FFTConvolutionImageFilter<TInputImage, TKernelImage, TOutputImage, TInternalPrecision>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(IterativeDeconvolutionImageFilter);

  using Self = IterativeDeconvolutionImageFilter;
  using Superclass = FFTConvolutionImageFilter<TInputImage, TKernelImage, TOutputImage, TInternalPrecision>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using InputImageType = TInputImage;
  using KernelImageType = TKernelImage;
  using OutputImageType = TOutputImage;

  using typename Superclass::InternalImageType;
  using typename Superclass::InternalImagePointerType;
  using typename Superclass::InternalComplexType;
  using typename Superclass::InternalComplexImageType;
  using typename Superclass::InternalComplexImagePointerType;

  itkOverrideGetNameOfClassMacro(IterativeDeconvolutionImageFilter);

  itkSetMacro(NumberOfIterations, unsigned int);
  itkGetMacro(NumberOfIterations, unsigned int);

  itkGetModifiableObjectMacro(CurrentEstimate, InternalImageType);

  void
  SetStopIteration(bool stop)
  {
    // Don't call Modified() to avoid triggering a new update.
    m_StopIteration = stop;
  }
  itkGetConstMacro(StopIteration, bool);

  itkGetConstMacro(Iteration, unsigned int);
 
protected:
  IterativeDeconvolutionImageFilter();
  ~IterativeDeconvolutionImageFilter() override;

  virtual void
  Initialize(ProgressAccumulator * progress, float progressWeight, float iterationProgressWeight);

  virtual void
  Iteration(ProgressAccumulator * itkNotUsed(progress), float itkNotUsed(iterationProgressWeight)) = 0;

  virtual void
  Finish(ProgressAccumulator * progress, float progressWeight);

  void
  GenerateInputRequestedRegion() override;

  void
  GenerateData() override;

  InternalComplexImagePointerType m_TransferFunction{};

  InternalImagePointerType m_CurrentEstimate{};
 
  using typename Superclass::FFTFilterType;
  using typename Superclass::IFFTFilterType;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  unsigned int m_NumberOfIterations{};

  unsigned int m_Iteration{};

  bool m_StopIteration{};

  ModifiedTimeType m_InputMTime{};
  ModifiedTimeType m_KernelMTime{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkIterativeDeconvolutionImageFilter.hxx"
#endif
 
#endif