1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkTBBMultiThreader_h
#define itkTBBMultiThreader_h
#include "itkMultiThreaderBase.h"
namespace itk
{
/** \class TBBMultiThreader
* \brief 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.
*
* \ingroup OSSystemObjects
*
* \ingroup ITKCommon
*/
class ITKCommon_EXPORT TBBMultiThreader : public MultiThreaderBase
{
public:
ITK_DISALLOW_COPY_AND_MOVE(TBBMultiThreader);
/** Standard class type aliases. */
using Self = TBBMultiThreader;
using Superclass = MultiThreaderBase;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(TBBMultiThreader);
/** 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. */
void
SetNumberOfWorkUnits(ThreadIdType numberOfWorkUnits) override;
/** 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. */
void
SingleMethodExecute() override;
/** 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. */
void
SetSingleMethod(ThreadFunctionType, void * data) override;
/** Parallelize an operation over an array. If filter argument is not nullptr,
* this function will update its progress as each index is completed. */
void
ParallelizeArray(SizeValueType firstIndex,
SizeValueType lastIndexPlus1,
ArrayThreadingFunctorType aFunc,
ProcessObject * filter) override;
/** Break up region into smaller chunks, and call the function with chunks as parameters. */
void
ParallelizeImageRegion(unsigned int dimension,
const IndexValueType index[],
const SizeValueType size[],
ThreadingFunctorType funcP,
ProcessObject * filter) override;
protected:
TBBMultiThreader();
~TBBMultiThreader() override;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
/** ProcessObject is a friend so that it can call PrintSelf() on its Multithreader. */
friend class ProcessObject;
};
} // end namespace itk
#endif
|
