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 Member Functions
virtual const char *	GetNameOfClass () const
virtual ThreadIdType	PartitionDomain (const ThreadIdType threadID, const ThreadIdType requestedTotal, const DomainType &completeDomain, DomainType &subdomain) const =0
Protected Member Functions
	ThreadedDomainPartitioner ()
	~ThreadedDomainPartitioner ()
Private Member Functions
void	operator= (const Self &)
	ThreadedDomainPartitioner (const Self &)

---

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

(

)

[inline, protected]

Definition at line 82 of file itkThreadedDomainPartitioner.h.

template<class TDomain>

itk::ThreadedDomainPartitioner< TDomain >::~ThreadedDomainPartitioner

(

)

[inline, protected]

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