rtk::AdditiveGaussianNoiseImageFilter< TInputImage > Class Template Reference

#include <rtkAdditiveGaussianNoiseImageFilter.h>

Inheritance diagram for rtk::AdditiveGaussianNoiseImageFilter< TInputImage >:

Collaboration diagram for rtk::AdditiveGaussianNoiseImageFilter< TInputImage >:

Public Types
using	ConstPointer = itk::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	InputPixelType = typename InputImageType::PixelType
using	NoiseFilterType = itk::UnaryFunctorImageFilter< InputImageType, InputImageType, NormalVariateNoiseFunctor< typename InputImageType::PixelType > >
using	OutputImagePointer = typename Superclass::OutputImagePointer
using	OutputImageRegionType = typename Superclass::OutputImageRegionType
using	Pointer = itk::SmartPointer< Self >
using	Self = AdditiveGaussianNoiseImageFilter
using	Superclass = itk::ImageToImageFilter< TInputImage, TInputImage >

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
void	GenerateData () override
float	GetMean () const
const char *	GetNameOfClass () const override
InputImagePixelType	GetOutputMaximum ()
InputImagePixelType	GetOutputMinimum ()
float	GetStandardDeviation () const
void	SetMean (float mean)
void	SetStandardDeviation (float stddev)
void	SetSeed (unsigned long seed)
void	SetOutputMinimum (InputImagePixelType min)
void	SetOutputMaximum (InputImagePixelType max)

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

Protected Member Functions
	AdditiveGaussianNoiseImageFilter ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Private Attributes
NoiseFilterType::Pointer	m_NoiseFilter

Detailed Description

template<class TInputImage>
class rtk::AdditiveGaussianNoiseImageFilter< TInputImage >

Adds Gaussian noise to the input image.

Adds noise to the input image according to a Gaussian normal variate distribution. The user supplies the mean \(\bar{x}\) and standard deviation \(\sigma\), such that the output is given by:

\[ v_{out} = v_{in} + \bar{x} + \sigma * G(d) \]

where G() is the Gaussian generator and d is the seed. A particular seed can be specified in order to perform repeatable tests.

Test:

rtkrampfiltertest.cxx

Author

Gavin Baker: gavinb at cs_mu_oz_au

Definition at line 171 of file rtkAdditiveGaussianNoiseImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 180 of file rtkAdditiveGaussianNoiseImageFilter.h.

InputImageConstPointer

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 195 of file rtkAdditiveGaussianNoiseImageFilter.h.

InputImagePixelType

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 197 of file rtkAdditiveGaussianNoiseImageFilter.h.

InputImagePointer

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 194 of file rtkAdditiveGaussianNoiseImageFilter.h.

InputImageRegionType

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 196 of file rtkAdditiveGaussianNoiseImageFilter.h.

InputImageType

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 193 of file rtkAdditiveGaussianNoiseImageFilter.h.

InputPixelType

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::InputPixelType = typename InputImageType::PixelType

Definition at line 198 of file rtkAdditiveGaussianNoiseImageFilter.h.

NoiseFilterType

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::NoiseFilterType = itk::UnaryFunctorImageFilter<InputImageType, InputImageType, NormalVariateNoiseFunctor<typename InputImageType::PixelType> >

Definition at line 317 of file rtkAdditiveGaussianNoiseImageFilter.h.

OutputImagePointer

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::OutputImagePointer = typename Superclass::OutputImagePointer

Definition at line 190 of file rtkAdditiveGaussianNoiseImageFilter.h.

OutputImageRegionType

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::OutputImageRegionType = typename Superclass::OutputImageRegionType

Superclass type alias.

Definition at line 189 of file rtkAdditiveGaussianNoiseImageFilter.h.

Pointer

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 179 of file rtkAdditiveGaussianNoiseImageFilter.h.

Self

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::Self = AdditiveGaussianNoiseImageFilter

Standard class type alias.

Definition at line 177 of file rtkAdditiveGaussianNoiseImageFilter.h.

