#include <itkPatchBasedDenoisingImageFilter.h>

Detailed Description

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

Derived class implementing a specific patch-based denoising algorithm, as detailed below.

This class is derived from the base class PatchBasedDenoisingBaseImageFilter; please refer to the documentation of the base class first. This class implements 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.

This class implements the denoising algorithm using a Gaussian kernel function for nonparametric density estimation. The class implements a scheme to automatically estimated the kernel bandwidth parameter (namely, sigma) using leave-one-out cross validation. It implements schemes for random sampling of patches non-locally (from the entire image) as well as semi-locally (from the spatial proximity of the pixel being denoised at the specific point in time). It implements a specific scheme for defining patch weights (mask) as described in Awate and Whitaker 2005 IEEE CVPR and 2006 IEEE TPAMI.

See also: PatchBasedDenoisingBaseImageFilter

Definition at line 62 of file itkPatchBasedDenoisingImageFilter.h.

Inheritance diagram for itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >:

Classes
struct	ThreadDataStruct

struct	ThreadFilterStruct

Public Types
using	BaseSamplerPointer = typename BaseSamplerType::Pointer

using	BaseSamplerType = itk::Statistics::RegionConstrainedSubsampler< PatchSampleType, InputImageRegionType >

using	ConstPointer = SmartPointer< const Self >

using	EigenValuesArrayType = FixedArray< PixelValueType, 3 >

using	EigenValuesCacheType = std::vector< EigenValuesArrayType >

using	EigenVectorsCacheType = std::vector< EigenVectorsMatrixType >

using	EigenVectorsMatrixType = Matrix< PixelValueType, 3, 3 >

using	InputImageRegionConstIteratorType = ImageRegionConstIterator< InputImageType >

using	InputImageRegionType = typename InputImageType::RegionType

using	InstanceIdentifier = typename BaseSamplerType::InstanceIdentifier

using	OutputImageRegionIteratorType = ImageRegionIterator< OutputImageType >

using	PatchSampleType = ListAdaptorType

using	PixelArrayType = Array< PixelValueType >

using	Pointer = SmartPointer< Self >

using	RealArrayType = Array< RealValueType >

using	RealType = typename NumericTraits< PixelType >::RealType

using	RealValueType = typename NumericTraits< PixelValueType >::RealType

using	Self = PatchBasedDenoisingImageFilter

using	ShortArrayType = Array< unsigned short >

using	Superclass = PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >
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	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
const char *	GetNameOfClass () const override

virtual RealType	GetNoiseSigma () const

virtual unsigned int	GetNumIndependentComponents () const

void	SetNoiseSigma (const RealType &sigma)


virtual void	SetUseSmoothDiscPatchWeights (bool _arg)

virtual void	UseSmoothDiscPatchWeightsOn ()

virtual bool	GetUseSmoothDiscPatchWeights () const


void	SetKernelBandwidthSigma (const RealArrayType &kernelSigma)

virtual RealArrayType	GetKernelBandwidthSigma () const


virtual void	SetKernelBandwidthFractionPixelsForEstimation (double _arg)

virtual const double &	GetKernelBandwidthFractionPixelsForEstimation () const


virtual void	SetComputeConditionalDerivatives (bool _arg)

virtual void	ComputeConditionalDerivativesOn ()

virtual bool	GetComputeConditionalDerivatives () const


virtual void	SetUseFastTensorComputations (bool _arg)

virtual void	UseFastTensorComputationsOn ()

virtual bool	GetUseFastTensorComputations () const


virtual void	SetKernelBandwidthMultiplicationFactor (double _arg)

virtual const double &	GetKernelBandwidthMultiplicationFactor () const


virtual void	SetSampler (BaseSamplerType *_arg)

virtual BaseSamplerType *	GetModifiableSampler ()

Public Member Functions inherited from itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >
virtual const unsigned int &	GetElapsedIterations () const

PatchRadiusType	GetPatchDiameterInVoxels () const

PatchRadiusType::SizeValueType	GetPatchLengthInVoxels () const

PatchRadiusType	GetPatchRadiusInVoxels () const

PatchWeightsType	GetPatchWeights () const

void	SetPatchWeights (const PatchWeightsType &weights)

virtual void	SetStateToInitialized ()

virtual void	SetStateToUninitialized ()

virtual void	SetPatchRadius (unsigned int _arg)

virtual unsigned int	GetPatchRadius () 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 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 void	SetAlwaysTreatComponentsAsEuclidean (bool _arg)

virtual void	AlwaysTreatComponentsAsEuclideanOn ()

virtual bool	GetAlwaysTreatComponentsAsEuclidean () const

virtual void	SetState (const FilterStateEnum _arg)

