#include <itkTBBMultiThreader.h>
A class for performing multithreaded execution with a thread pool back end, uses the Intel Threading Building Blocks (TBB) library.
This multi-threader implementation generates dynamically-sized thread-regions, and is expected to provide best performance.
Definition at line 38 of file itkTBBMultiThreader.h.
Public Types | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = TBBMultiThreader |
using | Superclass = 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[])> |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = Object |
using | Superclass = LightObject |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = LightObject |
Public Member Functions | |
virtual::itk::LightObject::Pointer | CreateAnother () const |
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 | SetNumberOfWorkUnits (ThreadIdType numberOfWorkUnits) override |
void | SetSingleMethod (ThreadFunctionType, void *data) override |
void | SingleMethodExecute () override |
![]() | |
virtual bool | GetUpdateProgress () const |
template<unsigned int VDimension, typename TFunction> | |
ITK_TEMPLATE_EXPORT void | ParallelizeImageRegion (const ImageRegion< VDimension > &requestedRegion, TFunction funcP, ProcessObject *filter) |
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 void | SetMaximumNumberOfThreads (ThreadIdType numberOfThreads) |
virtual ThreadIdType | GetMaximumNumberOfThreads () const |
virtual ThreadIdType | GetNumberOfWorkUnits () const |
![]() | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) 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) 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 |
![]() | |
Pointer | Clone () const |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
Protected Member Functions | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
TBBMultiThreader () | |
~TBBMultiThreader () override | |
![]() | |
MultiThreaderBase () | |
~MultiThreaderBase () override | |
![]() | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
![]() | |
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 () |
Friends | |
class | ProcessObject |
Additional Inherited Members | |
![]() | |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ParallelizeArrayHelper (void *arg) |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ParallelizeImageRegionHelper (void *arg) |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | SingleMethodProxy (void *arg) |
![]() | |
ThreadIdType | m_MaximumNumberOfThreads {} |
ThreadIdType | m_NumberOfWorkUnits {} |
void * | m_SingleData { nullptr } |
ThreadFunctionType | m_SingleMethod { nullptr } |
![]() | |
std::atomic< int > | m_ReferenceCount {} |
using itk::TBBMultiThreader::ConstPointer = SmartPointer<const Self> |
Definition at line 47 of file itkTBBMultiThreader.h.
Definition at line 46 of file itkTBBMultiThreader.h.
Standard class type aliases.
Definition at line 44 of file itkTBBMultiThreader.h.
Definition at line 45 of file itkTBBMultiThreader.h.
|
protected |
Referenced by GetNameOfClass().
|
overrideprotected |
|
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.
|
overridevirtual |
Reimplemented from itk::MultiThreaderBase.
References TBBMultiThreader().
|
static |
Method for creation through the object factory.
|
overridevirtual |
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.
References ProcessObject.
|
overridevirtual |
Break up region into smaller chunks, and call the function with chunks as parameters.
Reimplemented from itk::MultiThreaderBase.
References ProcessObject.
|
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::MultiThreaderBase.
|
overridevirtual |
Get/Set the number of work units to create. TBBMultiThreader does not limit the number of work units. This number is only respected by SetSingleMethod/SingleMethodExecute.
Reimplemented from itk::MultiThreaderBase.
|
overridevirtual |
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.
|
overridevirtual |
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.
|
friend |
ProcessObject is a friend so that it can call PrintSelf() on its Multithreader.
Friends of DataObject
Definition at line 99 of file itkTBBMultiThreader.h.
References ProcessObject.
Referenced by ParallelizeArray(), ParallelizeImageRegion(), and ProcessObject.