#include <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	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImagePointer = typename Superclass::OutputImagePointer

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	OutputImageType = typename Superclass::OutputImageType

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	OutputImagePixelType = typename Superclass::OutputImagePixelType

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	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImagePointer = typename Superclass::OutputImagePointer

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	OutputImageType = typename Superclass::OutputImageType

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	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

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	MultiThreaderType = MultiThreaderBase

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
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::NoiseBaseImageFilter< TInputImage, TOutputImage >
virtual uint32_t	GetSeed () const

virtual void	SetSeed (uint32_t _arg)

virtual void	SetSeed ()

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

virtual bool	CanRunInPlace () const

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

const InputImageType *	GetInput (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 >
OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput (unsigned int idx)

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	AbortGenerateDataOff ()

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	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 ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

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 void	SetGlobalDefaultDirectionTolerance (double)

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

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 ()

double	m_Scale { 1.0 }

virtual double	GetScale () const

virtual void	SetScale (double _arg)

	ShotNoiseImageFilter ()

	~ShotNoiseImageFilter () override=default

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

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override

Additional Inherited Members
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 >

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

	~NoiseBaseImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
	InPlaceImageFilter ()=default

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

void	ReleaseInputs () override

virtual bool	GetRunningInPlace () const

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

	~ImageToImageFilter () override=default

void	VerifyInputInformation () ITKv5_CONST override

void	GenerateInputRequestedRegion () override

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

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

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

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

	~ImageSource () override=default

void	GenerateData () override

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual void	BeforeThreadedGenerateData ()

virtual void	AfterThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

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

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

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

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 ()

Static Protected Member Functions inherited from itk::NoiseBaseImageFilter< TInputImage, TOutputImage >
static uint32_t	Hash (uint32_t a, uint32_t b)

static OutputImagePixelType	ClampCast (const double &value)

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

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

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

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:

: where is a Poisson-distributed random variable of mean . 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 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 provides a uniformly distributed random variable in the interval .

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 is a normally distributed random variable of mean 0 and variance 1.

Author: Gaetan Lehmann

This code was contributed in the Insight Journal paper "Noise Simulation". https://www.insight-journal.org/browse/publication/721

Definition at line 94 of file itkShotNoiseImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage = TInputImage>

using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

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.

◆ OutputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>

using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename Superclass::OutputImagePixelType

Definition at line 116 of file itkShotNoiseImageFilter.h.

◆ OutputImagePointer

template<class TInputImage , class TOutputImage = TInputImage>

using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename Superclass::OutputImagePointer

Definition at line 114 of file itkShotNoiseImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage = TInputImage>

using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename Superclass::OutputImageRegionType

Definition at line 115 of file itkShotNoiseImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage = TInputImage>

using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::OutputImageType = typename Superclass::OutputImageType

Superclass type alias.

Definition at line 113 of file itkShotNoiseImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage = TInputImage>

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

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<TInputImage, TOutputImage>

Definition at line 102 of file itkShotNoiseImageFilter.h.

Constructor & Destructor Documentation

◆ 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

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.

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TOutputImage = TInputImage>

virtual::itk::LightObject::Pointer itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage = TInputImage>

virtual const char* itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

◆ 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

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.

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.

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage = TInputImage>

void itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)

overrideprotectedvirtual

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.

Reimplemented from itk::ImageSource< TOutputImage >.

Member Data Documentation

◆ m_Scale

template<class TInputImage , class TOutputImage = TInputImage>

double itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::m_Scale { 1.0 }

private

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.

Definition at line 153 of file itkShotNoiseImageFilter.h.

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

itkShotNoiseImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ShotNoiseImageFilter()

◆ ~ShotNoiseImageFilter()

Member Function Documentation

◆ CreateAnother()

◆ GetNameOfClass()

◆ GetScale()

◆ New()

◆ PrintSelf()

◆ SetScale()

◆ ThreadedGenerateData()

Member Data Documentation

◆ m_Scale

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