ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage > Class Template Referenceabstract

#include <itkPatchBasedDenoisingBaseImageFilter.h>

+ Inheritance diagram for itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >:

Public Types

using BoundaryConditionType = ZeroFluxNeumannBoundaryCondition< OutputImageType >
 
using ComponentSpaceEnum = PatchBasedDenoisingBaseImageFilterEnums::ComponentSpace
 
using ConstPointer = SmartPointer< const Self >
 
using FilterStateEnum = PatchBasedDenoisingBaseImageFilterEnums::FilterState
 
using InputImagePatchIterator = ConstNeighborhoodIterator< InputImageType, BoundaryConditionType >
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using ListAdaptorType = typename ::itk::Statistics::ImageToNeighborhoodSampleAdaptor< OutputImageType, BoundaryConditionType >
 
using NoiseModelEnum = PatchBasedDenoisingBaseImageFilterEnums::NoiseModel
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename OutputImageType::PixelType
 
using PatchRadiusType = typename ListAdaptorType::NeighborhoodRadiusType
 
using PatchWeightsType = Array< float >
 
using PixelType = OutputPixelType
 
using PixelValueType = typename NumericTraits< PixelType >::ValueType
 
using Pointer = SmartPointer< Self >
 
using Self = PatchBasedDenoisingBaseImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static constexpr unsigned int ImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
const InputImageTypem_InputImage
 
OutputImageTypem_OutputImage
 
unsigned int m_PatchRadius { 4 }
 
PatchWeightsType m_PatchWeights
 
bool m_KernelBandwidthEstimation { false }
 
unsigned int m_KernelBandwidthUpdateFrequency { 3 }
 
unsigned int m_NumberOfIterations { 1 }
 
unsigned int m_ElapsedIterations { 0 }
 
NoiseModelEnum m_NoiseModel { NoiseModelEnum::NOMODEL }
 
double m_SmoothingWeight { 1.0 }
 
double m_NoiseModelFidelityWeight { 0.0 }
 
bool m_AlwaysTreatComponentsAsEuclidean { false }
 
ComponentSpaceEnum m_ComponentSpace { ComponentSpaceEnum::EUCLIDEAN }
 
bool m_ManualReinitialization { false }
 
FilterStateEnum m_State { FilterStateEnum::UNINITIALIZED }
 
virtual void SetPatchRadius (unsigned int _arg)
 
virtual unsigned int GetPatchRadius () const
 
PatchRadiusType GetPatchRadiusInVoxels () const
 
PatchRadiusType GetPatchDiameterInVoxels () const
 
PatchRadiusType::SizeValueType GetPatchLengthInVoxels () const
 
void SetPatchWeights (const PatchWeightsType &weights)
 
PatchWeightsType GetPatchWeights () const
 
virtual void SetNoiseModel (const NoiseModelEnum _arg)
 
virtual NoiseModelEnum GetNoiseModel () const
 
virtual void SetSmoothingWeight (double _arg)
 
virtual double GetSmoothingWeight () const
 
virtual void SetNoiseModelFidelityWeight (double _arg)
 
virtual double GetNoiseModelFidelityWeight () const
 
virtual void SetKernelBandwidthEstimation (bool _arg)
 
virtual void KernelBandwidthEstimationOn ()
 
virtual void KernelBandwidthEstimationOff ()
 
virtual bool GetKernelBandwidthEstimation () const
 
virtual void SetKernelBandwidthUpdateFrequency (unsigned int _arg)
 
virtual unsigned int GetKernelBandwidthUpdateFrequency () const
 
virtual void SetNumberOfIterations (unsigned int _arg)
 
virtual const unsigned int & GetNumberOfIterations () const
 
virtual const unsigned int & GetElapsedIterations () const
 
virtual void SetAlwaysTreatComponentsAsEuclidean (bool _arg)
 
virtual void AlwaysTreatComponentsAsEuclideanOn ()
 
virtual void AlwaysTreatComponentsAsEuclideanOff ()
 
virtual bool GetAlwaysTreatComponentsAsEuclidean () const
 
virtual void SetStateToInitialized ()
 
virtual void SetStateToUninitialized ()
 
virtual void SetState (const FilterStateEnum _arg)
 
