SimpleITK  2.0.0rc2.post21
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::SaltAndPepperNoiseImageFilter Class Reference

Alter an image with fixed value impulse noise, often called salt and pepper noise. More...

#include <sitkSaltAndPepperNoiseImageFilter.h>

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

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = SaltAndPepperNoiseImageFilter
 
- 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
 
double GetProbability () const
 
uint32_t GetSeed () const
 
 SaltAndPepperNoiseImageFilter ()
 
SelfSetProbability (double Probability)
 
SelfSetSeed (uint32_t Seed)
 
std::string ToString () const
 
virtual ~SaltAndPepperNoiseImageFilter ()
 
- 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
 
double m_Probability {0.01}
 
uint32_t m_Seed {(uint32_t) itk::simple::sitkWallClock}
 

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 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 fixed value impulse noise, often called salt and pepper noise.

Salt (sensor saturation) and pepper (dead pixels) noise is a special kind of impulse noise where the value of the noise is either the maximum possible value in the image or its minimum. This is not necessarily the maximal/minimal possible intensity value based on the pixel type. For example, the native pixel type for CT is a signed 16 bit integer, but only 12 bits used, so we would like to set the salt and pepper values to match this smaller intensity range and not the range the pixel type represents. It can be modeled as:

\( I = \begin{cases} M, & \quad \text{if } U < p/2 \\ m, & \quad \text{if } U > 1 - p/2 \\ I_0, & \quad \text{if } p/2 \geq U \leq 1 - p/2 \end{cases} \)
where \( p \) is the probability of the noise event, \( U \) is a uniformly distributed random variable in the \( [0,1] \) range, \( M \) is the greatest possible pixel value, and \( m \) the smallest possible pixel value.

Pixel alteration occurs at a user defined probability. Salt and pepper pixels are equally distributed.

Author
Gaetan Lehmann

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

See also
itk::simple::SaltAndPepperNoise for the procedural interface
itk::SaltAndPepperNoiseImageFilter for the Doxygen on the original ITK class.

Definition at line 58 of file sitkSaltAndPepperNoiseImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 108 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 70 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ Self

Definition at line 60 of file sitkSaltAndPepperNoiseImageFilter.h.

Constructor & Destructor Documentation

◆ ~SaltAndPepperNoiseImageFilter()

virtual itk::simple::SaltAndPepperNoiseImageFilter::~SaltAndPepperNoiseImageFilter ( )
virtual

Destructor

◆ SaltAndPepperNoiseImageFilter()

itk::simple::SaltAndPepperNoiseImageFilter::SaltAndPepperNoiseImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ ExecuteInternalVectorImage()

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

Dispatched methods which calls ExecuteInteral on each component

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 92 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ GetProbability()

double itk::simple::SaltAndPepperNoiseImageFilter::GetProbability ( ) const
inline

Set/Get the probability of the salt and pepper noise event. Defaults to 0.01.

Definition at line 81 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ GetSeed()

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

Definition at line 89 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ SetProbability()

Self& itk::simple::SaltAndPepperNoiseImageFilter::SetProbability ( double  Probability)
inline

Set/Get the probability of the salt and pepper noise event. Defaults to 0.01.

Definition at line 76 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ SetSeed()

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

Definition at line 85 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

Definition at line 114 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 113 of file sitkSaltAndPepperNoiseImageFilter.h.

Member Data Documentation

◆ m_InPlace

bool itk::simple::SaltAndPepperNoiseImageFilter::m_InPlace {false}
private

Definition at line 123 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::SaltAndPepperNoiseImageFilter::m_MemberFactory
private

Definition at line 115 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ m_Probability

double itk::simple::SaltAndPepperNoiseImageFilter::m_Probability {0.01}
private

Definition at line 118 of file sitkSaltAndPepperNoiseImageFilter.h.

◆ m_Seed

uint32_t itk::simple::SaltAndPepperNoiseImageFilter::m_Seed {(uint32_t) itk::simple::sitkWallClock}
private

Definition at line 120 of file sitkSaltAndPepperNoiseImageFilter.h.


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