itkNonLocalPatchBasedImageFilter.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 itkNonLocalPatchBasedImageFilter_h
#define itkNonLocalPatchBasedImageFilter_h
 
#include <iostream>
#include "itkImageToImageFilter.h"
#include "AdaptiveDenoisingExport.h"
 
#include "itkConstNeighborhoodIterator.h"
 
namespace itk
{

 
class NonLocalPatchBasedImageFilterEnums
{
public:
  enum class SimilarityMetric : uint8_t
  {
    PEARSON_CORRELATION = 0,
    MEAN_SQUARES = 1
  };
};
 
extern AdaptiveDenoising_EXPORT std::ostream &
operator<<(std::ostream & out, const NonLocalPatchBasedImageFilterEnums::SimilarityMetric value);
 

 
template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT NonLocalPatchBasedImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(NonLocalPatchBasedImageFilter);

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

  itkOverrideGetNameOfClassMacro(NonLocalPatchBasedImageFilter);

  itkNewMacro(Self);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using InputImageType = TInputImage;
  using InputPixelType = typename InputImageType::PixelType;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageList = std::vector<InputImagePointer>;
  using InputImageSetList = std::vector<InputImageList>;
  using RegionType = typename InputImageType::RegionType;
 
  using OutputImageType = TOutputImage;
  using OutputPixelType = typename OutputImageType::PixelType;
 
  using InputImagePixelVectorType = std::vector<InputPixelType>;
 
  using RealType = float;
  using RealImageType = Image<RealType, ImageDimension>;
  using RealImagePointer = typename RealImageType::Pointer;
  using IndexType = typename RealImageType::IndexType;
 
  using NeighborhoodType = Neighborhood<InputPixelType, ImageDimension>;
  using NeighborhoodSizeType = SizeValueType;
 
  using ConstNeighborhoodIteratorType = ConstNeighborhoodIterator<InputImageType>;
  using NeighborhoodRadiusType = typename ConstNeighborhoodIteratorType::RadiusType;
  using NeighborhoodOffsetType = typename ConstNeighborhoodIteratorType::OffsetType;
 
  using NeighborhoodOffsetListType = std::vector<NeighborhoodOffsetType>;
 
  using SimilarityMetricEnum = NonLocalPatchBasedImageFilterEnums::SimilarityMetric;
#if !defined(ITK_LEGACY_REMOVE)
  using SimilarityMetricType = SimilarityMetricEnum;
  static constexpr SimilarityMetricType PEARSON_CORRELATION = SimilarityMetricEnum::PEARSON_CORRELATION;
  static constexpr SimilarityMetricType MEAN_SQUARES = SimilarityMetricEnum::MEAN_SQUARES;
#endif

  itkSetMacro(NeighborhoodSearchRadius, NeighborhoodRadiusType);
  itkGetConstMacro(NeighborhoodSearchRadius, NeighborhoodRadiusType);

  itkSetMacro(NeighborhoodSearchSize, NeighborhoodSizeType);
  itkGetConstMacro(NeighborhoodSearchSize, NeighborhoodSizeType);

  virtual void
  SetNeighborhoodSearchOffsetList(const NeighborhoodOffsetListType list)
  {
    this->m_NeighborhoodSearchOffsetList = list;
    this->Modified();
  }
  itkGetConstMacro(NeighborhoodSearchOffsetList, NeighborhoodOffsetListType);

  itkSetMacro(NeighborhoodPatchRadius, NeighborhoodRadiusType);
  itkGetConstMacro(NeighborhoodPatchRadius, NeighborhoodRadiusType);

  itkSetMacro(NeighborhoodPatchSize, NeighborhoodSizeType);
  itkGetConstMacro(NeighborhoodPatchSize, NeighborhoodSizeType);

  virtual void
  SetNeighborhoodPatchOffsetList(const NeighborhoodOffsetListType list)
  {
    this->m_NeighborhoodPatchOffsetList = list;
    this->Modified();
  }
  itkGetConstMacro(NeighborhoodPatchOffsetList, NeighborhoodOffsetListType);

  itkSetMacro(SimilarityMetric, SimilarityMetricEnum);
  itkGetConstMacro(SimilarityMetric, SimilarityMetricEnum);
 
protected:
  NonLocalPatchBasedImageFilter();
  ~NonLocalPatchBasedImageFilter() override = default;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  RealType
  ComputeNeighborhoodPatchSimilarity(const InputImageList &,
                                     const IndexType,
                                     const InputImagePixelVectorType &,
                                     const bool);
 
  InputImagePixelVectorType
  VectorizeImageListPatch(const InputImageList &, const IndexType, const bool);
 
  InputImagePixelVectorType
  VectorizeImagePatch(const InputImagePointer, const IndexType, const bool);
 
  void
  GetMeanAndStandardDeviationOfVectorizedImagePatch(const InputImagePixelVectorType &, RealType &, RealType &);
 
  itkSetMacro(TargetImageRegion, RegionType);
  itkGetConstMacro(TargetImageRegion, RegionType);
 
  SimilarityMetricEnum m_SimilarityMetric;
 
  SizeValueType              m_NeighborhoodSearchSize;
  NeighborhoodRadiusType     m_NeighborhoodSearchRadius;
  NeighborhoodOffsetListType m_NeighborhoodSearchOffsetList;
 
  SizeValueType              m_NeighborhoodPatchSize;
  NeighborhoodRadiusType     m_NeighborhoodPatchRadius;
  NeighborhoodOffsetListType m_NeighborhoodPatchOffsetList;
 
  RegionType m_TargetImageRegion;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkNonLocalPatchBasedImageFilter.hxx"
#endif
 
#endif