virtual const FilterStateEnum &	GetState () const

virtual void	SetManualReinitialization (bool _arg)

virtual const bool &	GetManualReinitialization () const

virtual void	ManualReinitializationOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

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 >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

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	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

static constexpr unsigned int	MaxSigmaUpdateIterations = 20

Static Public Attributes inherited from itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >
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

Protected Types
template<typename T , typename U = void>
using	DisableIfMultiComponent = typename std::enable_if< std::is_same_v< T, typename NumericTraits< T >::ValueType >, U >

template<typename T , typename U = void>
using	EnableIfMultiComponent = typename std::enable_if<!std::is_same_v< T, typename NumericTraits< T >::ValueType >, U >

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
template<typename RealT >
RealType	AddUpdate (const RealT &a, const RealType &b)

void	AllocateUpdateBuffer () override

void	ApplyUpdate () override

template<typename PixelT >
void	ComputeDifferenceAndWeightedSquaredNorm (const PixelT &a, const PixelT &b, const RealArrayType &weight, bool useCachedComputations, SizeValueType cacheIndex, EigenValuesCacheType &eigenValsCache, EigenVectorsCacheType &eigenVecsCache, RealType &diff, RealArrayType &norm)

virtual RealType	ComputeGradientJointEntropy (InstanceIdentifier id, typename ListAdaptorType::Pointer &inList, BaseSamplerPointer &sampler, ThreadDataStruct &threadData)

void	ComputeImageUpdate () override

void	ComputeKernelBandwidthUpdate () override

void	ComputeMinMax (const Image< DiffusionTensor3D< PixelValueType >, ImageDimension > *img)

template<typename TImageType >
DisableIfMultiComponent< typename TImageType::PixelType >::type	ComputeMinMax (const TImageType *img)

template<typename TImageType >
EnableIfMultiComponent< typename TImageType::PixelType >::type	ComputeMinMax (const TImageType *img)

void	CopyInputToOutput () override

virtual void	EmptyCaches ()

virtual void	EnforceConstraints ()

void	GenerateInputRequestedRegion () override

template<typename T >
EnableIfMultiComponent< T, typename NumericTraits< T >::ValueType >::type	GetComponent (const T &pix, unsigned int idx) const

template<typename T >
DisableIfMultiComponent< T, T >::type	GetComponent (const T pix, unsigned int) const

virtual ThreadDataStruct	GetThreadData (int threadId)

void	Initialize () override

void	InitializeIteration () override

virtual void	InitializeKernelSigma ()

void	InitializePatchWeights () override

virtual void	InitializePatchWeightsSmoothDisc ()

	PatchBasedDenoisingImageFilter ()

void	PostProcessOutput () override

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual RealArrayType	ResolveSigmaUpdate ()

template<typename T >
void	SetComponent (T &pix, unsigned int idx, typename EnableIfMultiComponent< T, RealValueType >::type val) const

template<typename T >
void	SetComponent (T &pix, unsigned int, typename DisableIfMultiComponent< T, RealValueType >::type val) const

virtual void	SetThreadData (int threadId, const ThreadDataStruct &data)

virtual void	ThreadedApplyUpdate (const InputImageRegionType &regionToProcess, const int)

virtual ThreadDataStruct	ThreadedComputeImageUpdate (const InputImageRegionType &regionToProcess, const int threadId, ThreadDataStruct threadData)

virtual ThreadDataStruct	ThreadedComputeSigmaUpdate (const InputImageRegionType &regionToProcess, const int, ThreadDataStruct threadData)

	~PatchBasedDenoisingImageFilter () override


void	ComputeDifferenceAndWeightedSquaredNorm (const DiffusionTensor3D< PixelValueType > &a, const DiffusionTensor3D< PixelValueType > &b, const RealArrayType &weight, bool useCachedComputations, SizeValueType cacheIndex, EigenValuesCacheType &eigenValsCache, EigenVectorsCacheType &eigenVecsCache, RealType &diff, RealArrayType &norm)


RealType	AddUpdate (const DiffusionTensor3D< RealValueType > &a, const RealType &b)

Protected Member Functions inherited from itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >
ComponentSpaceEnum	DetermineComponentSpace (const DiffusionTensor3D< PixelValueType > &)

template<typename PixelT >
ComponentSpaceEnum	DetermineComponentSpace (const PixelT &)

ComponentSpaceEnum	DetermineComponentSpace (const RGBAPixel< PixelValueType > &)

ComponentSpaceEnum	DetermineComponentSpace (const RGBPixel< PixelValueType > &)

void	GenerateData () override

virtual bool	Halt ()

	PatchBasedDenoisingBaseImageFilter ()

virtual void	PreProcessInput ()

virtual void	SetElapsedIterations (unsigned int _arg)

