itkParametricBlindLeastSquaresDeconvolutionImageFilter.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
 *
 *         http://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 itkParametricBlindLeastSquaresDeconvolutionImageFilter_h
#define itkParametricBlindLeastSquaresDeconvolutionImageFilter_h
 
#include "itkIterativeDeconvolutionImageFilter.h"
 
#include "itkParametricImageSource.h"
#include "itkTernaryFunctorImageFilter.h"
 
namespace itk
{
template <typename TInputImage, typename TKernelSource, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT ParametricBlindLeastSquaresDeconvolutionImageFilter
  : public IterativeDeconvolutionImageFilter<TInputImage, typename TKernelSource::OutputImageType, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ParametricBlindLeastSquaresDeconvolutionImageFilter);
 
  using Self = ParametricBlindLeastSquaresDeconvolutionImageFilter;
  using Superclass =
    IterativeDeconvolutionImageFilter<TInputImage, typename TKernelSource::OutputImageType, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
 
  using InternalImageType = typename Superclass::InternalImageType;
  using InternalImagePointerType = typename Superclass::InternalImagePointerType;
  using InternalComplexType = typename Superclass::InternalComplexType;
  using InternalComplexImageType = typename Superclass::InternalComplexImageType;
  using InternalComplexImagePointerType = typename Superclass::InternalComplexImagePointerType;
 
  using KernelSourceType = TKernelSource;
  using KernelSourcePointer = typename KernelSourceType::Pointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ParametricBlindLeastSquaresDeconvolutionImageFilter, IterativeDeconvolutionImageFilter);
 
  void
  SetKernelSource(KernelSourceType * kernelSource);
  itkGetModifiableObjectMacro(KernelSource, KernelSourceType);
 
  itkSetMacro(Alpha, double);
  itkGetMacro(Alpha, double);
 
  itkSetMacro(Beta, double);
  itkGetMacro(Beta, double);
 
protected:
  ParametricBlindLeastSquaresDeconvolutionImageFilter();
  ~ParametricBlindLeastSquaresDeconvolutionImageFilter() override = default;
 
  void
  Initialize(ProgressAccumulator * progress, float progressWeight, float iterationProgressWeight) override;
 
  void
  Iteration(ProgressAccumulator * progress, float iterationProgressWeight) override;
 
  void
  Finish(ProgressAccumulator * progress, float progressWeight) override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  template <typename TPixel>
  class ITK_TEMPLATE_EXPORT ParametricBlindLeastSquaresDeconvolutionDifference
  {
  public:
    ParametricBlindLeastSquaresDeconvolutionDifference() = default;
    ~ParametricBlindLeastSquaresDeconvolutionDifference() = default;
 
    bool
    operator!=(const ParametricBlindLeastSquaresDeconvolutionDifference &) const
    {
      return false;
    }
 
    bool
    operator==(const ParametricBlindLeastSquaresDeconvolutionDifference & other) const
    {
      return !(*this != other);
    }
 
    inline TPixel
    operator()(const TPixel & estimateFT, const TPixel & kernelEstimateFT, const TPixel & inputFT)
    {
      return estimateFT * kernelEstimateFT - inputFT;
    }
  };
 
  template <typename TPixel>
  class ITK_TEMPLATE_EXPORT ParametricBlindLeastSquaresDeconvolutionImageUpdate
  {
  public:
    ParametricBlindLeastSquaresDeconvolutionImageUpdate() = default;
    ~ParametricBlindLeastSquaresDeconvolutionImageUpdate() = default;
 
    bool
    operator!=(const ParametricBlindLeastSquaresDeconvolutionImageUpdate &) const
    {
      return false;
    }
 
    bool
    operator==(const ParametricBlindLeastSquaresDeconvolutionImageUpdate & other) const
    {
      return !(*this != other);
    }
 
    inline TPixel
    operator()(const TPixel & estimateFT, const TPixel & differenceFT, const TPixel & kernelFT)
    {
      // Because of the linearity of the Fourier transform, we can
      // perform the update step in the Fourier domain
      return estimateFT - m_Alpha * (differenceFT * std::conj(kernelFT));
    }
 
    void
    SetAlpha(double alpha)
    {
      m_Alpha = alpha;
    }
    double
    GetAlpha() const
    {
      return m_Alpha;
    }
 
  private:
    double m_Alpha{ 0.01 };
  };
 
  KernelSourcePointer m_KernelSource;
 
  double m_Alpha;
  double m_Beta;
 
  InternalComplexImagePointerType m_TransformedInput;
  InternalComplexImagePointerType m_TransformedCurrentEstimate;
 
  using DifferenceFunctorType = ParametricBlindLeastSquaresDeconvolutionDifference<InternalComplexType>;
  using DifferenceFilterType = TernaryFunctorImageFilter<InternalComplexImageType,
                                                         InternalComplexImageType,
                                                         InternalComplexImageType,
                                                         InternalComplexImageType,
                                                         DifferenceFunctorType>;
  typename DifferenceFilterType::Pointer m_DifferenceFilter;
 
  using ImageUpdateFunctorType = ParametricBlindLeastSquaresDeconvolutionImageUpdate<InternalComplexType>;
  using ImageUpdateFilterType = TernaryFunctorImageFilter<InternalComplexImageType,
                                                          InternalComplexImageType,
                                                          InternalComplexImageType,
                                                          InternalComplexImageType,
                                                          ImageUpdateFunctorType>;
  typename ImageUpdateFilterType::Pointer m_ImageUpdateFilter;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkParametricBlindLeastSquaresDeconvolutionImageFilter.hxx"
#endif
 
 
#endif