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
 *
 *         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 itkParametricBlindLeastSquaresDeconvolutionImageFilter_h
#define itkParametricBlindLeastSquaresDeconvolutionImageFilter_h
 
#include "itkIterativeDeconvolutionImageFilter.h"
 
#include "itkParametricImageSource.h"
#include "itkTernaryGeneratorImageFilter.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_MOVE(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 typename Superclass::InternalImageType;
  using typename Superclass::InternalImagePointerType;
  using typename Superclass::InternalComplexType;
  using typename Superclass::InternalComplexImageType;
  using typename Superclass::InternalComplexImagePointerType;

  using KernelSourceType = TKernelSource;
  using KernelSourcePointer = typename KernelSourceType::Pointer;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ParametricBlindLeastSquaresDeconvolutionImageFilter);

  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:
  KernelSourcePointer m_KernelSource{};

  double m_Alpha{};
  double m_Beta{};

  InternalComplexImagePointerType m_TransformedInput{};
  InternalComplexImagePointerType m_TransformedCurrentEstimate{};

  using DifferenceFilterType = TernaryGeneratorImageFilter<InternalComplexImageType,
                                                           InternalComplexImageType,
                                                           InternalComplexImageType,
                                                           InternalComplexImageType>;
  typename DifferenceFilterType::Pointer m_DifferenceFilter{};
 
  using ImageUpdateFilterType = TernaryGeneratorImageFilter<InternalComplexImageType,
                                                            InternalComplexImageType,
                                                            InternalComplexImageType,
                                                            InternalComplexImageType>;
  typename ImageUpdateFilterType::Pointer m_ImageUpdateFilter{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkParametricBlindLeastSquaresDeconvolutionImageFilter.hxx"
#endif
 
 
#endif