virtual bool	ThreadedHalt (void *)

	~PatchBasedDenoisingBaseImageFilter () override=default

virtual void	SetComponentSpace (const ComponentSpaceEnum _arg)

virtual ComponentSpaceEnum	GetComponentSpace () const

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

	ImageToImageFilter ()

void	VerifyInputInformation () ITKv5_CONST override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () ITKv5_CONST

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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 ()

Private Member Functions
RealType	AddEuclideanUpdate (const RealType &a, const RealType &b)

RealType	AddExponentialMapUpdate (const DiffusionTensor3D< RealValueType > &spdMatrix, const DiffusionTensor3D< RealValueType > &symMatrix)

template<typename TensorValueT >
void	Compute3x3EigenAnalysis (const DiffusionTensor3D< TensorValueT > &spdMatrix, FixedArray< TensorValueT, 3 > &eigenVals, Matrix< TensorValueT, 3, 3 > &eigenVecs)

void	ComputeLogMapAndWeightedSquaredGeodesicDifference (const DiffusionTensor3D< PixelValueType > &spdMatrixA, const DiffusionTensor3D< PixelValueType > &spdMatrixB, const RealArrayType &weight, bool useCachedComputations, SizeValueType cacheIndex, EigenValuesCacheType &eigenValsCache, EigenVectorsCacheType &eigenVecsCache, RealType &symMatrixLogMap, RealArrayType &geodesicDist)

void	ComputeSignedEuclideanDifferenceAndWeightedSquaredNorm (const PixelType &a, const PixelType &b, const RealArrayType &weight, bool useCachedComputations, SizeValueType cacheIndex, EigenValuesCacheType &eigenValsCache, EigenVectorsCacheType &eigenVecsCache, RealType &diff, RealArrayType &norm)

template<typename TInputImageType >
void	DispatchedArrayMinMax (const TInputImageType *img)

template<typename TInputImageType >
void	DispatchedMinMax (const TInputImageType *img)

template<typename TInputImageType >
void	DispatchedRiemannianMinMax (const TInputImageType *img)

template<typename TInputImageType >
void	DispatchedVectorMinMax (const TInputImageType *img)

virtual void	ResolveRiemannianMinMax ()

ThreadDataStruct	ThreadedRiemannianMinMax (const InputImageRegionType &regionToProcess, const int, const InputImageType *img, ThreadDataStruct threadData)

Static Private Member Functions
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ApplyUpdateThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ComputeImageUpdateThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ComputeSigmaUpdateThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	RiemannianMinMaxThreaderCallback (void *arg)

Private Attributes
bool	m_ComputeConditionalDerivatives { false }

PixelArrayType	m_ImageMax {}

PixelArrayType	m_ImageMin {}

RealArrayType	m_IntensityRescaleInvFactor {}

double	m_KernelBandwidthFractionPixelsForEstimation { 0.20 }

double	m_KernelBandwidthMultiplicationFactor { 1.0 }

RealArrayType	m_KernelBandwidthSigma {}

bool	m_KernelBandwidthSigmaIsSet { false }

double	m_MinProbability {}

double	m_MinSigma {}

RealType	m_NoiseSigma {}

bool	m_NoiseSigmaIsSet { false }

RealType	m_NoiseSigmaSquared {}

unsigned int	m_NumIndependentComponents { 0 }

unsigned int	m_NumPixelComponents { 0 }

BaseSamplerPointer	m_Sampler {}

ListAdaptorType::Pointer	m_SearchSpaceList {}

ShortArrayType	m_SigmaConverged {}

double	m_SigmaUpdateConvergenceTolerance { 0.01 }

unsigned int	m_SigmaUpdateDecimationFactor {}

std::vector< ThreadDataStruct >	m_ThreadData {}

unsigned int	m_TotalNumberPixels { 0 }

OutputImageType::Pointer	m_UpdateBuffer {}

bool	m_UseFastTensorComputations { true }

bool	m_UseSmoothDiscPatchWeights { true }

