RTK  2.0.1
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
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 Types inherited from ImageSource< TInputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DataObjectIdentifierType DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef Superclass::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef typename OutputImageType::PixelType OutputImagePixelType
 
typedef typename OutputImageType::Pointer OutputImagePointer
 
typedef typename OutputImageType::RegionType OutputImageRegionType
 
typedef TInputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void GenerateData () override
 
float GetMean () const
 
virtual const char * GetNameOfClass () const
 
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)
 
- Public Member Functions inherited from ImageSource< TInputImage >
OutputImageTypeGetOutput ()
 
OutputImageTypeGetOutput (unsigned int idx)
 
const OutputImageTypeGetOutput () const
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from ImageSource< TInputImage >
static constexpr unsigned int OutputImageDimension
 

Protected Member Functions

 AdditiveGaussianNoiseImageFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from ImageSource< TInputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void DynamicMultiThreadingOff ()
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
 ImageSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
 ~ImageSource () override=default
 

Private Attributes

NoiseFilterType::Pointer m_NoiseFilter
 

Additional Inherited Members

- Static Protected Member Functions inherited from ImageSource< TInputImage >
static const ImageRegionSplitterBase * GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from ImageSource< TInputImage >
bool m_DynamicMultiThreading
 

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 157 of file rtkAdditiveGaussianNoiseImageFilter.h.

Member Typedef Documentation

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

Definition at line 167 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 182 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 184 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 181 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 183 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Some convenient type alias.

Definition at line 180 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 185 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 295 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 177 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Superclass type alias.

Definition at line 176 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 166 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Standard class type alias.

Definition at line 164 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Definition at line 165 of file rtkAdditiveGaussianNoiseImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage >
rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::AdditiveGaussianNoiseImageFilter ( )
protected

Member Function Documentation

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

Reimplemented from itk::Object.

template<class TInputImage >
void rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GenerateData ( )
overridevirtual

Reimplemented from itk::ImageSource< TOutputImage >.

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 212 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage >
InputImagePixelType rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GetOutputMaximum ( )
inline

Get the maximum output value.

Definition at line 281 of file rtkAdditiveGaussianNoiseImageFilter.h.

template<class TInputImage >
InputImagePixelType rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::GetOutputMinimum ( )
inline

Get the minimum output value.

Definition at line 263 of file rtkAdditiveGaussianNoiseImageFilter.h.

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 232 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Method for creation through the object factory

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

Reimplemented from itk::ImageSource< TOutputImage >.

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 201 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Set the maximum output value.

Definition at line 269 of file rtkAdditiveGaussianNoiseImageFilter.h.

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

Set the minimum output value.

Definition at line 251 of file rtkAdditiveGaussianNoiseImageFilter.h.

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 243 of file rtkAdditiveGaussianNoiseImageFilter.h.

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 221 of file rtkAdditiveGaussianNoiseImageFilter.h.

Member Data Documentation

template<class TInputImage >
const unsigned int rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

Definition at line 189 of file rtkAdditiveGaussianNoiseImageFilter.h.

template<class TInputImage >
NoiseFilterType::Pointer rtk::AdditiveGaussianNoiseImageFilter< TInputImage >::m_NoiseFilter
private

Definition at line 299 of file rtkAdditiveGaussianNoiseImageFilter.h.


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