itk::ThreadedDomainPartitioner< TDomain > Class Template Reference

#include <itkThreadedDomainPartitioner.h>

Inheritance diagram for itk::ThreadedDomainPartitioner< TDomain >:

Collaboration diagram for itk::ThreadedDomainPartitioner< TDomain >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TDomain	DomainType
typedef SmartPointer< Self >	Pointer
typedef ThreadedDomainPartitioner	Self
typedef Object	Superclass
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual const char *	GetNameOfClass () const
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 LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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

Protected Member Functions
	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
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 &)
	ThreadedDomainPartitioner (const Self &)

Additional Inherited Members
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 ()

---

Detailed Description

template<class TDomain>
class itk::ThreadedDomainPartitioner< TDomain >

Virtual base class for partitioning a domain into subsets to be processed per thread when parallel processing.

The class is templated over the type of domain over which threading is performed, e.g. an image region. And it is templated over the

PartitionDomain is a method to split the domain into non-overlapping pieces for threading. Must be overridden by derived classes to provide the particular functionality required for TDomain type.

See also:

ThreadedImageRegionPartitioner

Definition at line 49 of file itkThreadedDomainPartitioner.h.

---

Member Typedef Documentation

template<class TDomain>

typedef SmartPointer<const Self> itk::ThreadedDomainPartitioner< TDomain >::ConstPointer

Reimplemented from itk::Object.

Reimplemented in itk::ThreadedIteratorRangePartitioner< TIterator >, itk::ThreadedImageRegionPartitioner< VDimension >, and itk::ThreadedIndexedContainerPartitioner.

Definition at line 56 of file itkThreadedDomainPartitioner.h.

template<class TDomain>

typedef TDomain itk::ThreadedDomainPartitioner< TDomain >::DomainType

Type of the input object that's split for threading

Reimplemented in itk::ThreadedIteratorRangePartitioner< TIterator >, itk::ThreadedImageRegionPartitioner< VDimension >, and itk::ThreadedIndexedContainerPartitioner.

Definition at line 59 of file itkThreadedDomainPartitioner.h.

template<class TDomain>

typedef SmartPointer<Self> itk::ThreadedDomainPartitioner< TDomain >::Pointer

Reimplemented from itk::Object.

Reimplemented in itk::ThreadedIteratorRangePartitioner< TIterator >, itk::ThreadedImageRegionPartitioner< VDimension >, and itk::ThreadedIndexedContainerPartitioner.

Definition at line 55 of file itkThreadedDomainPartitioner.h.

template<class TDomain>

typedef ThreadedDomainPartitioner itk::ThreadedDomainPartitioner< TDomain >::Self

Standard class typedefs.

Reimplemented from itk::Object.

Reimplemented in itk::ThreadedIteratorRangePartitioner< TIterator >, itk::ThreadedImageRegionPartitioner< VDimension >, and itk::ThreadedIndexedContainerPartitioner.

Definition at line 53 of file itkThreadedDomainPartitioner.h.

template<class TDomain>

typedef Object itk::ThreadedDomainPartitioner< TDomain >::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::ThreadedIteratorRangePartitioner< TIterator >, itk::ThreadedImageRegionPartitioner< VDimension >, and itk::ThreadedIndexedContainerPartitioner.

Definition at line 54 of file itkThreadedDomainPartitioner.h.

---

Constructor & Destructor Documentation

template<class TDomain>

itk::ThreadedDomainPartitioner< TDomain >::ThreadedDomainPartitioner ( )

inlineprotected

Definition at line 82 of file itkThreadedDomainPartitioner.h.

template<class TDomain>

itk::ThreadedDomainPartitioner< TDomain >::~ThreadedDomainPartitioner ( )

inlineprotected

Definition at line 83 of file itkThreadedDomainPartitioner.h.

template<class TDomain>

itk::ThreadedDomainPartitioner< TDomain >::ThreadedDomainPartitioner ( const Self &  )

private

---

Member Function Documentation

template<class TDomain>

virtual const char* itk::ThreadedDomainPartitioner< TDomain >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::ThreadedIteratorRangePartitioner< TIterator >, itk::ThreadedImageRegionPartitioner< VDimension >, and itk::ThreadedIndexedContainerPartitioner.

template<class TDomain>

void itk::ThreadedDomainPartitioner< TDomain >::operator= ( const Self &  )

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

Reimplemented in itk::ThreadedIteratorRangePartitioner< TIterator >, itk::ThreadedImageRegionPartitioner< VDimension >, and itk::ThreadedIndexedContainerPartitioner.

template<class TDomain>

virtual ThreadIdType itk::ThreadedDomainPartitioner< TDomain >::PartitionDomain ( const ThreadIdType  threadID, const ThreadIdType  requestedTotal, const DomainType &  completeDomain, DomainType &  subdomain  ) const

pure virtual

Split the output's RequestedObject into requestedTotal "pieces", returning piece i as splitObject. "Pieces" may represent an image region, or a index range for a parameter array, etc, depending on the type of object over which this class is templated. This method is called requestedTotal times, which is the number of threads available for use. The pieces must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedObject, i.e. return value is less than or equal to requestedTotal. This must be overridden by derived classes to provide specialized behavior.

---

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

• itkThreadedDomainPartitioner.h