itk::simple::AdditiveGaussianNoiseImageFilter Class Reference

Alter an image with additive Gaussian white noise. More...

#include <sitkAdditiveGaussianNoiseImageFilter.h>

Inheritance diagram for itk::simple::AdditiveGaussianNoiseImageFilter:

Collaboration diagram for itk::simple::AdditiveGaussianNoiseImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef AdditiveGaussianNoiseImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
	AdditiveGaussianNoiseImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, double standardDeviation, double mean, uint32_t seed)
double	GetMean () const
std::string	GetName () const
uint32_t	GetSeed () const
double	GetStandardDeviation () const
Self &	SetMean (double Mean)
Self &	SetSeed (uint32_t Seed)
Self &	SetStandardDeviation (double StandardDeviation)
std::string	ToString () const
virtual	~AdditiveGaussianNoiseImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...
virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands. More...
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)
template<class TImageType >
Image	ExecuteInternalVectorImage (const Image &image)

Private Attributes
double	m_Mean
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
uint32_t	m_Seed
double	m_StandardDeviation

Friends
struct	detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TImageType >
static Image	CastITKToImage (TImageType *img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Alter an image with additive Gaussian white noise.

Additive Gaussian white noise can be modeled as:

where is the observed image, is the noise-free image and is a normally distributed random variable of mean and variance :

The noise is independent of the pixel intensities.

Author

Gaetan Lehmann

This code was contributed in the Insight Journal paper "Noise Simulation". https://hdl.handle.net/10380/3158

See also

itk::simple::AdditiveGaussianNoise for the procedural interface

itk::AdditiveGaussianNoiseImageFilter for the Doxygen on the original ITK class.

Definition at line 58 of file sitkAdditiveGaussianNoiseImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::AdditiveGaussianNoiseImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 119 of file sitkAdditiveGaussianNoiseImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::AdditiveGaussianNoiseImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 70 of file sitkAdditiveGaussianNoiseImageFilter.h.

typedef AdditiveGaussianNoiseImageFilter itk::simple::AdditiveGaussianNoiseImageFilter::Self

Definition at line 60 of file sitkAdditiveGaussianNoiseImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::AdditiveGaussianNoiseImageFilter::~AdditiveGaussianNoiseImageFilter ( )

virtual

Destructor

itk::simple::AdditiveGaussianNoiseImageFilter::AdditiveGaussianNoiseImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::AdditiveGaussianNoiseImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::AdditiveGaussianNoiseImageFilter::Execute	(	const Image &	image1,
		double	standardDeviation,
		double	mean,
		uint32_t	seed
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::AdditiveGaussianNoiseImageFilter::ExecuteInternal ( const Image &  image1 )

private

template<class TImageType >

Image itk::simple::AdditiveGaussianNoiseImageFilter::ExecuteInternalVectorImage ( const Image &  image )

private

Dispatched methods which calls ExecuteInteral on each component

double itk::simple::AdditiveGaussianNoiseImageFilter::GetMean ( ) const

inline

Set/Get the mean of the Gaussian distribution. Defaults to 0.0.

Definition at line 92 of file sitkAdditiveGaussianNoiseImageFilter.h.

std::string itk::simple::AdditiveGaussianNoiseImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 102 of file sitkAdditiveGaussianNoiseImageFilter.h.

uint32_t itk::simple::AdditiveGaussianNoiseImageFilter::GetSeed ( ) const

inline

Definition at line 100 of file sitkAdditiveGaussianNoiseImageFilter.h.

double itk::simple::AdditiveGaussianNoiseImageFilter::GetStandardDeviation ( ) const

inline

Set/Get the standard deviation of the Gaussian distribution. Defaults to 1.0.

Definition at line 82 of file sitkAdditiveGaussianNoiseImageFilter.h.

Self& itk::simple::AdditiveGaussianNoiseImageFilter::SetMean ( double  Mean )

inline

Set/Get the mean of the Gaussian distribution. Defaults to 0.0.

Definition at line 87 of file sitkAdditiveGaussianNoiseImageFilter.h.

References itk::simple::Mean().

Self& itk::simple::AdditiveGaussianNoiseImageFilter::SetSeed ( uint32_t  Seed )

inline

Definition at line 96 of file sitkAdditiveGaussianNoiseImageFilter.h.

Self& itk::simple::AdditiveGaussianNoiseImageFilter::SetStandardDeviation ( double  StandardDeviation )

inline

Set/Get the standard deviation of the Gaussian distribution. Defaults to 1.0.

Definition at line 77 of file sitkAdditiveGaussianNoiseImageFilter.h.

std::string itk::simple::AdditiveGaussianNoiseImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

friend

Definition at line 125 of file sitkAdditiveGaussianNoiseImageFilter.h.

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 124 of file sitkAdditiveGaussianNoiseImageFilter.h.

Member Data Documentation

double itk::simple::AdditiveGaussianNoiseImageFilter::m_Mean

private

Definition at line 130 of file sitkAdditiveGaussianNoiseImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::AdditiveGaussianNoiseImageFilter::m_MemberFactory

private

Definition at line 126 of file sitkAdditiveGaussianNoiseImageFilter.h.

uint32_t itk::simple::AdditiveGaussianNoiseImageFilter::m_Seed

private

Definition at line 131 of file sitkAdditiveGaussianNoiseImageFilter.h.

double itk::simple::AdditiveGaussianNoiseImageFilter::m_StandardDeviation

private

Definition at line 129 of file sitkAdditiveGaussianNoiseImageFilter.h.

---

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

• sitkAdditiveGaussianNoiseImageFilter.h