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
104
105
|
/*=========================================================================
*
* 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 itkThreadedImageRegionPartitioner_h
#define itkThreadedImageRegionPartitioner_h
#include "itkThreadedDomainPartitioner.h"
#include "itkImageRegion.h"
#include "itkImageRegionSplitterSlowDimension.h"
namespace itk
{
/** \class ThreadedImageRegionPartitioner
* \brief Class for partitioning of an ImageRegion.
*
* \tparam VDimension The dimensionality of the image.
*
* The \c DomainType is defined to be an itk::ImageRegion.
*
* Partitioning will occur within the outermost, non-singleton-length
* dimension of the image region.
*
* This class is typically used as a template argument to a DomainThreader.
*
* \sa ThreadedDomainPartitioner
* \sa DomainThreader
* \ingroup ITKCommon
*/
template <unsigned int VDimension>
class ITK_TEMPLATE_EXPORT ThreadedImageRegionPartitioner : public ThreadedDomainPartitioner<ImageRegion<VDimension>>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ThreadedImageRegionPartitioner);
/** Standard class type aliases. */
using Self = ThreadedImageRegionPartitioner;
using Superclass = ThreadedDomainPartitioner<ImageRegion<VDimension>>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ThreadedImageRegionPartitioner);
/** Type of the object being threaded over */
using typename Superclass::DomainType;
/** Deprecated type alias. */
static constexpr unsigned int ImageDimension = VDimension;
using ImageRegionType = typename Self::DomainType;
using SizeType = typename ImageRegionType::SizeType;
using IndexType = typename ImageRegionType::IndexType;
/** Split the ImageRegion \c completeRegion into up to \c requestedTotal
* non-overlapping subregions, setting subregion number \c threadId as
* \c subRegion and returning the total number of subregions actually available.
*
* This method should be called repeatedly for each value of \c threadId from 0 up
* to the return value (which is always less than or equal to \c requestedTotal).
*
* It is an error for \c completeRegion to be zero-length.
* If \c threadId is greater than the return value, the contents of
* \c subRegion are undefined.
*/
ThreadIdType
PartitionDomain(const ThreadIdType threadId,
const ThreadIdType requestedTotal,
const DomainType & completeRegion,
DomainType & subRegion) const override;
protected:
ThreadedImageRegionPartitioner() = default;
~ThreadedImageRegionPartitioner() override = default;
using ImageRegionSplitterType = ImageRegionSplitterSlowDimension;
private:
ImageRegionSplitterType::Pointer m_ImageRegionSplitter{ ImageRegionSplitterType::New() };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkThreadedImageRegionPartitioner.hxx"
#endif
#endif
|
