ITK  6.0.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
itk::PoolMultiThreader Class Reference

#include <itkPoolMultiThreader.h>

Detailed Description

A class for performing multithreaded execution with a thread pool back end.

Definition at line 45 of file itkPoolMultiThreader.h.

+ Inheritance diagram for itk::PoolMultiThreader:
+ Collaboration diagram for itk::PoolMultiThreader:


struct  ThreadPoolInfoStruct

Public Types

using ConstPointer = SmartPointer< const Self >
using Pointer = SmartPointer< Self >
using Self = PoolMultiThreader
using Superclass = MultiThreaderBase
- Public Types inherited from itk::MultiThreaderBase
using ArrayThreadingFunctorType = std::function< void(SizeValueType)>
using ConstPointer = SmartPointer< const Self >
using Pointer = SmartPointer< Self >
using Self = MultiThreaderBase
using Superclass = Object
using ThreaderEnum = MultiThreaderBaseEnums::Threader
using ThreadingFunctorType = std::function< void(const IndexValueType index[], const SizeValueType size[])>
- 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
void ParallelizeArray (SizeValueType firstIndex, SizeValueType lastIndexPlus1, ArrayThreadingFunctorType aFunc, ProcessObject *filter) override
void ParallelizeImageRegion (unsigned int dimension, const IndexValueType index[], const SizeValueType size[], ThreadingFunctorType funcP, ProcessObject *filter) override
void SetMaximumNumberOfThreads (ThreadIdType numberOfThreads) override
void SetSingleMethod (ThreadFunctionType, void *data) override
void SingleMethodExecute () override
- Public Member Functions inherited from itk::MultiThreaderBase
virtual bool GetUpdateProgress () const
template<unsigned int VDimension, typename TFunction >
ITK_TEMPLATE_EXPORT void ParallelizeImageRegionRestrictDirection (unsigned int restrictedDirection, const ImageRegion< VDimension > &requestedRegion, TFunction funcP, ProcessObject *filter)
void SetSingleMethodAndExecute (ThreadFunctionType func, void *data)
virtual void SetUpdateProgress (bool updates)
virtual ThreadIdType GetMaximumNumberOfThreads () const
virtual void SetNumberOfWorkUnits (ThreadIdType numberOfWorkUnits)
virtual ThreadIdType GetNumberOfWorkUnits () const
 itkLegacyMacro (static void SetGlobalDefaultUseThreadPool(const bool GlobalDefaultUseThreadPool))
 itkLegacyMacro (static bool GetGlobalDefaultUseThreadPool())
template<unsigned int VDimension, typename TFunction >
ITK_TEMPLATE_EXPORT void ParallelizeImageRegion (const ImageRegion< VDimension > &requestedRegion, TFunction funcP, ProcessObject *filter)
- 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
MetaDataDictionaryGetMetaDataDictionary ()
const MetaDataDictionaryGetMetaDataDictionary () 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
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::MultiThreaderBase
static Pointer New ()
static ThreaderEnum ThreaderTypeFromString (std::string threaderString)
static void SetGlobalMaximumNumberOfThreads (ThreadIdType val)
static ThreadIdType GetGlobalMaximumNumberOfThreads ()
static std::string ThreaderTypeToString (ThreaderEnum threader)
static void SetGlobalDefaultThreader (ThreaderEnum threaderType)
static ThreaderEnum GetGlobalDefaultThreader ()
static void SetGlobalDefaultNumberOfThreads (ThreadIdType val)
static ThreadIdType GetGlobalDefaultNumberOfThreads ()
- 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

 PoolMultiThreader ()
void PrintSelf (std::ostream &os, Indent indent) const override
 ~PoolMultiThreader () override
- Protected Member Functions inherited from itk::MultiThreaderBase
 MultiThreaderBase ()
 ~MultiThreaderBase () override
- 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

ThreadPoolInfoStruct m_ThreadInfoArray [ITK_MAX_THREADS] {}
ThreadPool::Pointer m_ThreadPool {}


class ProcessObject

Additional Inherited Members

