itk::NonLocalMeansDenoisingFilter< TPixelType > Class Template Reference

This class denoises a vectorimage according to the non-local means procedure. More...

#include <itkNonLocalMeansDenoisingFilter.h>

Inheritance diagram for itk::NonLocalMeansDenoisingFilter< TPixelType >:

Collaboration diagram for itk::NonLocalMeansDenoisingFilter< TPixelType >:

Public Types
typedef NonLocalMeansDenoisingFilter	Self
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef ImageToImageFilter< VectorImage< TPixelType, 3 >, VectorImage< TPixelType, 3 > >	Superclass
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputImageType	OutputImageType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Image< TPixelType, 3 >	MaskImageType

Public Member Functions
Pointer	Clone () const
virtual const char *	GetClassName () const
virtual void	SetUseJointInformation (bool _arg)
	Set flag to use joint information. More...
virtual void	SetSearchRadius (int _arg)
	Set the searchradius. More...
virtual void	SetComparisonRadius (int _arg)
	Set the comparisonradius. More...
virtual void	SetVariance (double _arg)
	Set the variance of the noise. More...
virtual void	SetUseRicianAdaption (bool _arg)
	Set flag to use a rician adaption. More...
virtual unsigned int	GetCurrentVoxelCount ()
	Get the amount of calculated Voxels. More...
void	SetInputImage (const InputImageType *image)
	Set the input image. More...
void	SetInputMask (MaskImageType *mask)
	Set a denoising mask. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	NonLocalMeansDenoisingFilter ()
	~NonLocalMeansDenoisingFilter ()
void	BeforeThreadedGenerateData ()
	Calculations which need to be done before the denoising starts. More...
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType)
	Denoising procedure. More...

Detailed Description

template<class TPixelType>
class itk::NonLocalMeansDenoisingFilter< TPixelType >

This class denoises a vectorimage according to the non-local means procedure.

This Filter needs as an input a diffusion weigthed image, which will be denoised unsing the non-local means principle. An input mask is optional to denoise only inside the mask range. All other voxels will be set to 0.

Definition at line 33 of file itkNonLocalMeansDenoisingFilter.h.

Member Typedef Documentation

template<class TPixelType>

typedef SmartPointer<const Self> itk::NonLocalMeansDenoisingFilter< TPixelType >::ConstPointer

Definition at line 41 of file itkNonLocalMeansDenoisingFilter.h.

template<class TPixelType>

typedef Superclass::InputImageType itk::NonLocalMeansDenoisingFilter< TPixelType >::InputImageType

Definition at line 43 of file itkNonLocalMeansDenoisingFilter.h.

template<class TPixelType>

typedef Image<TPixelType, 3> itk::NonLocalMeansDenoisingFilter< TPixelType >::MaskImageType

Definition at line 46 of file itkNonLocalMeansDenoisingFilter.h.

template<class TPixelType>

typedef Superclass::OutputImageRegionType itk::NonLocalMeansDenoisingFilter< TPixelType >::OutputImageRegionType

Definition at line 45 of file itkNonLocalMeansDenoisingFilter.h.

template<class TPixelType>

typedef Superclass::OutputImageType itk::NonLocalMeansDenoisingFilter< TPixelType >::OutputImageType

Definition at line 44 of file itkNonLocalMeansDenoisingFilter.h.

template<class TPixelType>

typedef SmartPointer<Self> itk::NonLocalMeansDenoisingFilter< TPixelType >::Pointer

Definition at line 40 of file itkNonLocalMeansDenoisingFilter.h.

template<class TPixelType>

typedef NonLocalMeansDenoisingFilter itk::NonLocalMeansDenoisingFilter< TPixelType >::Self

Typedefs

Definition at line 39 of file itkNonLocalMeansDenoisingFilter.h.

template<class TPixelType>

typedef ImageToImageFilter< VectorImage < TPixelType, 3 >, VectorImage < TPixelType, 3 > > itk::NonLocalMeansDenoisingFilter< TPixelType >::Superclass

Definition at line 42 of file itkNonLocalMeansDenoisingFilter.h.

Constructor & Destructor Documentation

template<class TPixelType>

itk::NonLocalMeansDenoisingFilter< TPixelType >::NonLocalMeansDenoisingFilter ( )

protected

template<class TPixelType>

itk::NonLocalMeansDenoisingFilter< TPixelType >::~NonLocalMeansDenoisingFilter ( )

inlineprotected

Definition at line 107 of file itkNonLocalMeansDenoisingFilter.h.

Member Function Documentation

template<class TPixelType>

void itk::NonLocalMeansDenoisingFilter< TPixelType >::BeforeThreadedGenerateData ( )

protected

Calculations which need to be done before the denoising starts.

This method is called before the denoising starts. It calculates the ROI if a mask is used and sets the number of processed voxels to zero.

template<class TPixelType>

Pointer itk::NonLocalMeansDenoisingFilter< TPixelType >::Clone

(

)

const

template<class TPixelType>

virtual const char* itk::NonLocalMeansDenoisingFilter< TPixelType >::GetClassName ( ) const

virtual

Runtime information support.

template<class TPixelType>

virtual unsigned int itk::NonLocalMeansDenoisingFilter< TPixelType >::GetCurrentVoxelCount ( )

virtual

Get the amount of calculated Voxels.

Returns

the number of calculated Voxels until yet, useful for the use of a progressbars.

template<class TPixelType>

static Pointer itk::NonLocalMeansDenoisingFilter< TPixelType >::New ( )

static

Method for creation through the object factory.

Referenced by main().

template<class TPixelType>

virtual void itk::NonLocalMeansDenoisingFilter< TPixelType >::SetComparisonRadius ( int  _arg )

virtual

Set the comparisonradius.

The comparisonradius generates neighborhoods of size (2 * comparisonradius +1)³. Default is 1.

template<class TPixelType>

void itk::NonLocalMeansDenoisingFilter< TPixelType >::SetInputImage

(

const InputImageType *

image

)

Set the input image.

template<class TPixelType>

void itk::NonLocalMeansDenoisingFilter< TPixelType >::SetInputMask

(

MaskImageType *

mask

)

Set a denoising mask.

optional

Set a mask to denoise only the masked area, all voxel outside this area will be set to 0.

template<class TPixelType>

virtual void itk::NonLocalMeansDenoisingFilter< TPixelType >::SetSearchRadius ( int  _arg )

virtual

Set the searchradius.

The searchradius generates a neighborhood of size (2 * searchradius + 1)³. Default is 4.

template<class TPixelType>

virtual void itk::NonLocalMeansDenoisingFilter< TPixelType >::SetUseJointInformation ( bool  _arg )

virtual

Set flag to use joint information.

template<class TPixelType>

virtual void itk::NonLocalMeansDenoisingFilter< TPixelType >::SetUseRicianAdaption ( bool  _arg )

virtual

Set flag to use a rician adaption.

If this flag is true the filter uses a method which is optimized for Rician distributed noise.

template<class TPixelType>

virtual void itk::NonLocalMeansDenoisingFilter< TPixelType >::SetVariance ( double  _arg )

virtual

Set the variance of the noise.

The variance of the noise needs to be estimated to use this filter properly. Default is 1.

template<class TPixelType>

void itk::NonLocalMeansDenoisingFilter< TPixelType >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, ThreadIdType    )

protected

Denoising procedure.

This method calculates the denoised voxelvalue for each voxel in the image in multiple threads. If a mask is used, voxels outside the masked area will be set to 0.

Parameters

outputRegionForThread

Region to denoise for each thread.

---

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

• itkNonLocalMeansDenoisingFilter.h