Superclass

template<class TInputImage >

using rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::Superclass = itk::ImageToImageFilter<TInputImage, TInputImage>

Definition at line 178 of file rtkAdditiveGaussianNoiseImageFilter.h.

Constructor & Destructor Documentation

AdditiveGaussianNoiseImageFilter()

template<class TInputImage >

rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::AdditiveGaussianNoiseImageFilter ( )

protected

Member Function Documentation

CreateAnother()

template<class TInputImage >

virtual::itk::LightObject::Pointer rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::CreateAnother ( ) const

virtual

Reimplemented from itk::Object.

GenerateData()

template<class TInputImage >

void rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GenerateData ( )

overridevirtual

Reimplemented from itk::ImageSource< typename TOutputImage >.

GetMean()

template<class TInputImage >

float rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GetMean ( ) const

inline

Returns the average noise added to the image per pixel. The default is 0.

Definition at line 227 of file rtkAdditiveGaussianNoiseImageFilter.h.

GetNameOfClass()

template<class TInputImage >

const char* rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GetNameOfClass ( ) const

overridevirtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< typename TOutputImage >.

GetOutputMaximum()

template<class TInputImage >

InputImagePixelType rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GetOutputMaximum ( )

inline

Get the maximum output value.

Definition at line 303 of file rtkAdditiveGaussianNoiseImageFilter.h.

GetOutputMinimum()

template<class TInputImage >

InputImagePixelType rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GetOutputMinimum ( )

inline

Get the minimum output value.

Definition at line 283 of file rtkAdditiveGaussianNoiseImageFilter.h.

GetStandardDeviation()

template<class TInputImage >

float rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GetStandardDeviation ( ) const

inline

Returns the standard deviation of the noise added to the image. The default is 1.

Definition at line 249 of file rtkAdditiveGaussianNoiseImageFilter.h.

New()

template<class TInputImage >

static Pointer rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::New ( )

static

Method for creation through the object factory

PrintSelf()

template<class TInputImage >

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

overrideprotectedvirtual

Reimplemented from itk::ImageSource< typename TOutputImage >.

SetMean()

template<class TInputImage >

void rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::SetMean ( float  mean )

inline

Specifies the average noise added to the image per pixel. The default is 0.

Definition at line 215 of file rtkAdditiveGaussianNoiseImageFilter.h.

SetOutputMaximum()

template<class TInputImage >

void rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::SetOutputMaximum ( InputImagePixelType  max )

inline

Set the maximum output value.

Definition at line 290 of file rtkAdditiveGaussianNoiseImageFilter.h.

SetOutputMinimum()

template<class TInputImage >

void rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::SetOutputMinimum ( InputImagePixelType  min )

inline

Set the minimum output value.

Definition at line 270 of file rtkAdditiveGaussianNoiseImageFilter.h.

SetSeed()

template<class TInputImage >

void rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::SetSeed ( unsigned long  seed )

inline

Specifies the seed for the normal variate generator. The same seed will produce the same pseduo-random sequence, which can be used to reproduce results. For a higher dose of entropy, initialise with the current system time (in ms).

Definition at line 261 of file rtkAdditiveGaussianNoiseImageFilter.h.

SetStandardDeviation()

template<class TInputImage >

void rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::SetStandardDeviation ( float  stddev )

inline

Specifies the standard deviation of the noise added to the image. The default is 1.

Definition at line 237 of file rtkAdditiveGaussianNoiseImageFilter.h.

Member Data Documentation

InputImageDimension

template<class TInputImage >

constexpr unsigned int rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension

static

ImageDimension constants

Definition at line 201 of file rtkAdditiveGaussianNoiseImageFilter.h.

m_NoiseFilter

template<class TInputImage >

NoiseFilterType::Pointer rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::m_NoiseFilter

private

Definition at line 320 of file rtkAdditiveGaussianNoiseImageFilter.h.

---

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

• rtkAdditiveGaussianNoiseImageFilter.h