PixelType	m_ZeroPixel {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

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::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >
const InputImageType *	m_InputImage {}

OutputImageType *	m_OutputImage {}

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading {}

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ BaseSamplerPointer

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::BaseSamplerPointer = typename BaseSamplerType::Pointer

Definition at line 116 of file itkPatchBasedDenoisingImageFilter.h.

◆ BaseSamplerType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::BaseSamplerType = itk::Statistics::RegionConstrainedSubsampler<PatchSampleType, InputImageRegionType>

Type definitions for delegate classes.

Definition at line 115 of file itkPatchBasedDenoisingImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 73 of file itkPatchBasedDenoisingImageFilter.h.

◆ DisableIfMultiComponent

template<typename TInputImage , typename TOutputImage >

template<typename T , typename U = void>

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::DisableIfMultiComponent = typename std::enable_if<std::is_same_v<T, typename NumericTraits<T>::ValueType>, U>

protected

Definition at line 243 of file itkPatchBasedDenoisingImageFilter.h.

◆ EigenValuesArrayType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::EigenValuesArrayType = FixedArray<PixelValueType, 3>

Type definitions for Riemannian LogMap Eigensystem. Since the LogMap computations are only valid for DiffusionTensor3D pixels right now which always have a dimension of 3x3.

Definition at line 124 of file itkPatchBasedDenoisingImageFilter.h.

◆ EigenValuesCacheType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::EigenValuesCacheType = std::vector<EigenValuesArrayType>

Definition at line 126 of file itkPatchBasedDenoisingImageFilter.h.

◆ EigenVectorsCacheType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::EigenVectorsCacheType = std::vector<EigenVectorsMatrixType>

Definition at line 127 of file itkPatchBasedDenoisingImageFilter.h.

◆ EigenVectorsMatrixType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::EigenVectorsMatrixType = Matrix<PixelValueType, 3, 3>

Definition at line 125 of file itkPatchBasedDenoisingImageFilter.h.

◆ EnableIfMultiComponent

template<typename TInputImage , typename TOutputImage >

template<typename T , typename U = void>

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::EnableIfMultiComponent = typename std::enable_if<!std::is_same_v<T, typename NumericTraits<T>::ValueType>, U>

protected

Definition at line 246 of file itkPatchBasedDenoisingImageFilter.h.

◆ InputImageRegionConstIteratorType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::InputImageRegionConstIteratorType = ImageRegionConstIterator<InputImageType>

Definition at line 94 of file itkPatchBasedDenoisingImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Type definition for the input image region and size type.

Definition at line 90 of file itkPatchBasedDenoisingImageFilter.h.

◆ InstanceIdentifier

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::InstanceIdentifier = typename BaseSamplerType::InstanceIdentifier

Definition at line 117 of file itkPatchBasedDenoisingImageFilter.h.

◆ OutputImageRegionIteratorType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::OutputImageRegionIteratorType = ImageRegionIterator<OutputImageType>

Type definition for the input image region iterator

Definition at line 93 of file itkPatchBasedDenoisingImageFilter.h.

◆ PatchSampleType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::PatchSampleType = ListAdaptorType

Definition at line 111 of file itkPatchBasedDenoisingImageFilter.h.

◆ PixelArrayType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::PixelArrayType = Array<PixelValueType>

Definition at line 103 of file itkPatchBasedDenoisingImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 72 of file itkPatchBasedDenoisingImageFilter.h.

◆ RealArrayType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::RealArrayType = Array<RealValueType>

Definition at line 104 of file itkPatchBasedDenoisingImageFilter.h.

◆ RealType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::RealType = typename NumericTraits<PixelType>::RealType

Definition at line 101 of file itkPatchBasedDenoisingImageFilter.h.

◆ RealValueType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::RealValueType = typename NumericTraits<PixelValueType>::RealType

Definition at line 102 of file itkPatchBasedDenoisingImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::Self = PatchBasedDenoisingImageFilter

Standard class type aliases.

Definition at line 70 of file itkPatchBasedDenoisingImageFilter.h.

◆ ShortArrayType

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ShortArrayType = Array<unsigned short>

Definition at line 105 of file itkPatchBasedDenoisingImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::Superclass = PatchBasedDenoisingBaseImageFilter<TInputImage, TOutputImage>

Definition at line 71 of file itkPatchBasedDenoisingImageFilter.h.

Constructor & Destructor Documentation

◆ PatchBasedDenoisingImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::PatchBasedDenoisingImageFilter ( )

protected

◆ ~PatchBasedDenoisingImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::~PatchBasedDenoisingImageFilter ( )

overrideprotected

Member Function Documentation

◆ AddEuclideanUpdate()

template<typename TInputImage , typename TOutputImage >

RealType itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::AddEuclideanUpdate	(	const RealType &	a,
		const RealType &	b
	)

private

◆ AddExponentialMapUpdate()

template<typename TInputImage , typename TOutputImage >

RealType itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::AddExponentialMapUpdate	(	const DiffusionTensor3D< RealValueType > &	spdMatrix,
		const DiffusionTensor3D< RealValueType > &	symMatrix
	)

private

Returns the Exp map

◆ AddUpdate() [1/2]

template<typename TInputImage , typename TOutputImage >

RealType itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::AddUpdate	(	const DiffusionTensor3D< RealValueType > &	a,
		const RealType &	b
	)

inlineprotected

Update a by adding b. In Riemannian space, b is in the tangent space of a.

Definition at line 374 of file itkPatchBasedDenoisingImageFilter.h.

◆ AddUpdate() [2/2]

template<typename TInputImage , typename TOutputImage >

template<typename RealT >

RealType itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::AddUpdate	(	const RealT &	a,
		const RealType &	b
	)

inlineprotected

Definition at line 389 of file itkPatchBasedDenoisingImageFilter.h.

◆ AllocateUpdateBuffer()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::AllocateUpdateBuffer ( )

overrideprotectedvirtual

Allocate memory for a temporary update container in the subclass

Implements itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >.

◆ ApplyUpdate()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ApplyUpdate ( )

overrideprotectedvirtual

Implements itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >.

◆ ApplyUpdateThreaderCallback()

template<typename TInputImage , typename TOutputImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ApplyUpdateThreaderCallback ( void * arg )

staticprivate

This callback method uses ImageSource::SplitRequestedRegion to acquire a region which it then passes to ThreadedApplyUpdate for processing.

◆ Compute3x3EigenAnalysis()

template<typename TInputImage , typename TOutputImage >

template<typename TensorValueT >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::Compute3x3EigenAnalysis	(	const DiffusionTensor3D< TensorValueT > &	spdMatrix,
		FixedArray< TensorValueT, 3 > &	eigenVals,
		Matrix< TensorValueT, 3, 3 > &	eigenVecs
	)

private

◆ ComputeConditionalDerivativesOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeConditionalDerivativesOn ( )

virtual

Set/Get flag indicating whether conditional derivatives should be used estimating sigma.

◆ ComputeDifferenceAndWeightedSquaredNorm() [1/2]

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeDifferenceAndWeightedSquaredNorm	(	const DiffusionTensor3D< PixelValueType > &	a,
		const DiffusionTensor3D< PixelValueType > &	b,
		const RealArrayType &	weight,
		bool	useCachedComputations,
		SizeValueType	cacheIndex,
		EigenValuesCacheType &	eigenValsCache,
		EigenVectorsCacheType &	eigenVecsCache,
		RealType &	diff,
		RealArrayType &	norm
	)

inlineprotected

Compute the signed difference a-b and the weighted squared distance between a and b. Do the computation in either Euclidean or Riemannian space depending on pixel type. The cache is used when the first argument is repeatedly passed into ComputeLogMap since the eigen analysis will already have been computed for that pixel.

Definition at line 331 of file itkPatchBasedDenoisingImageFilter.h.

◆ ComputeDifferenceAndWeightedSquaredNorm() [2/2]

template<typename TInputImage , typename TOutputImage >

template<typename PixelT >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeDifferenceAndWeightedSquaredNorm	(	const PixelT &	a,
		const PixelT &	b,
		const RealArrayType &	weight,
		bool	useCachedComputations,
		SizeValueType	cacheIndex,
		EigenValuesCacheType &	eigenValsCache,
		EigenVectorsCacheType &	eigenVecsCache,
		RealType &	diff,
		RealArrayType &	norm
	)

inlineprotected

Definition at line 356 of file itkPatchBasedDenoisingImageFilter.h.

◆ ComputeGradientJointEntropy()

template<typename TInputImage , typename TOutputImage >

virtual RealType itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeGradientJointEntropy	(	InstanceIdentifier	id,
		typename ListAdaptorType::Pointer &	inList,
		BaseSamplerPointer &	sampler,
		ThreadDataStruct &	threadData
	)

protectedvirtual

◆ ComputeImageUpdate()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeImageUpdate ( )

overrideprotectedvirtual

Perform one iteration of image denoising.

Implements itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >.

◆ ComputeImageUpdateThreaderCallback()

template<typename TInputImage , typename TOutputImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeImageUpdateThreaderCallback ( void * arg )

staticprivate

This callback method uses ImageSource::SplitRequestedRegion to acquire a region which it then passes to ComputeImageUpdate for processing.

◆ ComputeKernelBandwidthUpdate()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeKernelBandwidthUpdate ( )

overrideprotectedvirtual

Automatically estimate kernel bandwidth from the image data.

Implements itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >.

◆ ComputeLogMapAndWeightedSquaredGeodesicDifference()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeLogMapAndWeightedSquaredGeodesicDifference	(	const DiffusionTensor3D< PixelValueType > &	spdMatrixA,
		const DiffusionTensor3D< PixelValueType > &	spdMatrixB,
		const RealArrayType &	weight,
		bool	useCachedComputations,
		SizeValueType	cacheIndex,
		EigenValuesCacheType &	eigenValsCache,
		EigenVectorsCacheType &	eigenVecsCache,
		RealType &	symMatrixLogMap,
		RealArrayType &	geodesicDist
	)

private

Returns the Log map in the tangent space of spdMatrixA.

◆ ComputeMinMax() [1/3]

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeMinMax ( const Image< DiffusionTensor3D< PixelValueType >, ImageDimension > * img )

inlineprotected

Compute the Minimum and Maximum pixel in the image for each independent component

Definition at line 296 of file itkPatchBasedDenoisingImageFilter.h.

◆ ComputeMinMax() [2/3]

template<typename TInputImage , typename TOutputImage >

template<typename TImageType >

DisableIfMultiComponent<typename TImageType::PixelType>::type itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeMinMax ( const TImageType * img )

inlineprotected

Definition at line 310 of file itkPatchBasedDenoisingImageFilter.h.

◆ ComputeMinMax() [3/3]

template<typename TInputImage , typename TOutputImage >

template<typename TImageType >

EnableIfMultiComponent<typename TImageType::PixelType>::type itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeMinMax ( const TImageType * img )

inlineprotected

Definition at line 317 of file itkPatchBasedDenoisingImageFilter.h.

◆ ComputeSigmaUpdateThreaderCallback()

template<typename TInputImage , typename TOutputImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeSigmaUpdateThreaderCallback ( void * arg )

staticprivate

This callback method uses ImageSource::SplitRequestedRegion to acquire an output region that it passes to ComputeSigma for processing.

◆ ComputeSignedEuclideanDifferenceAndWeightedSquaredNorm()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ComputeSignedEuclideanDifferenceAndWeightedSquaredNorm	(	const PixelType &	a,
		const PixelType &	b,
		const RealArrayType &	weight,
		bool	useCachedComputations,
		SizeValueType	cacheIndex,
		EigenValuesCacheType &	eigenValsCache,
		EigenVectorsCacheType &	eigenVecsCache,
		RealType &	diff,
		RealArrayType &	norm
	)

private

◆ CopyInputToOutput()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::CopyInputToOutput ( )

overrideprotectedvirtual

Implements itk::PatchBasedDenoisingBaseImageFilter< TInputImage, TOutputImage >.

◆ DispatchedArrayMinMax()

template<typename TInputImage , typename TOutputImage >

template<typename TInputImageType >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::DispatchedArrayMinMax ( const TInputImageType * img )

private

◆ DispatchedMinMax()

template<typename TInputImage , typename TOutputImage >

template<typename TInputImageType >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::DispatchedMinMax ( const TInputImageType * img )

private

◆ DispatchedRiemannianMinMax()

template<typename TInputImage , typename TOutputImage >

template<typename TInputImageType >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::DispatchedRiemannianMinMax ( const TInputImageType * img )

private

◆ DispatchedVectorMinMax()

template<typename TInputImage , typename TOutputImage >

template<typename TInputImageType >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::DispatchedVectorMinMax ( const TInputImageType * img )

private

◆ EmptyCaches()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::EmptyCaches ( )

protectedvirtual

Clean up Eigensystem caches

◆ EnforceConstraints()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::EnforceConstraints ( )

protectedvirtual

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

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

◆ GetComponent() [1/2]

template<typename TInputImage , typename TOutputImage >

template<typename T >

EnableIfMultiComponent<T, typename NumericTraits<T>::ValueType>::type itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetComponent	(	const T &	pix,
		unsigned int	idx
	)		const

inlineprotected

Definition at line 270 of file itkPatchBasedDenoisingImageFilter.h.

◆ GetComponent() [2/2]

template<typename TInputImage , typename TOutputImage >

template<typename T >

DisableIfMultiComponent<T, T>::type itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetComponent	(	const T	pix,
		unsigned int
	)		const

inlineprotected

A method to generically get a component.

The same function name can be used to generically access for scalars and array-like types. For scalar types the idx parameter is ignored.

Definition at line 257 of file itkPatchBasedDenoisingImageFilter.h.

◆ GetComputeConditionalDerivatives()

template<typename TInputImage , typename TOutputImage >

virtual bool itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetComputeConditionalDerivatives ( ) const

virtual

Set/Get flag indicating whether conditional derivatives should be used estimating sigma.

◆ GetKernelBandwidthFractionPixelsForEstimation()

template<typename TInputImage , typename TOutputImage >

virtual const double& itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetKernelBandwidthFractionPixelsForEstimation ( ) const

virtual

Set/Get the fraction of the image to use for kernel bandwidth sigma estimation. To reduce the computational burden for computing sigma, a small random fraction of the image pixels can be used.

◆ GetKernelBandwidthMultiplicationFactor()

template<typename TInputImage , typename TOutputImage >

virtual const double& itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetKernelBandwidthMultiplicationFactor ( ) const

virtual

Set/Get the kernel bandwidth sigma multiplication factor used to modify the automatically-estimated kernel bandwidth sigma. At times, it may be desirable to modify the value of the automatically-estimated sigma. Typically, this number isn't very far from 1. Note: This is used only when KernelBandwidthEstimation is True/On.

◆ GetKernelBandwidthSigma()

template<typename TInputImage , typename TOutputImage >

virtual RealArrayType itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetKernelBandwidthSigma ( ) const

virtual

Set/Get initial kernel bandwidth estimate. To prevent the class from automatically modifying this estimate, set KernelBandwidthEstimation to false in the base class.

◆ GetModifiableSampler()

template<typename TInputImage , typename TOutputImage >

virtual BaseSamplerType* itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetModifiableSampler ( )

virtual

Set/Get the class used for creating a subsample of patches.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

const char* itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetNoiseSigma()

template<typename TInputImage , typename TOutputImage >

virtual RealType itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetNoiseSigma ( ) const

virtual

◆ GetNumIndependentComponents()

template<typename TInputImage , typename TOutputImage >

virtual unsigned int itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetNumIndependentComponents ( ) const

virtual

Get the number of independent components of the input.

◆ GetThreadData()

template<typename TInputImage , typename TOutputImage >

virtual ThreadDataStruct itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetThreadData ( int threadId )

protectedvirtual

◆ GetUseFastTensorComputations()

template<typename TInputImage , typename TOutputImage >

virtual bool itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetUseFastTensorComputations ( ) const

virtual

Set/Get flag indicating whether the fast algorithm for tensor computations should be used.

 Specifically, when this flag is true (default) or On, a faster implementation of the 3x3
 symmetric positive-definite eigensystem analysis will be used. See
 Hasan KM, Basser PJ, Parker DL, Alexander AL.
 Analytical computation of the eigenvalues and eigenvectors in DT-MRI.
 J Magn Reson 2001; 152: 41-47.
 This faster algorithm may be slightly less accurate and possibly less stable in the presence
 of noise.  So far in practice it has been shown to work well.

 However, you may want to turn this option off if you have concerns about numerical
 performance.

◆ GetUseSmoothDiscPatchWeights()

template<typename TInputImage , typename TOutputImage >

virtual bool itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::GetUseSmoothDiscPatchWeights ( ) const

virtual

Set/Get flag indicating whether smooth-disc patch weights should be used. If this flag is true, the smooth-disc patch weights will override any weights provided via the SetPatchWeights method.

◆ Initialize()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::Initialize ( )

overrideprotectedvirtual

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

◆ InitializeIteration()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::InitializeIteration ( )

overrideprotectedvirtual

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

◆ InitializeKernelSigma()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::InitializeKernelSigma ( )

protectedvirtual

◆ InitializePatchWeights()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::InitializePatchWeights ( )

overrideprotectedvirtual

Allocate memory and initialize patch weights.

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

◆ InitializePatchWeightsSmoothDisc()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::InitializePatchWeightsSmoothDisc ( )

protectedvirtual

◆ New()

template<typename TInputImage , typename TOutputImage >

static Pointer itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PostProcessOutput()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::PostProcessOutput ( )

overrideprotectedvirtual

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

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

◆ ResolveRiemannianMinMax()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ResolveRiemannianMinMax ( )

privatevirtual

◆ ResolveSigmaUpdate()

template<typename TInputImage , typename TOutputImage >

virtual RealArrayType itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ResolveSigmaUpdate ( )

protectedvirtual

◆ RiemannianMinMaxThreaderCallback()

template<typename TInputImage , typename TOutputImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::RiemannianMinMaxThreaderCallback ( void * arg )

staticprivate

This callback method uses ImageSource::SplitRequestedRegion to acquire a region which it then passes to ThreadedRiemannianMinMax for processing.

◆ SetComponent() [1/2]

template<typename TInputImage , typename TOutputImage >

template<typename T >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetComponent	(	T &	pix,
		unsigned int	idx,
		typename EnableIfMultiComponent< T, RealValueType >::type	val
	)		const

inlineprotected

Definition at line 287 of file itkPatchBasedDenoisingImageFilter.h.

◆ SetComponent() [2/2]

template<typename TInputImage , typename TOutputImage >

template<typename T >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetComponent	(	T &	pix,
		unsigned int	,
		typename DisableIfMultiComponent< T, RealValueType >::type	val
	)		const

inlineprotected

A method to generically set a component.

Definition at line 278 of file itkPatchBasedDenoisingImageFilter.h.

◆ SetComputeConditionalDerivatives()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetComputeConditionalDerivatives ( bool _arg )

virtual

Set/Get flag indicating whether conditional derivatives should be used estimating sigma.

◆ SetKernelBandwidthFractionPixelsForEstimation()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetKernelBandwidthFractionPixelsForEstimation ( double _arg )

virtual

Set/Get the fraction of the image to use for kernel bandwidth sigma estimation. To reduce the computational burden for computing sigma, a small random fraction of the image pixels can be used.

◆ SetKernelBandwidthMultiplicationFactor()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetKernelBandwidthMultiplicationFactor ( double _arg )

virtual

Set/Get the kernel bandwidth sigma multiplication factor used to modify the automatically-estimated kernel bandwidth sigma. At times, it may be desirable to modify the value of the automatically-estimated sigma. Typically, this number isn't very far from 1. Note: This is used only when KernelBandwidthEstimation is True/On.

◆ SetKernelBandwidthSigma()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetKernelBandwidthSigma ( const RealArrayType & kernelSigma )

Set/Get initial kernel bandwidth estimate. To prevent the class from automatically modifying this estimate, set KernelBandwidthEstimation to false in the base class.

◆ SetNoiseSigma()

template<typename TInputImage , typename TOutputImage >

void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetNoiseSigma ( const RealType & sigma )

Set/Get the noise sigma. Used by the noise model where appropriate, defaults to 5% of the image intensity range

◆ SetSampler()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetSampler ( BaseSamplerType * _arg )

virtual

Set/Get the class used for creating a subsample of patches.

◆ SetThreadData()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetThreadData	(	int	threadId,
		const ThreadDataStruct &	data
	)

protectedvirtual

◆ SetUseFastTensorComputations()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetUseFastTensorComputations ( bool _arg )

virtual

Set/Get flag indicating whether the fast algorithm for tensor computations should be used.

 Specifically, when this flag is true (default) or On, a faster implementation of the 3x3
 symmetric positive-definite eigensystem analysis will be used. See
 Hasan KM, Basser PJ, Parker DL, Alexander AL.
 Analytical computation of the eigenvalues and eigenvectors in DT-MRI.
 J Magn Reson 2001; 152: 41-47.
 This faster algorithm may be slightly less accurate and possibly less stable in the presence
 of noise.  So far in practice it has been shown to work well.

 However, you may want to turn this option off if you have concerns about numerical
 performance.

◆ SetUseSmoothDiscPatchWeights()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::SetUseSmoothDiscPatchWeights ( bool _arg )

virtual

Set/Get flag indicating whether smooth-disc patch weights should be used. If this flag is true, the smooth-disc patch weights will override any weights provided via the SetPatchWeights method.

◆ ThreadedApplyUpdate()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ThreadedApplyUpdate	(	const InputImageRegionType &	regionToProcess,
		const int
	)

protectedvirtual

◆ ThreadedComputeImageUpdate()

template<typename TInputImage , typename TOutputImage >

virtual ThreadDataStruct itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ThreadedComputeImageUpdate	(	const InputImageRegionType &	regionToProcess,
		const int	threadId,
		ThreadDataStruct	threadData
	)

protectedvirtual

◆ ThreadedComputeSigmaUpdate()

template<typename TInputImage , typename TOutputImage >

virtual ThreadDataStruct itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ThreadedComputeSigmaUpdate	(	const InputImageRegionType &	regionToProcess,
		const int	,
		ThreadDataStruct	threadData
	)

protectedvirtual

◆ ThreadedRiemannianMinMax()

template<typename TInputImage , typename TOutputImage >

ThreadDataStruct itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::ThreadedRiemannianMinMax	(	const InputImageRegionType &	regionToProcess,
		const int	,
		const InputImageType *	img,
		ThreadDataStruct	threadData
	)

private

◆ UseFastTensorComputationsOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::UseFastTensorComputationsOn ( )

virtual

Set/Get flag indicating whether the fast algorithm for tensor computations should be used.

 Specifically, when this flag is true (default) or On, a faster implementation of the 3x3
 symmetric positive-definite eigensystem analysis will be used. See
 Hasan KM, Basser PJ, Parker DL, Alexander AL.
 Analytical computation of the eigenvalues and eigenvectors in DT-MRI.
 J Magn Reson 2001; 152: 41-47.
 This faster algorithm may be slightly less accurate and possibly less stable in the presence
 of noise.  So far in practice it has been shown to work well.

 However, you may want to turn this option off if you have concerns about numerical
 performance.

◆ UseSmoothDiscPatchWeightsOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::PatchBasedDenoisingImageFilter< TInputImage, TOutputImage >::UseSmoothDiscPatchWeightsOn ( )

virtual

Set/Get flag indicating whether smooth-disc patch weights should be used. If this flag is true, the smooth-disc patch weights will override any weights provided via the SetPatchWeights method.