ITK  6.0.0 Insight Toolkit
itk::ShotNoiseImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkShotNoiseImageFilter.h>

## Detailed Description

### template<class TInputImage, class TOutputImage = TInputImage> class itk::ShotNoiseImageFilter< TInputImage, TOutputImage >

Alter an image with shot noise.

The shot noise follows a Poisson distribution:

$$I = N(I_0)$$
where $$N(I_0)$$ is a Poisson-distributed random variable of mean $$I_0$$. The noise is thus dependent on the pixel intensities in the image.

The intensities in the image can be scaled by a user provided value to map pixel values to the actual number of particles. The scaling can be seen as the inverse of the gain used during the acquisition. The noisy signal is then scaled back to its input intensity range:

$$I = \frac{N(I_0 \times s)}{s}$$
where $$s$$ is the scale factor.

The Poisson-distributed variable $$\lambda$$ is computed by using the algorithm:

$$\begin{array}{l} k \leftarrow 0 \\ p \leftarrow 1 \\ \textbf{repeat} \\ \left\{ \begin{array}{l} k \leftarrow k+1 \\ p \leftarrow p \ast U() \end{array} \right. \\ \textbf{until } p > e^{\lambda} \\ \textbf{return} (k) \end{array}$$
where $$U()$$ provides a uniformly distributed random variable in the interval $$[0,1]$$.

This algorithm is very inefficient for large values of $$\lambda$$, though. Fortunately, the Poisson distribution can be accurately approximated by a Gaussian distribution of mean and variance $$\lambda$$ when $$\lambda$$ is large enough. In this implementation, this value is considered to be 50. This leads to the faster algorithm:

$$\lambda + \sqrt{\lambda} \times N()$$
where $$N()$$ is a normally distributed random variable of mean 0 and variance 1.

This code was contributed in the Insight Journal paper "Noise Simulation". https://doi.org/10.54294/vh6vbw

Definition at line 94 of file itkShotNoiseImageFilter.h.

Inheritance diagram for itk::ShotNoiseImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::ShotNoiseImageFilter< TInputImage, TOutputImage >:

## Public Types

using ConstPointer = 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 Pointer = SmartPointer< Self >

using Self = ShotNoiseImageFilter

using Superclass = NoiseBaseImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::NoiseBaseImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >

using Pointer = SmartPointer< Self >

using Self = NoiseBaseImageFilter

using Superclass = InPlaceImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
using ConstPointer = 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 Pointer = SmartPointer< Self >

using Self = InPlaceImageFilter

using Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = 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 Pointer = SmartPointer< Self >

using Self = ImageToImageFilter

using Superclass = ImageSource< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >

using DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using DataObjectPointer = DataObject::Pointer

using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using OutputImagePixelType = typename OutputImageType::PixelType

using OutputImagePointer = typename OutputImageType::Pointer

using OutputImageRegionType = typename OutputImageType::RegionType

using OutputImageType = TOutputImage

using Pointer = SmartPointer< Self >

using Self = ImageSource

using Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >

using DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using DataObjectPointer = DataObject::Pointer

using DataObjectPointerArray = std::vector< DataObjectPointer >

using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using NameArray = std::vector< DataObjectIdentifierType >

using Pointer = SmartPointer< Self >

using Self = ProcessObject

using Superclass = Object

Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >

using Pointer = SmartPointer< Self >

using Self = Object

using Superclass = LightObject

Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >

using Pointer = SmartPointer< Self >

using Self = LightObject

## Public Member Functions

const char * GetNameOfClass () const override

virtual double GetScale () const

virtual void SetScale (double _arg)

Public Member Functions inherited from itk::NoiseBaseImageFilter< TInputImage, TOutputImage >
virtual void SetSeed ()

virtual uint32_t GetSeed () const

virtual void SetSeed (uint32_t _arg)

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const

virtual void SetInPlace (bool _arg)

virtual bool GetInPlace () const

virtual void InPlaceOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const

const InputImageTypeGetInput (unsigned int idx) const

void PopBackInput () override

void PopFrontInput () override

virtual void PushBackInput (const InputImageType *input)

virtual void PushFrontInput (const InputImageType *input)

virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void SetInput (const InputImageType *input)

virtual void SetInput (unsigned int, const TInputImage *image)

virtual void SetCoordinateTolerance (double _arg)

virtual double GetCoordinateTolerance () const

virtual void SetDirectionTolerance (double _arg)

virtual double GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)

