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

#include <sitkAdditiveGaussianNoiseImageFilter.h>

Inheritance diagram for itk::simple::AdditiveGaussianNoiseImageFilter:

Collaboration diagram for itk::simple::AdditiveGaussianNoiseImageFilter:

Detailed Description

Alter an image with additive Gaussian white noise.

Additive Gaussian white noise can be modeled as:

: \( I = I_0 + N \)

: where \( I \) is the observed image, \( I_0 \) is the noise-free image and \( N \) is a normally distributed random variable of mean \( \mu \) and variance \( \sigma^2 \) :

: \( N \sim \mathcal{N}(\mu, \sigma^2) \)

The noise is independent of the pixel intensities.

Author: Gaetan Lehmann

This code was contributed in the Insight Journal paper "Noise Simulation". https://doi.org/10.54294/vh6vbw

See also: itk::simple::AdditiveGaussianNoise for the procedural interface; itk::AdditiveGaussianNoiseImageFilter for the Doxygen on the original ITK class.

Definition at line 64 of file sitkAdditiveGaussianNoiseImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = AdditiveGaussianNoiseImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	AdditiveGaussianNoiseImageFilter ()

Image	Execute (const Image &image1)

Image	Execute (Image &&image1)

double	GetMean () const

std::string	GetName () const

uint32_t	GetSeed () const

double	GetStandardDeviation () const

void	SetMean (double Mean)

void	SetSeed (uint32_t Seed)

void	SetStandardDeviation (double StandardDeviation)

std::string	ToString () const

virtual	~AdditiveGaussianNoiseImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

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

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.

virtual float	GetProgress () const
	An Active Measurement of the progress of execution.

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands.

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

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

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

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

template<class TImageType>
Image	ExecuteInternalVectorImage (const Image &image)

Static Private Member Functions
static const detail::MemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
bool	m_InPlace {false}

double	m_Mean { 0.0 }

uint32_t	m_Seed { (uint32_t) itk::simple::sitkWallClock }

double	m_StandardDeviation { 1.0 }

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 double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

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

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
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 TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType>
static Image	CastITKToImage (TImageType *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)

Member Typedef Documentation

◆ MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 134 of file sitkAdditiveGaussianNoiseImageFilter.h.

◆ PixelIDTypeList

using itk::simple::AdditiveGaussianNoiseImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 76 of file sitkAdditiveGaussianNoiseImageFilter.h.

◆ Self

using itk::simple::AdditiveGaussianNoiseImageFilter::Self = AdditiveGaussianNoiseImageFilter

Definition at line 66 of file sitkAdditiveGaussianNoiseImageFilter.h.

Constructor & Destructor Documentation

◆ ~AdditiveGaussianNoiseImageFilter()

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

virtual

Destructor

◆ AdditiveGaussianNoiseImageFilter()

itk::simple::AdditiveGaussianNoiseImageFilter::AdditiveGaussianNoiseImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

Image itk::simple::AdditiveGaussianNoiseImageFilter::Execute ( Image && image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType>

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

private

◆ ExecuteInternalVectorImage()

template<class TImageType>

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

private

Dispatched methods which calls ExecuteInternal on each component

Referenced by detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >.

◆ GetMean()

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

inline

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

Definition at line 104 of file sitkAdditiveGaussianNoiseImageFilter.h.

References m_Mean.

◆ GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::AdditiveGaussianNoiseImageFilter::GetMemberFunctionFactory ( )

staticprivate

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 119 of file sitkAdditiveGaussianNoiseImageFilter.h.

◆ GetSeed()

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

inline

Definition at line 115 of file sitkAdditiveGaussianNoiseImageFilter.h.

References m_Seed.

◆ GetStandardDeviation()

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

inline

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

Definition at line 91 of file sitkAdditiveGaussianNoiseImageFilter.h.

References m_StandardDeviation.

◆ SetMean()

void itk::simple::AdditiveGaussianNoiseImageFilter::SetMean ( double Mean )

inline

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

Definition at line 98 of file sitkAdditiveGaussianNoiseImageFilter.h.

References m_Mean, and itk::simple::Mean().

◆ SetSeed()

void itk::simple::AdditiveGaussianNoiseImageFilter::SetSeed ( uint32_t Seed )

inline

Definition at line 110 of file sitkAdditiveGaussianNoiseImageFilter.h.

References m_Seed.

◆ SetStandardDeviation()

void itk::simple::AdditiveGaussianNoiseImageFilter::SetStandardDeviation ( double StandardDeviation )

inline

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

Definition at line 85 of file sitkAdditiveGaussianNoiseImageFilter.h.

References m_StandardDeviation.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

◆ detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

friend struct detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

friend

Definition at line 137 of file sitkAdditiveGaussianNoiseImageFilter.h.

References ExecuteInternalVectorImage().

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 137 of file sitkAdditiveGaussianNoiseImageFilter.h.

Member Data Documentation

◆ m_InPlace

bool itk::simple::AdditiveGaussianNoiseImageFilter::m_InPlace {false}

private

Definition at line 155 of file sitkAdditiveGaussianNoiseImageFilter.h.

◆ m_Mean

double itk::simple::AdditiveGaussianNoiseImageFilter::m_Mean { 0.0 }

private

Definition at line 145 of file sitkAdditiveGaussianNoiseImageFilter.h.

Referenced by GetMean(), and SetMean().

◆ m_Seed

uint32_t itk::simple::AdditiveGaussianNoiseImageFilter::m_Seed { (uint32_t) itk::simple::sitkWallClock }

private

Definition at line 147 of file sitkAdditiveGaussianNoiseImageFilter.h.

Referenced by GetSeed(), and SetSeed().

◆ m_StandardDeviation

double itk::simple::AdditiveGaussianNoiseImageFilter::m_StandardDeviation { 1.0 }

private

Definition at line 143 of file sitkAdditiveGaussianNoiseImageFilter.h.

Referenced by GetStandardDeviation(), and SetStandardDeviation().

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

sitkAdditiveGaussianNoiseImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~AdditiveGaussianNoiseImageFilter()

◆ AdditiveGaussianNoiseImageFilter()

Member Function Documentation

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ ExecuteInternal()

◆ ExecuteInternalVectorImage()

◆ GetMean()

◆ GetMemberFunctionFactory()

◆ GetName()

◆ GetSeed()

◆ GetStandardDeviation()

◆ SetMean()

◆ SetSeed()

◆ SetStandardDeviation()

◆ ToString()

Friends And Related Symbol Documentation

◆ detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_InPlace

◆ m_Mean

◆ m_Seed

◆ m_StandardDeviation