sitkPatchBasedDenoisingImageFilter.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 sitkPatchBasedDenoisingImageFilter_h
#define sitkPatchBasedDenoisingImageFilter_h
 
/*
 * WARNING: DO NOT EDIT THIS FILE!
 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
 * Please look at sitkImageFilterTemplate.h.jinja to make changes.
 */
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
#include "sitkProcessObjectDeleter.h"
 
namespace itk::simple {

class SITKBasicFilters_EXPORT PatchBasedDenoisingImageFilter : public ImageFilter {
public:
  using Self = PatchBasedDenoisingImageFilter;

  virtual ~PatchBasedDenoisingImageFilter();

  PatchBasedDenoisingImageFilter();

  using PixelIDTypeList = BasicPixelIDTypeList;
 
 
 

  void
  SetKernelBandwidthSigma(double KernelBandwidthSigma )
    { this->m_KernelBandwidthSigma = KernelBandwidthSigma; }

  double
  GetKernelBandwidthSigma() const { return this->m_KernelBandwidthSigma; }
 

  void
  SetPatchRadius(uint32_t PatchRadius )
    { this->m_PatchRadius = PatchRadius; }

  uint32_t
  GetPatchRadius() const { return this->m_PatchRadius; }
 

  void
  SetNumberOfIterations(uint32_t NumberOfIterations )
    { this->m_NumberOfIterations = NumberOfIterations; }

  uint32_t
  GetNumberOfIterations() const { return this->m_NumberOfIterations; }
 

  void
  SetNumberOfSamplePatches(uint32_t NumberOfSamplePatches )
    { this->m_NumberOfSamplePatches = NumberOfSamplePatches; }

  uint32_t
  GetNumberOfSamplePatches() const { return this->m_NumberOfSamplePatches; }
 

  void
  SetSampleVariance(double SampleVariance )
    { this->m_SampleVariance = SampleVariance; }

  double
  GetSampleVariance() const { return this->m_SampleVariance; }
 
    typedef enum { NOMODEL, GAUSSIAN, RICIAN, POISSON } NoiseModelType;

  void
  SetNoiseModel(NoiseModelType NoiseModel )
    { this->m_NoiseModel = NoiseModel; }

  NoiseModelType
  GetNoiseModel() const { return this->m_NoiseModel; }
 

  void
  SetNoiseSigma(double NoiseSigma )
    { this->m_NoiseSigma = NoiseSigma; }

  double
  GetNoiseSigma() const { return this->m_NoiseSigma; }
 

  void
  SetNoiseModelFidelityWeight(double NoiseModelFidelityWeight )
    { this->m_NoiseModelFidelityWeight = NoiseModelFidelityWeight; }

  double
  GetNoiseModelFidelityWeight() const { return this->m_NoiseModelFidelityWeight; }
 

  void
  SetAlwaysTreatComponentsAsEuclidean(bool AlwaysTreatComponentsAsEuclidean )
    { this->m_AlwaysTreatComponentsAsEuclidean = AlwaysTreatComponentsAsEuclidean; }

  void
  AlwaysTreatComponentsAsEuclideanOn() { return this->SetAlwaysTreatComponentsAsEuclidean(true); }
  void
  AlwaysTreatComponentsAsEuclideanOff() { return this->SetAlwaysTreatComponentsAsEuclidean(false); }
  bool
  GetAlwaysTreatComponentsAsEuclidean() const { return this->m_AlwaysTreatComponentsAsEuclidean; }
 

  void
  SetKernelBandwidthEstimation(bool KernelBandwidthEstimation )
    { this->m_KernelBandwidthEstimation = KernelBandwidthEstimation; }

  void
  KernelBandwidthEstimationOn() { return this->SetKernelBandwidthEstimation(true); }
  void
  KernelBandwidthEstimationOff() { return this->SetKernelBandwidthEstimation(false); }
  bool
  GetKernelBandwidthEstimation() const { return this->m_KernelBandwidthEstimation; }
 

  void
  SetKernelBandwidthMultiplicationFactor(double KernelBandwidthMultiplicationFactor )
    { this->m_KernelBandwidthMultiplicationFactor = KernelBandwidthMultiplicationFactor; }

  double
  GetKernelBandwidthMultiplicationFactor() const { return this->m_KernelBandwidthMultiplicationFactor; }
 

  void
  SetKernelBandwidthUpdateFrequency(uint32_t KernelBandwidthUpdateFrequency )
    { this->m_KernelBandwidthUpdateFrequency = KernelBandwidthUpdateFrequency; }

  uint32_t
  GetKernelBandwidthUpdateFrequency() const { return this->m_KernelBandwidthUpdateFrequency; }
 

  void
  SetKernelBandwidthFractionPixelsForEstimation(double KernelBandwidthFractionPixelsForEstimation )
    { this->m_KernelBandwidthFractionPixelsForEstimation = KernelBandwidthFractionPixelsForEstimation; }

  double
  GetKernelBandwidthFractionPixelsForEstimation() const { return this->m_KernelBandwidthFractionPixelsForEstimation; }
 

  std::string GetName() const { return std::string("PatchBasedDenoisingImageFilter"); }

  std::string ToString() const;
 

  Image Execute(const Image &image1);
 
 
private:
  using MemberFunctionType = Image (Self::*)(const Image &image1);
  template <class TImageType> Image ExecuteInternal(const Image &image1);
    friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
  /* KernelBandwidthSigma */
    double m_KernelBandwidthSigma{ 400.0 };
 
    uint32_t m_PatchRadius{ 4u };
 
  /* Number of iterations to run */
    uint32_t m_NumberOfIterations{ 1u };
 
    uint32_t m_NumberOfSamplePatches{ 200u };
 
    double m_SampleVariance{ 400.0 };
 
    NoiseModelType m_NoiseModel{ itk::simple::PatchBasedDenoisingImageFilter::NOMODEL };
 
    double m_NoiseSigma{ 0.0 };
 
    double m_NoiseModelFidelityWeight{ 0.0 };
 
    bool m_AlwaysTreatComponentsAsEuclidean{ false };
 
    bool m_KernelBandwidthEstimation{ false };
 
    double m_KernelBandwidthMultiplicationFactor{ 1.0 };
 
    uint32_t m_KernelBandwidthUpdateFrequency{ 3u };
 
    double m_KernelBandwidthFractionPixelsForEstimation{ 0.2 };
 
 
 
 
 
 
 
};
 
 
}
#endif