itk::ThreadedIndexedContainerPartitioner Class Reference

#include <itkThreadedIndexedContainerPartitioner.h>

Inheritance diagram for itk::ThreadedIndexedContainerPartitioner:

Collaboration diagram for itk::ThreadedIndexedContainerPartitioner:

Detailed Description

Partitions an indexed container.

The DomainType is defined to be a two element itk::Index of ElementIdentifiers: the first element defines the start of the domain, and the second element defines the end of the domain.

Element counting starts from zero and the identifier at the end of the domain is inclusive.

This class is typically used as a template argument to a DomainThreader.

See Also

ThreadedDomainPartitioner

DomainThreader

IndexedContainerInterface

Examples:

SphinxExamples/src/Core/Common/DoDataParallelThreading/Code.cxx.

Definition at line 45 of file itkThreadedIndexedContainerPartitioner.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DomainType = Superclass::DomainType
using	IndexRangeType = DomainType
using	Pointer = SmartPointer< Self >
using	Self = ThreadedIndexedContainerPartitioner
using	Superclass = ThreadedDomainPartitioner< Index< 2 > >
Public Types inherited from itk::ThreadedDomainPartitioner< Index< 2 > >
using	ConstPointer = SmartPointer< const Self >
using	DomainType = Index< 2 >
using	Pointer = SmartPointer< Self >
using	Self = ThreadedDomainPartitioner
using	Superclass = Object
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
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
ThreadIdType	PartitionDomain (const ThreadIdType threadId, const ThreadIdType requestedTotal, const DomainType &completeIndexRange, DomainType &subIndexRange) const override
Public Member Functions inherited from itk::ThreadedDomainPartitioner< Index< 2 > >
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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
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
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
	ThreadedIndexedContainerPartitioner ()
	~ThreadedIndexedContainerPartitioner () override
Protected Member Functions inherited from itk::ThreadedDomainPartitioner< Index< 2 > >
	ThreadedDomainPartitioner ()=default
	~ThreadedDomainPartitioner () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 ()

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::ThreadedIndexedContainerPartitioner::ConstPointer = SmartPointer< const Self >

Definition at line 55 of file itkThreadedIndexedContainerPartitioner.h.

using itk::ThreadedIndexedContainerPartitioner::DomainType = Superclass::DomainType

Type for convenience of base class methods

Definition at line 64 of file itkThreadedIndexedContainerPartitioner.h.

using itk::ThreadedIndexedContainerPartitioner::IndexRangeType = DomainType

Synonym for the domain that is more descriptive.

Definition at line 67 of file itkThreadedIndexedContainerPartitioner.h.

using itk::ThreadedIndexedContainerPartitioner::Pointer = SmartPointer< Self >

Definition at line 54 of file itkThreadedIndexedContainerPartitioner.h.

using itk::ThreadedIndexedContainerPartitioner::Self = ThreadedIndexedContainerPartitioner

Standard class type aliases.

Definition at line 52 of file itkThreadedIndexedContainerPartitioner.h.

using itk::ThreadedIndexedContainerPartitioner::Superclass = ThreadedDomainPartitioner< Index<2> >

Definition at line 53 of file itkThreadedIndexedContainerPartitioner.h.

Constructor & Destructor Documentation

itk::ThreadedIndexedContainerPartitioner::ThreadedIndexedContainerPartitioner ( )

protected

itk::ThreadedIndexedContainerPartitioner::~ThreadedIndexedContainerPartitioner ( )

overrideprotected

Member Function Documentation

virtual::itk::LightObject::Pointer itk::ThreadedIndexedContainerPartitioner::CreateAnother ( ) const

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 const char* itk::ThreadedIndexedContainerPartitioner::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ThreadedDomainPartitioner< Index< 2 > >.

static Pointer itk::ThreadedIndexedContainerPartitioner::New ( )

static

Method for creation through the object factory.

ThreadIdType itk::ThreadedIndexedContainerPartitioner::PartitionDomain ( const ThreadIdType  threadId, const ThreadIdType  requestedTotal, const DomainType &  completeIndexRange, DomainType &  subIndexRange  ) const

override

Split the index range completeIndexRange into up to requestedTotal non-overlapping subranges, setting subrange number threadId as subIndexRange and returning the total number of subranges 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 completeIndexRange to be zero-length (i.e. for completeIndexRange.End to be less than completeIndexRange.Begin). If threadId is greater than the return value, the contents of subIndexRange are undefined.

---

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

• itkThreadedIndexedContainerPartitioner.h