itkTikhonovDeconvolutionImageFilter.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 itkTikhonovDeconvolutionImageFilter_h
#define itkTikhonovDeconvolutionImageFilter_h
 
#include "itkInverseDeconvolutionImageFilter.h"
 
namespace itk
{
template <typename TInputImage,
          typename TKernelImage = TInputImage,
          typename TOutputImage = TInputImage,
          typename TInternalPrecision = double>
class ITK_TEMPLATE_EXPORT TikhonovDeconvolutionImageFilter
  : public InverseDeconvolutionImageFilter<TInputImage, TKernelImage, TOutputImage, TInternalPrecision>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(TikhonovDeconvolutionImageFilter);
 
  using Self = TikhonovDeconvolutionImageFilter;
  using Superclass = InverseDeconvolutionImageFilter<TInputImage, TKernelImage, TOutputImage, TInternalPrecision>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(TikhonovDeconvolutionImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
 
  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using KernelImageType = TKernelImage;
  using typename Superclass::InputPixelType;
  using typename Superclass::OutputPixelType;
  using typename Superclass::KernelPixelType;
  using typename Superclass::InputIndexType;
  using typename Superclass::OutputIndexType;
  using typename Superclass::KernelIndexType;
  using typename Superclass::InputSizeType;
  using typename Superclass::OutputSizeType;
  using typename Superclass::KernelSizeType;
  using typename Superclass::SizeValueType;
  using typename Superclass::InputRegionType;
  using typename Superclass::OutputRegionType;
  using typename Superclass::KernelRegionType;

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

  itkSetMacro(RegularizationConstant, double);
  itkGetConstMacro(RegularizationConstant, double);
 
protected:
  TikhonovDeconvolutionImageFilter();
  ~TikhonovDeconvolutionImageFilter() override = default;

  void
  GenerateData() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  double m_RegularizationConstant{};
};
 
namespace Functor
{
template <typename TInput1, typename TInput2, typename TOutput>
class ITK_TEMPLATE_EXPORT TikhonovDeconvolutionFunctor
{
public:
  TikhonovDeconvolutionFunctor() = default;
  ~TikhonovDeconvolutionFunctor() = default;
  TikhonovDeconvolutionFunctor(const TikhonovDeconvolutionFunctor & f)
    : m_RegularizationConstant(f.m_RegularizationConstant)
    , m_KernelZeroMagnitudeThreshold(f.m_KernelZeroMagnitudeThreshold)
  {}
 
  bool
  operator==(const TikhonovDeconvolutionFunctor &) const
  {
    return true;
  }
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(TikhonovDeconvolutionFunctor);
 
  inline TOutput
  operator()(const TInput1 & I, const TInput2 & H) const
  {
    const typename TOutput::value_type normH = std::norm(H);
    const typename TOutput::value_type denominator = normH + m_RegularizationConstant;
    TOutput                            value{};
    if (denominator >= m_KernelZeroMagnitudeThreshold)
    {
      value = static_cast<TOutput>(I * (std::conj(H) / denominator));
    }
 
    return value;
  }

  void
  SetRegularizationConstant(double constant)
  {
    m_RegularizationConstant = constant;
  }
  double
  GetRegularizationConstant() const
  {
    return m_RegularizationConstant;
  }


  void
  SetKernelZeroMagnitudeThreshold(double mu)
  {
    m_KernelZeroMagnitudeThreshold = mu;
  }
  double
  GetKernelZeroMagnitudeThreshold() const
  {
    return m_KernelZeroMagnitudeThreshold;
  }

 
private:
  double m_RegularizationConstant = 0.0;
  double m_KernelZeroMagnitudeThreshold = 0.0;
};
} // namespace Functor
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkTikhonovDeconvolutionImageFilter.hxx"
#endif
 
#endif