virtual const FilterStateEnumGetState () const
 
virtual void SetManualReinitialization (bool _arg)
 
virtual const bool & GetManualReinitialization () const
 
virtual void ManualReinitializationOn ()
 
virtual void ManualReinitializationOff ()
 
 PatchBasedDenoisingBaseImageFilter ()
 
 ~PatchBasedDenoisingBaseImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateInputRequestedRegion () override
 
void GenerateData () override
 
virtual void CopyInputToOutput ()=0
 
virtual void InitializePatchWeights ()
 
virtual void Initialize ()
 
virtual void AllocateUpdateBuffer ()=0
 
virtual void PreProcessInput ()
 
virtual void InitializeIteration ()
 
virtual void ComputeKernelBandwidthUpdate ()=0
 
virtual void ComputeImageUpdate ()=0
 
virtual void ApplyUpdate ()=0
 
virtual void PostProcessOutput ()
 
virtual bool Halt ()
 
virtual bool ThreadedHalt (void *)
 
virtual void SetElapsedIterations (unsigned int _arg)
 
ComponentSpaceEnum DetermineComponentSpace (const RGBPixel< PixelValueType > &)
 
ComponentSpaceEnum DetermineComponentSpace (const RGBAPixel< PixelValueType > &)
 
ComponentSpaceEnum DetermineComponentSpace (const DiffusionTensor3D< PixelValueType > &)
 
template<typename PixelT >
ComponentSpaceEnum DetermineComponentSpace (const PixelT &)
 
virtual void SetComponentSpace (const ComponentSpaceEnum _arg)
 
virtual ComponentSpaceEnum GetComponentSpace () const
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >

Base class for patch-based denoising algorithms.

Implementation of a denoising filter that uses iterative non-local, or semi-local, weighted averaging of image patches for image denoising. The intensity at each pixel 'p' gets updated as a weighted average of intensities of a chosen subset of pixels from the image. The weights are derived using a kernel function on distances between (i) the patch around pixel p and (ii) the patches around the chosen subset of pixels in the image. This class of methods is motivated by texture-based image models and relies on nonparametric statistical modeling in the high-dimensional space of image patches. The choice of an appropriate kernel bandwidth parameter underlying nonparametric modeling can be important and may be estimated using cross-validation schemes.

Engineering issues underlying this class of methods include the choice of the patch size, the definition of a weighting mask on patches (e.g. to make patches more isotropic and less rectangular), the number of iterations over the image, the scheme for sampling patches from the image, and the weights balancing the regularization and data fidelity when the noise model is known.

This class of methods stems from the following two independent and simultaneous publications:

Suyash P. Awate, Ross T. Whitaker. Higher-Order Image Statistics for Unsupervised, Information-Theoretic, Adaptive, Image Filtering. IEEE Int. Conf. Computer Vision and Pattern Recognition (CVPR) 2005; (2):44-51.

Antoni Buades, Bartomeu Coll, Jean-Michel Morel. A Non-Local Algorithm for Image Denoising. IEEE Int. Conf. Computer Vision and Pattern Recognition (CVPR) 2005; (2):60-65.

While the former work considers the denoising algorithm as performing entropy reduction using nonparametric density estimation, the latter work treats it as nonparametric regression. Details underlying this class of methods appear in:

Suyash P. Awate, Ross T. Whitaker. Unsupervised, Information-Theoretic, Adaptive Image Filtering for Image Restoration. IEEE Transactions on Pattern Analysis and Machine Intelligence (TPAMI) 2006; 28(3):364-376.

Antoni Buades, Bartomeu Coll, Jean-Michel Morel. Nonlocal Image and Movie Denoising. International Journal of Computer Vision (IJCV) 2008; 76(2):123-139.

This class provides the base software framework for implementing patch-based denoising methods for multi-dimensional and multi-channel (i.e. vector-valued pixels) images. This framework is multithreaded on shared-memory architectures. Multithreading is incorporated in, both, intensity-updates and bandwidth-estimation stages by subdividing the image domain and associating each sub-domain to a single thread for processing.

To prevent oversmoothing, this class provides the framework for including a data-fidelity term based on the knowledge of the noise model. The intensity updates are then treated as the sum of (1) the weighted smoothing updates (weighted by SmoothingWeight) and (2) the weighted fidelity updates (weighted by NoiseModelFidelityWeight) that prevent large deviations of the denoised image from the noisy data.

