itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor > Class Template Reference

#include <itkUnaryFunctorWithIndexImageFilter.h>

Inheritance diagram for itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >:

Collaboration diagram for itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >:

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TFunctor>
class itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >

A (simplification of) UnaryFunctorImageFilter, which provides the pixel index to the functor.

Definition at line 41 of file itkUnaryFunctorWithIndexImageFilter.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	FunctorType = TFunctor
using	InputImageType = TInputImage
using	OutputImageType = TOutputImage
using	Pointer = SmartPointer< Self >
using	Self = UnaryFunctorWithIndexImageFilter
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
	GetSetFunctorMacro (Functor, FunctorType)
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 *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
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 (unsigned int idx)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
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 ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetMultiThreader (MultiThreaderType *threader)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
virtual void	SetReleaseDataFlag (bool flag)
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
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) 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 noexceptoverride
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
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Types
using	InputRegionType = typename InputImageType::RegionType
using	OutputRegionType = typename OutputImageType::RegionType
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
void	DynamicThreadedGenerateData (const OutputRegionType &region) override
	UnaryFunctorWithIndexImageFilter ()
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	PrintSelf (std::ostream &os, Indent indent) const override
void	VerifyInputInformation () ITKv5_CONST override
	~ImageToImageFilter () override
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () 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
void	PrintSelf (std::ostream &os, Indent indent) const override
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
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 num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions () ITKv5_CONST
	~ProcessObject () override
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
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 idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 ()

Protected Attributes
FunctorType	m_Functor
Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Additional Inherited Members
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
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage , typename TFunctor >

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

Definition at line 48 of file itkUnaryFunctorWithIndexImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::FunctorType = TFunctor

Definition at line 58 of file itkUnaryFunctorWithIndexImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::InputImageType = TInputImage

Definition at line 56 of file itkUnaryFunctorWithIndexImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::InputRegionType = typename InputImageType::RegionType

protected

Definition at line 68 of file itkUnaryFunctorWithIndexImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::OutputImageType = TOutputImage

Definition at line 57 of file itkUnaryFunctorWithIndexImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::OutputRegionType = typename OutputImageType::RegionType

protected

Definition at line 69 of file itkUnaryFunctorWithIndexImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

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

Definition at line 47 of file itkUnaryFunctorWithIndexImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::Self = UnaryFunctorWithIndexImageFilter

Definition at line 45 of file itkUnaryFunctorWithIndexImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

using itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Definition at line 46 of file itkUnaryFunctorWithIndexImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage , typename TFunctor >

itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::UnaryFunctorWithIndexImageFilter ( )

inlineprotected

Definition at line 63 of file itkUnaryFunctorWithIndexImageFilter.h.

References itk::ImageSource< TOutputImage >::DynamicMultiThreadingOn().

Member Function Documentation

template<typename TInputImage , typename TOutputImage , typename TFunctor >

virtual::itk::LightObject::Pointer itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::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.

template<typename TInputImage , typename TOutputImage , typename TFunctor >

void itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::DynamicThreadedGenerateData ( const OutputRegionType &  outputRegionForThread )

inlineoverrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See Also

GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 71 of file itkUnaryFunctorWithIndexImageFilter.h.

References itk::ImageConstIteratorWithIndex< TImage >::GetIndex(), itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput(), itk::ImageSource< TOutputImage >::GetOutput(), itk::ImageScanlineConstIterator< TImage >::GoToBegin(), itk::ImageConstIteratorWithIndex< TImage >::GoToBegin(), itk::ImageConstIterator< TImage >::IsAtEnd(), itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine(), itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::m_Functor, itk::ImageScanlineConstIterator< TImage >::NextLine(), itk::ImageScanlineIterator< TImage >::Set(), and itk::ImageConstIteratorWithIndex< TImage >::Value().

template<typename TInputImage , typename TOutputImage , typename TFunctor >

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

virtual

Run-time type information (and related methods).

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

template<typename TInputImage , typename TOutputImage , typename TFunctor >

itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::GetSetFunctorMacro	(	Functor	,
		FunctorType
	)

template<typename TInputImage , typename TOutputImage , typename TFunctor >

static Pointer itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::New ( )

static

Method for creation through the object factory.

Member Data Documentation

template<typename TInputImage , typename TOutputImage , typename TFunctor >

FunctorType itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::m_Functor

protected

Definition at line 66 of file itkUnaryFunctorWithIndexImageFilter.h.

Referenced by itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::DynamicThreadedGenerateData().

---

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

• itkUnaryFunctorWithIndexImageFilter.h