RTK  2.6.0
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
 
InputImagePixelType GetOutputMaximum ()
 
InputImagePixelType GetOutputMinimum ()
 
float GetStandardDeviation () const
 
virtual const char * GetNameOfClass () 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 (unsigned int idx)
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput ()
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static constexpr 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 DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
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 void SetDynamicMultiThreading (bool _arg)
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, 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 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 200 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ InputImagePixelType

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

Definition at line 202 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ InputImagePointer

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

Definition at line 199 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ InputImageRegionType

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

Definition at line 201 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ InputImageType

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

Some convenient type alias.

Definition at line 198 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ InputPixelType

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

Definition at line 203 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ NoiseFilterType

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

Definition at line 322 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ OutputImagePointer

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

Definition at line 195 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ OutputImageRegionType

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

Superclass type alias.

Definition at line 194 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< 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 232 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetOutputMaximum()

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

Get the maximum output value.

Definition at line 308 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ GetOutputMinimum()

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

Get the minimum output value.

Definition at line 288 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 254 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< 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 220 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ SetOutputMaximum()

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

Set the maximum output value.

Definition at line 295 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ SetOutputMinimum()

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

Set the minimum output value.

Definition at line 275 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 266 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 242 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 206 of file rtkAdditiveGaussianNoiseImageFilter.h.

◆ m_NoiseFilter

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

Definition at line 325 of file rtkAdditiveGaussianNoiseImageFilter.h.


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