See also
PatchBasedDenoisingImageFilter

Definition at line 145 of file itkPatchBasedDenoisingBaseImageFilter.h.

Member Typedef Documentation

◆ BoundaryConditionType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::BoundaryConditionType = ZeroFluxNeumannBoundaryCondition<OutputImageType>

This data structure type is used for efficiently accessing patch values from the image data structure.

Definition at line 202 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ ComponentSpaceEnum

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ComponentSpaceEnum = PatchBasedDenoisingBaseImageFilterEnums::ComponentSpace

Definition at line 175 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 154 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ FilterStateEnum

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::FilterStateEnum = PatchBasedDenoisingBaseImageFilterEnums::FilterState

Definition at line 176 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ InputImagePatchIterator

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::InputImagePatchIterator = ConstNeighborhoodIterator<InputImageType, BoundaryConditionType>

Definition at line 206 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Input and output image types.

Definition at line 160 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::InputPixelType = typename InputImageType::PixelType

Type definition for the input and output pixel types. Output pixel type will be used in computations.

Definition at line 169 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ ListAdaptorType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ListAdaptorType = typename ::itk::Statistics::ImageToNeighborhoodSampleAdaptor<OutputImageType, BoundaryConditionType>

Definition at line 204 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ NoiseModelEnum

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::NoiseModelEnum = PatchBasedDenoisingBaseImageFilterEnums::NoiseModel

Definition at line 174 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 161 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 170 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ PatchRadiusType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::PatchRadiusType = typename ListAdaptorType::NeighborhoodRadiusType

Definition at line 205 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ PatchWeightsType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::PatchWeightsType = Array<float>

This data structure type is used to store the weights (mask) for pixels in a patch in order to make the patch more isotropic and less rectangular.

Definition at line 197 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ PixelType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::PixelType = OutputPixelType

Definition at line 171 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ PixelValueType

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::PixelValueType = typename NumericTraits<PixelType>::ValueType

Definition at line 172 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 153 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::Self = PatchBasedDenoisingBaseImageFilter

Standard class type aliases.

Definition at line 151 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 152 of file itkPatchBasedDenoisingBaseImageFilter.h.

Constructor & Destructor Documentation

◆ PatchBasedDenoisingBaseImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::PatchBasedDenoisingBaseImageFilter ( )
protected

Parameters that define patch size and patch weights (mask).

◆ ~PatchBasedDenoisingBaseImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::~PatchBasedDenoisingBaseImageFilter ( )
overrideprotecteddefault

Parameters that define patch size and patch weights (mask).

Member Function Documentation

◆ AllocateUpdateBuffer()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::AllocateUpdateBuffer ( )
protectedpure virtual

Allocate memory for a temporary update container in the subclass.

Implemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ AlwaysTreatComponentsAsEuclideanOff()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::AlwaysTreatComponentsAsEuclideanOff ( )
virtual

Parameters that define patch size and patch weights (mask).

◆ AlwaysTreatComponentsAsEuclideanOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::AlwaysTreatComponentsAsEuclideanOn ( )
virtual

Parameters that define patch size and patch weights (mask).

◆ ApplyUpdate()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ApplyUpdate ( )
protectedpure virtual

Parameters that define patch size and patch weights (mask).

Implemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ ComputeImageUpdate()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ComputeImageUpdate ( )
protectedpure virtual

Perform one iteration of image denoising.

Implemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ ComputeKernelBandwidthUpdate()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ComputeKernelBandwidthUpdate ( )
protectedpure virtual

Automatically estimate kernel bandwidth from the image data.

Implemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ CopyInputToOutput()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::CopyInputToOutput ( )
protectedpure virtual

Parameters that define patch size and patch weights (mask).

Implemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ DetermineComponentSpace() [1/4]

template<typename TInputImage , typename TOutputImage >
ComponentSpaceEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::DetermineComponentSpace ( const DiffusionTensor3D< PixelValueType > &  )
inlineprotected

Parameters that define patch size and patch weights (mask).

Definition at line 402 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ DetermineComponentSpace() [2/4]

