SimpleITK  1.3.0.dev466
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

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef SpeckleNoiseImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, double standardDeviation, uint32_t seed)
 
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< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

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

Private Attributes

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
uint32_t m_Seed
 
double m_StandardDeviation
 

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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) $
Author
Gaetan Lehmann

This code was contributed in the Insight Journal paper "Noise Simulation". https://hdl.handle.net/10380/3158

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

Definition at line 58 of file sitkSpeckleNoiseImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::SpeckleNoiseImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 109 of file sitkSpeckleNoiseImageFilter.h.

Define the pixels types supported by this filter

Definition at line 70 of file sitkSpeckleNoiseImageFilter.h.

Definition at line 60 of file sitkSpeckleNoiseImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::SpeckleNoiseImageFilter::Execute ( const Image image1,
double  standardDeviation,
uint32_t  seed 
)

Execute the filter on the input image with the given parameters

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

Dispatched methods which calls ExecuteInteral on each component

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 92 of file sitkSpeckleNoiseImageFilter.h.

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

Definition at line 90 of file sitkSpeckleNoiseImageFilter.h.

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

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

Definition at line 82 of file sitkSpeckleNoiseImageFilter.h.

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

Definition at line 86 of file sitkSpeckleNoiseImageFilter.h.

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

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

Definition at line 77 of file sitkSpeckleNoiseImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 115 of file sitkSpeckleNoiseImageFilter.h.

Definition at line 114 of file sitkSpeckleNoiseImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::SpeckleNoiseImageFilter::m_MemberFactory
private

Definition at line 116 of file sitkSpeckleNoiseImageFilter.h.

uint32_t itk::simple::SpeckleNoiseImageFilter::m_Seed
private

Definition at line 120 of file sitkSpeckleNoiseImageFilter.h.

double itk::simple::SpeckleNoiseImageFilter::m_StandardDeviation
private

Definition at line 119 of file sitkSpeckleNoiseImageFilter.h.


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