SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::SpeckleNoiseImageFilter Class Reference

Alter an image with speckle (multiplicative) noise. More...

#include <sitkSpeckleNoiseImageFilter.h>

+ Inheritance diagram for itk::simple::SpeckleNoiseImageFilter:
+ Collaboration diagram for itk::simple::SpeckleNoiseImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
using Self = SpeckleNoiseImageFilter
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject

Public Member Functions

Image Execute (const Image &image1)
Image Execute (Image &&image1)
std::string GetName () const
uint32_t GetSeed () const
double GetStandardDeviation () const
SelfSetSeed (uint32_t Seed)
SelfSetStandardDeviation (double StandardDeviation)
 SpeckleNoiseImageFilter ()
std::string ToString () const
virtual ~SpeckleNoiseImageFilter ()
- 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. More...
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
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)

Private Attributes

bool m_InPlace {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
uint32_t m_Seed {(uint32_t) itk::simple::sitkWallClock}
double m_StandardDeviation {1.0}


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. 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...
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
- 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::ProcessObjectGetActiveProcess ()
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
NonCopyableoperator= (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<class TImageType >
static Image CastITKToImage (TImageType *img)
static const itk::EventObjectGetITKEventObject (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 speckle (multiplicative) noise.

The speckle noise follows a gamma distribution of mean 1 and standard deviation provided by the user. The noise is proportional to the pixel intensity.

It can be modeled as:

\( I = I_0 \ast G \)
where \( G \) is a is a gamma distributed random variable of mean 1 and variance proportional to the noise level:
\( G \sim \Gamma(\frac{1}{\sigma^2}, \sigma^2) \)
Gaetan Lehmann

This code was contributed in the Insight Journal paper "Noise Simulation".

See also
itk::simple::SpeckleNoise for the procedural interface
itk::SpeckleNoiseImageFilter for the Doxygen on the original ITK class.

Definition at line 62 of file sitkSpeckleNoiseImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 112 of file sitkSpeckleNoiseImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 74 of file sitkSpeckleNoiseImageFilter.h.

◆ Self

Definition at line 64 of file sitkSpeckleNoiseImageFilter.h.

Constructor & Destructor Documentation

◆ ~SpeckleNoiseImageFilter()

virtual itk::simple::SpeckleNoiseImageFilter::~SpeckleNoiseImageFilter ( )


◆ SpeckleNoiseImageFilter()

itk::simple::SpeckleNoiseImageFilter::SpeckleNoiseImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::SpeckleNoiseImageFilter::Execute ( const Image image1)

◆ Execute() [2/2]

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::SpeckleNoiseImageFilter::ExecuteInternal ( const Image image1)

◆ ExecuteInternalVectorImage()

template<class TImageType >
Image itk::simple::SpeckleNoiseImageFilter::ExecuteInternalVectorImage ( const Image image)

Dispatched methods which calls ExecuteInteral on each component

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 96 of file sitkSpeckleNoiseImageFilter.h.

◆ GetSeed()

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

Definition at line 93 of file sitkSpeckleNoiseImageFilter.h.

◆ GetStandardDeviation()

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

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

Definition at line 85 of file sitkSpeckleNoiseImageFilter.h.

◆ SetSeed()

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

Definition at line 89 of file sitkSpeckleNoiseImageFilter.h.

◆ SetStandardDeviation()

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

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

Definition at line 80 of file sitkSpeckleNoiseImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

Definition at line 118 of file sitkSpeckleNoiseImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 117 of file sitkSpeckleNoiseImageFilter.h.

Member Data Documentation

◆ m_InPlace

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

Definition at line 127 of file sitkSpeckleNoiseImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::SpeckleNoiseImageFilter::m_MemberFactory

Definition at line 119 of file sitkSpeckleNoiseImageFilter.h.

◆ m_Seed

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

Definition at line 124 of file sitkSpeckleNoiseImageFilter.h.

◆ m_StandardDeviation

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

Definition at line 122 of file sitkSpeckleNoiseImageFilter.h.

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