template<typename TInputImage , typename TOutputImage >
template<typename PixelT >
ComponentSpaceEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::DetermineComponentSpace ( const PixelT &  )
inlineprotected

Parameters that define patch size and patch weights (mask).

Definition at line 409 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ DetermineComponentSpace() [3/4]

template<typename TInputImage , typename TOutputImage >
ComponentSpaceEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::DetermineComponentSpace ( const RGBAPixel< PixelValueType > &  )
inlineprotected

Parameters that define patch size and patch weights (mask).

Definition at line 396 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ DetermineComponentSpace() [4/4]

template<typename TInputImage , typename TOutputImage >
ComponentSpaceEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::DetermineComponentSpace ( const RGBPixel< PixelValueType > &  )
inlineprotected

Determine the component space based on pixel type

Definition at line 390 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

Parameters that define patch size and patch weights (mask).

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >
void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

Parameters that define patch size and patch weights (mask).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ GetAlwaysTreatComponentsAsEuclidean()

template<typename TInputImage , typename TOutputImage >
virtual bool itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetAlwaysTreatComponentsAsEuclidean ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetComponentSpace()

template<typename TInputImage , typename TOutputImage >
virtual ComponentSpaceEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetComponentSpace ( ) const
protectedvirtual

Parameters that define patch size and patch weights (mask).

◆ GetElapsedIterations()

template<typename TInputImage , typename TOutputImage >
virtual const unsigned int& itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetElapsedIterations ( ) const
virtual

Get the number of elapsed iterations of the filter.

◆ GetKernelBandwidthEstimation()

template<typename TInputImage , typename TOutputImage >
virtual bool itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetKernelBandwidthEstimation ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetKernelBandwidthUpdateFrequency()

template<typename TInputImage , typename TOutputImage >
virtual unsigned int itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetKernelBandwidthUpdateFrequency ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetManualReinitialization()

template<typename TInputImage , typename TOutputImage >
virtual const bool& itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetManualReinitialization ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >
virtual const char* itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ GetNoiseModel()

template<typename TInputImage , typename TOutputImage >
virtual NoiseModelEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetNoiseModel ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetNoiseModelFidelityWeight()

template<typename TInputImage , typename TOutputImage >
virtual double itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetNoiseModelFidelityWeight ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetNumberOfIterations()

template<typename TInputImage , typename TOutputImage >
virtual const unsigned int& itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetNumberOfIterations ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetPatchDiameterInVoxels()

template<typename TInputImage , typename TOutputImage >
PatchRadiusType itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetPatchDiameterInVoxels ( ) const

Parameters that define patch size and patch weights (mask).

◆ GetPatchLengthInVoxels()

template<typename TInputImage , typename TOutputImage >
PatchRadiusType::SizeValueType itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetPatchLengthInVoxels ( ) const

Parameters that define patch size and patch weights (mask).

◆ GetPatchRadius()

template<typename TInputImage , typename TOutputImage >
virtual unsigned int itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetPatchRadius ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetPatchRadiusInVoxels()

template<typename TInputImage , typename TOutputImage >
PatchRadiusType itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetPatchRadiusInVoxels ( ) const

Parameters that define patch size and patch weights (mask).

◆ GetPatchWeights()

template<typename TInputImage , typename TOutputImage >
PatchWeightsType itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetPatchWeights ( ) const

Parameters that define patch size and patch weights (mask).

◆ GetSmoothingWeight()

template<typename TInputImage , typename TOutputImage >
virtual double itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetSmoothingWeight ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ GetState()

template<typename TInputImage , typename TOutputImage >
virtual const FilterStateEnum& itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::GetState ( ) const
virtual

Parameters that define patch size and patch weights (mask).

◆ Halt()

template<typename TInputImage , typename TOutputImage >
virtual bool itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::Halt ( )
protectedvirtual

Check and indicate whether to continue iterations or stop.

◆ Initialize()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::Initialize ( )
inlineprotectedvirtual

Parameters that define patch size and patch weights (mask).

Reimplemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

Definition at line 346 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ InitializeIteration()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::InitializeIteration ( )
inlineprotectedvirtual

Parameters that define patch size and patch weights (mask).

Reimplemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

Definition at line 358 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ InitializePatchWeights()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::InitializePatchWeights ( )
protectedvirtual

