#include <itkDomainThreader.h>

Inheritance diagram for itk::DomainThreader< TDomainPartitioner, TAssociate >:

Collaboration diagram for itk::DomainThreader< TDomainPartitioner, TAssociate >:

Classes
struct	ThreadStruct
Public Types
typedef TAssociate	AssociateType
typedef SmartPointer< const Self >	ConstPointer
typedef TDomainPartitioner	DomainPartitionerType
typedef DomainPartitionerType::DomainType	DomainType
typedef SmartPointer< Self >	Pointer
typedef DomainThreader	Self
typedef Object	Superclass
Public Member Functions
void	Execute (AssociateType *enclosingClass, const DomainType &domain)
MultiThreader *	GetMultiThreader () const
virtual const char *	GetNameOfClass () const
virtual ThreadIdType	GetNumberOfThreadsUsed () const

virtual void	SetDomainPartitioner (DomainPartitionerType *_arg)
virtual const DomainPartitionerType *	GetDomainPartitioner ()

ThreadIdType	GetMaximumNumberOfThreads () const
void	SetMaximumNumberOfThreads (const ThreadIdType threads)
Protected Member Functions
virtual void	AfterThreadedExecution ()
virtual void	BeforeThreadedExecution ()
virtual void	DetermineNumberOfThreadsUsed ()
	DomainThreader ()
virtual void	SetMultiThreader (MultiThreader *_arg)
virtual void	ThreadedExecution (const DomainType &subdomain, const ThreadIdType threadId)=0
virtual	~DomainThreader ()
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
AssociateType *	m_Associate
Private Member Functions
	DomainThreader (const Self &)
void	operator= (const Self &)
void	StartThreadingSequence ()
Private Attributes
DomainType	m_CompleteDomain
DomainPartitionerType::Pointer	m_DomainPartitioner
MultiThreader::Pointer	m_MultiThreader
ThreadIdType	m_NumberOfThreadsUsed

Detailed Description

template<class TDomainPartitioner, class TAssociate>
class itk::DomainThreader< TDomainPartitioner, TAssociate >

Multi-threaded processing on a domain by processing sub-domains per thread.

This class uses a ThreadedDomainPartitioner as a helper to split the domain into subdomains. Each subdomain is then processed in the ThreadedExecution method.

The data on which to perform the processing is assumed to be members of an associating class. Therefore, to perform a threaded operation in a class, the associating class usually will declare derived versions of this class as a friend class.

To use this class, at a minimum,

Inherit from it.
Implement ThreadedExecution.
Create a member instance.
Run with m_DomainThreader->Execute( this, domain );

If a 'threaded method' is desired to perform some data processing in a class, a derived version of this class can be defined to perform the threaded operation. Since a threaded operation is relatively complex compared to a simple serial operation, a class instead of a simple method is required. Inside this class, the method to partition the data is handled, the logic for determining the number of threads is determined, and operations surrounding the threading are encapsulated into the class with the DetermineNumberOfThreadsToUse, BeforeThreadedExecution, ThreadedExecution, and AfterThreadedExecution virtual methods.

Template Parameters:

TDomainPartitioner	A class that inherits from ThreadedDomainPartitioner.
TAssociate	The asssociated class that uses a derived version of this class as a "threaded method". The associated class usually declares derived version of this class as nested classes so there is easy access to its protected and private members in ThreadedExecution.

Definition at line 66 of file itkDomainThreader.h.