OutputImageTypeGetOutput ()

const OutputImageTypeGetOutput () const

virtual void GraftOutput (DataObject *graft)

virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()

virtual void EnlargeOutputRequestedRegion (DataObject *)

virtual const bool & GetAbortGenerateData () const

DataObjectPointerArray GetIndexedInputs ()

DataObjectPointerArray GetIndexedOutputs ()

NameArray GetInputNames () const

DataObjectPointerArray GetInputs ()

DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType GetNumberOfInputs () const

DataObjectPointerArraySizeType GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const

NameArray GetOutputNames () const

DataObjectPointerArray GetOutputs ()

virtual float GetProgress () const

NameArray GetRequiredInputNames () const

bool HasInput (const DataObjectIdentifierType &key) const

bool HasOutput (const DataObjectIdentifierType &key) const

void IncrementProgress (float increment)

virtual void PrepareOutputs ()

virtual void PropagateRequestedRegion (DataObject *output)

virtual void ResetPipeline ()

virtual void SetAbortGenerateData (bool _arg)

virtual void Update ()

virtual void UpdateLargestPossibleRegion ()

virtual void UpdateOutputData (DataObject *output)

virtual void UpdateOutputInformation ()

void UpdateProgress (float progress)

virtual void SetReleaseDataFlag (bool val)

virtual bool GetReleaseDataFlag () const

void ReleaseDataFlagOn ()

void ReleaseDataFlagOff ()

virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool & GetReleaseDataBeforeUpdateFlag () const

virtual void ReleaseDataBeforeUpdateFlagOn ()

Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)

unsigned long AddObserver (const EventObject &event, Command *) const

unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer CreateAnother () const override

virtual void DebugOff () const

virtual void DebugOn () const

CommandGetCommand (unsigned long tag)

bool GetDebug () const

virtual ModifiedTimeType GetMTime () const

virtual const TimeStampGetTimeStamp () const

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &)

void InvokeEvent (const EventObject &) const

virtual void Modified () const

void Register () const override

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag) const

void SetDebug (bool debugFlag) const

void SetReferenceCount (int) override

void UnRegister () const noexcept override

virtual void SetObjectName (std::string _arg)

virtual const std::string & GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer Clone () const

virtual void Delete ()

virtual int GetReferenceCount () const

void Print (std::ostream &os, Indent indent=0) const

## Static Public Member Functions

static Pointer New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()

static double GetGlobalDefaultDirectionTolerance ()

static void SetGlobalDefaultCoordinateTolerance (double)

static void SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static Pointer New ()

static void SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()

static Pointer New ()

## Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override

ShotNoiseImageFilter ()

~ShotNoiseImageFilter () override=default

Protected Member Functions inherited from itk::NoiseBaseImageFilter< TInputImage, TOutputImage >
NoiseBaseImageFilter ()

~NoiseBaseImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool GetRunningInPlace () const

InPlaceImageFilter ()=default

void ReleaseInputs () override

~InPlaceImageFilter () override=default

void AllocateOutputs () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void GenerateInputRequestedRegion () override

ImageToImageFilter ()

void VerifyInputInformation () const override

~ImageToImageFilter () override=default

virtual void PushBackInput (const DataObject *input)

virtual void PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >

void GenerateData () override

virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const

ImageSource ()

virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

~ImageSource () override=default

Protected Member Functions inherited from itk::ProcessObject

void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void CacheInputReleaseDataFlags ()

virtual void GenerateOutputInformation ()

virtual void GenerateOutputRequestedRegion (DataObject *output)

DataObjectGetInput (const DataObjectIdentifierType &key)

const DataObjectGetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const

bool IsIndexedInputName (const DataObjectIdentifierType &) const

bool IsIndexedOutputName (const DataObjectIdentifierType &) const

bool IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

ProcessObject ()

virtual void PropagateResetPipeline ()

virtual void PushBackInput (const DataObject *input)

virtual void PushFrontInput (const DataObject *input)

virtual void RemoveInput (const DataObjectIdentifierType &key)

virtual void RemoveInput (DataObjectPointerArraySizeType)

virtual void RemoveOutput (const DataObjectIdentifierType &key)

virtual void RemoveOutput (DataObjectPointerArraySizeType idx)

bool RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void RestoreInputReleaseDataFlags ()

virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void SetPrimaryInput (DataObject *object)

virtual void SetPrimaryOutput (DataObject *object)

void SetRequiredInputNames (const NameArray &)

virtual void VerifyPreconditions () const

~ProcessObject () override

DataObjectGetInput (DataObjectPointerArraySizeType idx)

const DataObjectGetInput (DataObjectPointerArraySizeType idx) const

DataObjectGetPrimaryInput ()

const DataObjectGetPrimaryInput () const

virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char * GetPrimaryInputName () const

DataObjectGetOutput (const DataObjectIdentifierType &key)

const DataObjectGetOutput (const DataObjectIdentifierType &key) const

virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char * GetPrimaryOutputName () const

DataObjectGetOutput (DataObjectPointerArraySizeType i)

const DataObjectGetOutput (DataObjectPointerArraySizeType i) const

DataObjectGetPrimaryOutput ()

const DataObjectGetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
Object ()

bool PrintObservers (std::ostream &os, Indent indent) const

virtual void SetTimeStamp (const TimeStamp &timeStamp)

~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const

LightObject ()

virtual void PrintHeader (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

virtual ~LightObject ()

## Private Attributes

double m_Scale { 1.0 }

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::NoiseBaseImageFilter< TInputImage, TOutputImage >
static OutputImagePixelType ClampCast (const double value)

static uint32_t Hash (uint32_t a, uint32_t b)

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float progressFixedToFloat (uint32_t fixed)

static uint32_t progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >

Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}

bool m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}

## ◆ ConstPointer

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer

Definition at line 104 of file itkShotNoiseImageFilter.h.

## ◆ InputImageConstPointer

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 121 of file itkShotNoiseImageFilter.h.

## ◆ InputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 123 of file itkShotNoiseImageFilter.h.

## ◆ InputImagePointer

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 120 of file itkShotNoiseImageFilter.h.

## ◆ InputImageRegionType

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 122 of file itkShotNoiseImageFilter.h.

## ◆ InputImageType

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 119 of file itkShotNoiseImageFilter.h.

## ◆ Pointer

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer

Definition at line 103 of file itkShotNoiseImageFilter.h.

## ◆ Self

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::Self = ShotNoiseImageFilter

Standard class type aliases.

Definition at line 101 of file itkShotNoiseImageFilter.h.

## ◆ Superclass

template<class TInputImage , class TOutputImage = TInputImage>
 using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::Superclass = NoiseBaseImageFilter

Definition at line 102 of file itkShotNoiseImageFilter.h.

## ◆ ShotNoiseImageFilter()

template<class TInputImage , class TOutputImage = TInputImage>
 itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::ShotNoiseImageFilter ( )
protected

Begin concept checking End concept checking

## ◆ ~ShotNoiseImageFilter()

template<class TInputImage , class TOutputImage = TInputImage>
 itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::~ShotNoiseImageFilter ( )
overrideprotecteddefault

## ◆ GetNameOfClass()

template<class TInputImage , class TOutputImage = TInputImage>
 const char* itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
overridevirtual

## ◆ GetScale()

template<class TInputImage , class TOutputImage = TInputImage>
 virtual double itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::GetScale ( ) const
virtual

Set/Get the value to map the pixel value to the actual particle counting. The scaling can be seen as the inverse of the gain used during the acquisition. The noisy signal is then scaled back to its input intensity range. Defaults to 1.0.

## ◆ New()

template<class TInputImage , class TOutputImage = TInputImage>
 static Pointer itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

## ◆ PrintSelf()

template<class TInputImage , class TOutputImage = TInputImage>
 void itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream & os, Indent indent ) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::NoiseBaseImageFilter< TInputImage, TOutputImage >.

## ◆ SetScale()

template<class TInputImage , class TOutputImage = TInputImage>
 virtual void itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::SetScale ( double _arg )
virtual

Set/Get the value to map the pixel value to the actual particle counting. The scaling can be seen as the inverse of the gain used during the acquisition. The noisy signal is then scaled back to its input intensity range. Defaults to 1.0.

template<class TInputImage , class TOutputImage = TInputImage>
overrideprotectedvirtual

GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

## ◆ m_Scale

template<class TInputImage , class TOutputImage = TInputImage>
 double itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::m_Scale { 1.0 }
private

Definition at line 153 of file itkShotNoiseImageFilter.h.

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