Allocate memory and initialize patch weights.

Reimplemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ KernelBandwidthEstimationOff()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::KernelBandwidthEstimationOff ( )
virtual

Parameters that define patch size and patch weights (mask).

◆ KernelBandwidthEstimationOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::KernelBandwidthEstimationOn ( )
virtual

Parameters that define patch size and patch weights (mask).

◆ ManualReinitializationOff()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ManualReinitializationOff ( )
virtual

Parameters that define patch size and patch weights (mask).

◆ ManualReinitializationOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ManualReinitializationOn ( )
virtual

Parameters that define patch size and patch weights (mask).

◆ PostProcessOutput()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::PostProcessOutput ( )
inlineprotectedvirtual

Parameters that define patch size and patch weights (mask).

Reimplemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

Definition at line 373 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ PreProcessInput()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::PreProcessInput ( )
inlineprotectedvirtual

Parameters that define patch size and patch weights (mask).

Definition at line 354 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >
void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Parameters that define patch size and patch weights (mask).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >.

◆ SetAlwaysTreatComponentsAsEuclidean()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetAlwaysTreatComponentsAsEuclidean ( bool  _arg)
virtual

Set/Get flag indicating whether all components should always be treated as if they are in euclidean space regardless of pixel type. Defaults to false.

◆ SetComponentSpace()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetComponentSpace ( const ComponentSpaceEnum  _arg)
protectedvirtual

Set/Get the component space type.

◆ SetElapsedIterations()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetElapsedIterations ( unsigned int  _arg)
protectedvirtual

Parameters that define patch size and patch weights (mask).

◆ SetKernelBandwidthEstimation()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetKernelBandwidthEstimation ( bool  _arg)
virtual

Set/Get flag indicating whether kernel-bandwidth should be estimated automatically from the image data. Defaults to false.

◆ SetKernelBandwidthUpdateFrequency()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetKernelBandwidthUpdateFrequency ( unsigned int  _arg)
virtual

Set/Get the update frequency for the kernel bandwidth estimation. An optimal bandwidth will be re-estimated based on the denoised image after every 'n' iterations. Must be a positive integer. Defaults to 3, i.e. bandwidth updated after every 3 denoising iteration.

◆ SetManualReinitialization()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetManualReinitialization ( bool  _arg)
virtual

