ITK
4.8.0
Insight Segmentation and Registration Toolkit
|
#include <itkThreadedIteratorRangePartitioner.h>
Partitions an iterator range for threading.
TIterator | The type of the iterator. |
The DomainType
is defined to be an itk::ThreadedIteratorRangePartitionerDomain, a two component struct of interators: the first iterator, Begin
, defines the start of the domain, and the second iterator, End
, defines one element past the end of the domain.
The class assumes that iterating through the domain will be a repeatable process.
While this class will work for most containers that use iterators, indexed containers such as std::vector or Array will be partitioned much more efficiently with a ThreadedIndexedContainerPartitioner.
This class is typically used as a template argument to a DomainThreader.
Definition at line 27 of file itkThreadedIteratorRangePartitioner.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef Superclass::DomainType | DomainType |
typedef TIterator | IteratorType |
typedef SmartPointer< Self > | Pointer |
typedef ThreadedIteratorRangePartitioner | Self |
typedef ThreadedDomainPartitioner < ThreadedIteratorRangePartitionerDomain < TIterator > > | Superclass |
Public Types inherited from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > > | |
typedef SmartPointer< const Self > | ConstPointer |
typedef ThreadedIteratorRangePartitionerDomain < TIterator > | DomainType |
typedef SmartPointer< Self > | Pointer |
typedef ThreadedDomainPartitioner | Self |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const char * | GetNameOfClass () const |
virtual ThreadIdType | PartitionDomain (const ThreadIdType threadId, const ThreadIdType requestedTotal, const DomainType &completeDomain, DomainType &subDomain) const override |
Public Member Functions inherited from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > > | |
virtual ThreadIdType | PartitionDomain (const ThreadIdType threadId, const ThreadIdType requestedTotal, const DomainType &completeDomain, DomainType &subDomain) const =0 |
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 |
virtual void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) override |
virtual void | UnRegister () const noexceptoverride |
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 Member Functions | |
ThreadedIteratorRangePartitioner () | |
virtual | ~ThreadedIteratorRangePartitioner () |
Protected Member Functions inherited from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > > | |
ThreadedDomainPartitioner () | |
~ThreadedDomainPartitioner () | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
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 Member Functions | |
void | operator= (const Self &) |
ThreadedIteratorRangePartitioner (const Self &) | |
Additional Inherited Members | |
Protected Attributes inherited from itk::LightObject | |
AtomicInt< int > | m_ReferenceCount |
typedef SmartPointer< const Self > itk::ThreadedIteratorRangePartitioner< TIterator >::ConstPointer |
Definition at line 115 of file itkThreadedIteratorRangePartitioner.h.
typedef Superclass::DomainType itk::ThreadedIteratorRangePartitioner< TIterator >::DomainType |
Type for convenience of base class methods
Definition at line 121 of file itkThreadedIteratorRangePartitioner.h.
typedef TIterator itk::ThreadedIteratorRangePartitioner< TIterator >::IteratorType |
Definition at line 126 of file itkThreadedIteratorRangePartitioner.h.
typedef SmartPointer< Self > itk::ThreadedIteratorRangePartitioner< TIterator >::Pointer |
Definition at line 114 of file itkThreadedIteratorRangePartitioner.h.
typedef ThreadedIteratorRangePartitioner itk::ThreadedIteratorRangePartitioner< TIterator >::Self |
Standard class typedefs.
Definition at line 112 of file itkThreadedIteratorRangePartitioner.h.
typedef ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > > itk::ThreadedIteratorRangePartitioner< TIterator >::Superclass |
Definition at line 113 of file itkThreadedIteratorRangePartitioner.h.
|
protected |
|
protectedvirtual |
|
private |
|
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.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > >.
|
static |
Method for creation through the object factory.
|
private |
|
overridevirtual |
Split the domain completeDomain
into up to requestedTotal
non-overlapping subdomains, setting subdomain number threadId
as subDomain
and returning the total number of subdomains actually available.
This method should be called repeatedly for each value of threadId
, from 0 up to the return value (which is always less than or equal to requestedTotal
).
It is an error for completeDomain
to be zero-length. If threadId
is greater than the return value, the contents of subDomain
are undefined.