itk::NoiseBaseImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkNoiseBaseImageFilter.h>

Inheritance diagram for itk::NoiseBaseImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::NoiseBaseImageFilter< TInputImage, TOutputImage >:

Public Types
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 const char *	GetNameOfClass () const
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
LightObject::Pointer	CreateAnother () const override
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
uint32_t	m_Seed { 0 }
virtual uint32_t	GetSeed () const
virtual void	SetSeed (uint32_t _arg)
virtual void	SetSeed ()
	NoiseBaseImageFilter ()
	~NoiseBaseImageFilter () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
static uint32_t	Hash (uint32_t a, uint32_t b)
static OutputImagePixelType	ClampCast (const double &value)

Additional Inherited Members
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 ()
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::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	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
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::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::NoiseBaseImageFilter< TInputImage, TOutputImage >

An Abstract Base class for Noise image filters.

This class add common methods for setting a seed for the random generators used to generate the noise.

See also

InPlaceImageFilter

Definition at line 39 of file itkNoiseBaseImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage = TInputImage>

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

Definition at line 48 of file itkNoiseBaseImageFilter.h.

OutputImagePixelType

template<class TInputImage , class TOutputImage = TInputImage>

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

Definition at line 50 of file itkNoiseBaseImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage = TInputImage>

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

Definition at line 47 of file itkNoiseBaseImageFilter.h.

Self

template<class TInputImage , class TOutputImage = TInputImage>

using itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::Self = NoiseBaseImageFilter

Standard class type aliases.

Definition at line 45 of file itkNoiseBaseImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage = TInputImage>

using itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::Superclass = InPlaceImageFilter<TInputImage, TOutputImage>

Definition at line 46 of file itkNoiseBaseImageFilter.h.

Constructor & Destructor Documentation

NoiseBaseImageFilter()

template<class TInputImage , class TOutputImage = TInputImage>

itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::NoiseBaseImageFilter ( )

protected

Set/Get the seed for random initialization

~NoiseBaseImageFilter()

template<class TInputImage , class TOutputImage = TInputImage>

itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::~NoiseBaseImageFilter ( )

overrideprotecteddefault

Set/Get the seed for random initialization

Member Function Documentation

ClampCast()

template<class TInputImage , class TOutputImage = TInputImage>

static OutputImagePixelType itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::ClampCast ( const double &  value )

staticprotected

Set/Get the seed for random initialization

GetNameOfClass()

template<class TInputImage , class TOutputImage = TInputImage>

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

virtual

Run-time type information (and related methods).

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

Reimplemented in itk::ShotNoiseImageFilter< TInputImage, TOutputImage >, itk::SaltAndPepperNoiseImageFilter< TInputImage, TOutputImage >, itk::SpeckleNoiseImageFilter< TInputImage, TOutputImage >, and itk::AdditiveGaussianNoiseImageFilter< TInputImage, TOutputImage >.

GetSeed()

template<class TInputImage , class TOutputImage = TInputImage>

virtual uint32_t itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::GetSeed ( ) const

virtual

Set/Get the seed for random initialization

Hash()

template<class TInputImage , class TOutputImage = TInputImage>

static uint32_t itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::Hash ( uint32_t  a, uint32_t  b  )

inlinestaticprotected

Set/Get the seed for random initialization

Definition at line 74 of file itkNoiseBaseImageFilter.h.

PrintSelf()

template<class TInputImage , class TOutputImage = TInputImage>

void itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Set/Get the seed for random initialization

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

Reimplemented in itk::ShotNoiseImageFilter< TInputImage, TOutputImage >, itk::SaltAndPepperNoiseImageFilter< TInputImage, TOutputImage >, and itk::SpeckleNoiseImageFilter< TInputImage, TOutputImage >.

SetSeed() [1/2]

template<class TInputImage , class TOutputImage = TInputImage>

virtual void itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::SetSeed ( )

virtual

Set the seed to a value initialized with the current time and process clock.

SetSeed() [2/2]

template<class TInputImage , class TOutputImage = TInputImage>

virtual void itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::SetSeed ( uint32_t  _arg )

virtual

Set/Get the seed for random initialization

Member Data Documentation

m_Seed

template<class TInputImage , class TOutputImage = TInputImage>

uint32_t itk::NoiseBaseImageFilter< TInputImage, TOutputImage >::m_Seed { 0 }

private

Set/Get the seed for random initialization

Definition at line 85 of file itkNoiseBaseImageFilter.h.

---

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

• itkNoiseBaseImageFilter.h