Indicates whether the filter automatically resets to UNINITIALIZED state after completing, or whether filter must be manually reset. Require the filter to be manually reinitialized (by calling SetStateToUninitialized().

◆ SetNoiseModel()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetNoiseModel ( const NoiseModelEnum  _arg)
virtual

Set/Get the noise model type. Defaults to NOMODEL. To use the noise model during denoising, NoiseModelFidelityWeight must be positive.

◆ SetNoiseModelFidelityWeight()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetNoiseModelFidelityWeight ( double  _arg)
virtual

Set/Get the weight on the fidelity term (penalizes deviations from the noisy data). This option is used when a noise model is specified. This weight controls the balance between the smoothing and the closeness to the noisy data. Use a positive weight to prevent oversmoothing.

◆ SetNumberOfIterations()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetNumberOfIterations ( unsigned int  _arg)
virtual

Set/Get the number of denoising iterations to perform. Must be a positive integer. Defaults to 1.

◆ SetPatchRadius()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetPatchRadius ( unsigned int  _arg)
virtual

Set/Get the patch radius specified in physical coordinates. Patch radius is preferably set to an even number. Currently, only isotropic patches in physical space are allowed; patches can be anisotropic in voxel space.

◆ SetPatchWeights()

template<typename TInputImage , typename TOutputImage >
void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetPatchWeights ( const PatchWeightsType weights)

Set/Get the patch weights, or mask, that make the patch more isotropic (less rectangular). This function allows the user to set arbitrary patch weights by providing a 1-D array of weights.

◆ SetSmoothingWeight()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetSmoothingWeight ( double  _arg)
virtual

Set/Get the weight on the smoothing term. This option is used when a noise model is specified. This weight controls the balance between the smoothing and the closeness to the noisy data. Large stepsizes may cause instabilities.

◆ SetState()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetState ( const FilterStateEnum  _arg)
virtual

Set/Get the state of the filter.

◆ SetStateToInitialized()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetStateToInitialized ( )
virtual

Set the state of the filter to INITIALIZED.

◆ SetStateToUninitialized()

template<typename TInputImage , typename TOutputImage >
virtual void itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::SetStateToUninitialized ( )
virtual

Set the state of the filter to UNINITIALIZED.

◆ ThreadedHalt()

template<typename TInputImage , typename TOutputImage >
virtual bool itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ThreadedHalt ( void *  )
inlineprotectedvirtual

Parameters that define patch size and patch weights (mask).

Definition at line 381 of file itkPatchBasedDenoisingBaseImageFilter.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::ImageDimension = InputImageType::ImageDimension
staticconstexpr

Image dimension, assumed to be the same for input and output data.

Definition at line 164 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_AlwaysTreatComponentsAsEuclidean

template<typename TInputImage , typename TOutputImage >
bool itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_AlwaysTreatComponentsAsEuclidean { false }
private

Parameter indicating whether components should be treated as if they are in Euclidean space regardless of pixel type.

Definition at line 445 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_ComponentSpace

template<typename TInputImage , typename TOutputImage >
ComponentSpaceEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_ComponentSpace { ComponentSpaceEnum::EUCLIDEAN }
private

Parameters that define patch size and patch weights (mask).

Definition at line 446 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_ElapsedIterations

template<typename TInputImage , typename TOutputImage >
unsigned int itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_ElapsedIterations { 0 }
private

Parameters that define patch size and patch weights (mask).

Definition at line 436 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_InputImage

template<typename TInputImage , typename TOutputImage >
const InputImageType* itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_InputImage
protected

Parameters that define patch size and patch weights (mask).

Definition at line 416 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_KernelBandwidthEstimation

template<typename TInputImage , typename TOutputImage >
bool itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_KernelBandwidthEstimation { false }
private

Parameters that define the strategy for kernel-bandwidth estimation.

Definition at line 430 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_KernelBandwidthUpdateFrequency

template<typename TInputImage , typename TOutputImage >
unsigned int itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_KernelBandwidthUpdateFrequency { 3 }
private

Parameters that define patch size and patch weights (mask).

Definition at line 431 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_ManualReinitialization

template<typename TInputImage , typename TOutputImage >
bool itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_ManualReinitialization { false }
private

Parameters that define patch size and patch weights (mask).

Definition at line 448 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_NoiseModel

template<typename TInputImage , typename TOutputImage >
NoiseModelEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_NoiseModel { NoiseModelEnum::NOMODEL }
private

Parameters defining the usage of a specific noise model, if desired.

Definition at line 439 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_NoiseModelFidelityWeight

template<typename TInputImage , typename TOutputImage >
double itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_NoiseModelFidelityWeight { 0.0 }
private

Parameters that define patch size and patch weights (mask).

Definition at line 441 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_NumberOfIterations

template<typename TInputImage , typename TOutputImage >
unsigned int itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_NumberOfIterations { 1 }
private

Parameters that define the total number of denoising iterations to perform and those completed so far.

Definition at line 435 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_OutputImage

template<typename TInputImage , typename TOutputImage >
OutputImageType* itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_OutputImage
protected

Parameters that define patch size and patch weights (mask).

Definition at line 422 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_PatchRadius

template<typename TInputImage , typename TOutputImage >
unsigned int itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_PatchRadius { 4 }
private

Parameters that define patch size and patch weights (mask).

Definition at line 426 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_PatchWeights

template<typename TInputImage , typename TOutputImage >
PatchWeightsType itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_PatchWeights
private

Parameters that define patch size and patch weights (mask).

Definition at line 427 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_SmoothingWeight

template<typename TInputImage , typename TOutputImage >
double itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_SmoothingWeight { 1.0 }
private

Parameters that define patch size and patch weights (mask).

Definition at line 440 of file itkPatchBasedDenoisingBaseImageFilter.h.

◆ m_State

template<typename TInputImage , typename TOutputImage >
FilterStateEnum itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >::m_State { FilterStateEnum::UNINITIALIZED }
private

Parameters that define patch size and patch weights (mask).

Definition at line 450 of file itkPatchBasedDenoisingBaseImageFilter.h.


The documentation for this class was generated from the following file: