SimpleITK  1.0.1
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

typedef BasicPixelIDTypeList PixelIDTypeList
typedef SaltAndPepperNoiseImageFilter 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 probability, uint32_t seed)
std::string GetName () const
double GetProbability () const
uint32_t GetSeed () const
 SaltAndPepperNoiseImageFilter ()
SelfSetProbability (double Probability)
SelfSetSeed (uint32_t Seed)
std::string ToString () const
 ~SaltAndPepperNoiseImageFilter ()
- 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
double m_Probability
uint32_t m_Seed


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

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

Gaetan Lehmann

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

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

Definition at line 47 of file sitkSaltAndPepperNoiseImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 97 of file sitkSaltAndPepperNoiseImageFilter.h.

Define the pixels types supported by this filter

Definition at line 59 of file sitkSaltAndPepperNoiseImageFilter.h.

Definition at line 49 of file sitkSaltAndPepperNoiseImageFilter.h.

Constructor & Destructor Documentation

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

Default Constructor that takes no arguments and initializes default parameters

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


Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::SaltAndPepperNoiseImageFilter::Execute ( const Image image1,
double  probability,
uint32_t  seed 

Execute the filter on the input image with the given parameters

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

Dispatched methods which calls ExecuteInteral on each component

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 79 of file sitkSaltAndPepperNoiseImageFilter.h.

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

Definition at line 69 of file sitkSaltAndPepperNoiseImageFilter.h.

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

Definition at line 77 of file sitkSaltAndPepperNoiseImageFilter.h.

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

Definition at line 65 of file sitkSaltAndPepperNoiseImageFilter.h.

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

Definition at line 73 of file sitkSaltAndPepperNoiseImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 104 of file sitkSaltAndPepperNoiseImageFilter.h.

Definition at line 103 of file sitkSaltAndPepperNoiseImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::SaltAndPepperNoiseImageFilter::m_MemberFactory

Definition at line 105 of file sitkSaltAndPepperNoiseImageFilter.h.

double itk::simple::SaltAndPepperNoiseImageFilter::m_Probability

Definition at line 108 of file sitkSaltAndPepperNoiseImageFilter.h.

uint32_t itk::simple::SaltAndPepperNoiseImageFilter::m_Seed

Definition at line 109 of file sitkSaltAndPepperNoiseImageFilter.h.

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