itkAdaptiveNonLocalMeansDenoisingImageFilter.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 itkAdaptiveNonLocalMeansDenoisingImageFilter_h
#define itkAdaptiveNonLocalMeansDenoisingImageFilter_h
 
#include "itkNonLocalPatchBasedImageFilter.h"
 
#include "itkConstNeighborhoodIterator.h"
#include "itkGaussianOperator.h"
 
namespace itk
{

 
template <typename TInputImage,
          typename TOutputImage = TInputImage,
          typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT AdaptiveNonLocalMeansDenoisingImageFilter final
  : public NonLocalPatchBasedImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AdaptiveNonLocalMeansDenoisingImageFilter);

  using Self = AdaptiveNonLocalMeansDenoisingImageFilter;
  using Superclass = NonLocalPatchBasedImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(AdaptiveNonLocalMeansDenoisingImageFilter);

  itkNewMacro(Self);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using InputImageType = TInputImage;
  using InputPixelType = typename InputImageType::PixelType;
  using OutputImageType = TOutputImage;
  using RegionType = typename Superclass::RegionType;
 
  using MaskImageType = TMaskImage;
  using MaskPixelType = typename MaskImageType::PixelType;
  using LabelType = typename MaskImageType::PixelType;
 
  using RealType = typename Superclass::RealType;
  using RealImageType = typename Superclass::RealImageType;
  using RealImagePointer = typename Superclass::RealImagePointer;
  using IndexType = typename Superclass::IndexType;
 
  using ConstNeighborhoodIteratorType = typename Superclass::ConstNeighborhoodIteratorType;
  using NeighborhoodRadiusType = typename Superclass::NeighborhoodRadiusType;
  using NeighborhoodOffsetType = typename Superclass::NeighborhoodOffsetType;
  using NeighborhoodOffsetListType = typename Superclass::NeighborhoodOffsetListType;
 
  using ModifiedBesselCalculatorType = GaussianOperator<RealType>;

  void
  SetInput1(const InputImageType * image)
  {
    this->SetInput(image);
  }

  void
  SetMaskImage(const MaskImageType * mask)
  {
    this->SetNthInput(1, const_cast<MaskImageType *>(mask));
  }
  void
  SetInput2(const MaskImageType * mask)
  {
    this->SetMaskImage(mask);
  }

  const MaskImageType *
  GetMaskImage() const
  {
    return static_cast<const MaskImageType *>(this->ProcessObject::GetInput(1));
  }

  itkNonVirtualSetMacro(UseRicianNoiseModel, bool);
  itkNonVirtualGetConstMacro(UseRicianNoiseModel, bool);
  itkNonVirtualBooleanMacro(UseRicianNoiseModel);

  itkNonVirtualSetMacro(SmoothingFactor, RealType);
  itkNonVirtualGetConstMacro(SmoothingFactor, RealType);

  itkNonVirtualSetMacro(SmoothingVariance, RealType);
  itkNonVirtualGetConstMacro(SmoothingVariance, RealType);

  itkNonVirtualSetMacro(Epsilon, RealType);
  itkNonVirtualGetConstMacro(Epsilon, RealType);

  itkNonVirtualSetMacro(MeanThreshold, RealType);
  itkNonVirtualGetConstMacro(MeanThreshold, RealType);

  itkNonVirtualSetMacro(VarianceThreshold, RealType);
  itkNonVirtualGetConstMacro(VarianceThreshold, RealType);

  itkNonVirtualSetMacro(NeighborhoodRadiusForLocalMeanAndVariance, NeighborhoodRadiusType);
  itkNonVirtualGetConstMacro(NeighborhoodRadiusForLocalMeanAndVariance, NeighborhoodRadiusType);
 
protected:
  AdaptiveNonLocalMeansDenoisingImageFilter();
  ~AdaptiveNonLocalMeansDenoisingImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  ThreadedGenerateData(const RegionType &, ThreadIdType) override;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  AfterThreadedGenerateData() override;
 
private:
  RealType CalculateCorrectionFactor(RealType);
 
  bool m_UseRicianNoiseModel;
 
  ModifiedBesselCalculatorType m_ModifiedBesselCalculator;
 
  RealType m_Epsilon;
  RealType m_MeanThreshold;
  RealType m_VarianceThreshold;
  RealType m_SmoothingFactor;
  RealType m_SmoothingVariance;
 
  RealType m_MaximumInputPixelIntensity;
  RealType m_MinimumInputPixelIntensity;
 
  RealImagePointer m_MeanImage;
  RealImagePointer m_RicianBiasImage;
  RealImagePointer m_VarianceImage;
  RealImagePointer m_ThreadContributionCountImage;
  RealImagePointer m_IntensitySquaredDistanceImage;
 
  NeighborhoodRadiusType m_NeighborhoodRadiusForLocalMeanAndVariance;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAdaptiveNonLocalMeansDenoisingImageFilter.hxx"
#endif
 
#endif