- Static Protected Member Functions inherited from itk::MultiThreaderBase
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ParallelizeArrayHelper (void *arg)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ParallelizeImageRegionHelper (void *arg)
- Protected Attributes inherited from itk::MultiThreaderBase
ThreadIdType m_MaximumNumberOfThreads {}
ThreadIdType m_NumberOfWorkUnits {}
void * m_SingleData { nullptr }
ThreadFunctionType m_SingleMethod { nullptr }
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

Definition at line 54 of file itkPoolMultiThreader.h.

◆ Pointer

Definition at line 53 of file itkPoolMultiThreader.h.

◆ Self

Standard class type aliases.

Definition at line 51 of file itkPoolMultiThreader.h.

◆ Superclass

Definition at line 52 of file itkPoolMultiThreader.h.

Constructor & Destructor Documentation

◆ PoolMultiThreader()

itk::PoolMultiThreader::PoolMultiThreader ( )

◆ ~PoolMultiThreader()

itk::PoolMultiThreader::~PoolMultiThreader ( )

Member Function Documentation

◆ GetNameOfClass()

const char* itk::PoolMultiThreader::GetNameOfClass ( ) const

◆ New()

static Pointer itk::PoolMultiThreader::New ( )

Method for creation through the object factory.

◆ ParallelizeArray()

void itk::PoolMultiThreader::ParallelizeArray ( SizeValueType  firstIndex,
SizeValueType  lastIndexPlus1,
ArrayThreadingFunctorType  aFunc,
ProcessObject filter 

Parallelize an operation over an array. If filter argument is not nullptr, this function will update its progress as each index is completed.

Reimplemented from itk::MultiThreaderBase.

◆ ParallelizeImageRegion()

void itk::PoolMultiThreader::ParallelizeImageRegion ( unsigned int  dimension,
const IndexValueType  index[],
const SizeValueType  size[],
ThreadingFunctorType  funcP,
ProcessObject filter 

Break up region into smaller chunks, and call the function with chunks as parameters.

Reimplemented from itk::MultiThreaderBase.

◆ PrintSelf()

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

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::MultiThreaderBase.

◆ SetMaximumNumberOfThreads()

void itk::PoolMultiThreader::SetMaximumNumberOfThreads ( ThreadIdType  numberOfThreads)

Set the number of threads to use. PoolMultiThreader can only INCREASE its number of threads.

Reimplemented from itk::MultiThreaderBase.

◆ SetSingleMethod()

void itk::PoolMultiThreader::SetSingleMethod ( ThreadFunctionType  ,
void *  data 

Set the SingleMethod to f() and the UserData field of the WorkUnitInfo that is passed to it will be data. This method must be of type itkThreadFunctionType and must take a single argument of type void.

Implements itk::MultiThreaderBase.

◆ SingleMethodExecute()

void itk::PoolMultiThreader::SingleMethodExecute ( )

Execute the SingleMethod (as define by SetSingleMethod) using m_NumberOfWorkUnits work units. As a side effect the m_NumberOfWorkUnits will be checked against the current m_GlobalMaximumNumberOfThreads and clamped if necessary.

Implements itk::MultiThreaderBase.

Friends And Related Function Documentation

◆ ProcessObject

friend class ProcessObject

Friends of Multithreader. ProcessObject is a friend so that it can call PrintSelf() on its Multithreader.

Friends of DataObject

Definition at line 121 of file itkPoolMultiThreader.h.

Member Data Documentation

◆ m_ThreadInfoArray

ThreadPoolInfoStruct itk::PoolMultiThreader::m_ThreadInfoArray[ITK_MAX_THREADS] {}

An array of work unit information containing a work unit id (0, 1, 2, .. ITK_MAX_THREADS-1), work unit count, and a pointer to void so that user data can be passed to each thread.

Definition at line 116 of file itkPoolMultiThreader.h.

◆ m_ThreadPool

ThreadPool::Pointer itk::PoolMultiThreader::m_ThreadPool {}

Definition at line 111 of file itkPoolMultiThreader.h.

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