#include <itkThreadedImageRegionPartitioner.h>

Inheritance diagram for itk::ThreadedImageRegionPartitioner< VDimension >:

Collaboration diagram for itk::ThreadedImageRegionPartitioner< VDimension >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DomainType	DomainType
typedef ImageRegion< VDimension >	ImageRegionType
typedef Index< VDimension >	IndexType
typedef SmartPointer< Self >	Pointer
typedef ThreadedImageRegionPartitioner	Self
typedef Size< VDimension >	SizeType
typedef ThreadedDomainPartitioner < ImageRegion< VDimension > >	Superclass
Public Types inherited from itk::ThreadedDomainPartitioner< ImageRegion< VDimension > >
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual ThreadIdType	PartitionDomain (const ThreadIdType i, const ThreadIdType requestedTotal, const DomainType &completeRegion, DomainType &subRegion) const
Public Member Functions inherited from itk::ThreadedDomainPartitioner< ImageRegion< VDimension > >
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 (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

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = VDimension

Protected Member Functions
	ThreadedImageRegionPartitioner ()
virtual	~ThreadedImageRegionPartitioner ()
Protected Member Functions inherited from itk::ThreadedDomainPartitioner< ImageRegion< VDimension > >
	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 &)
	ThreadedImageRegionPartitioner (const Self &)

Detailed Description

template<unsigned int VDimension>
class itk::ThreadedImageRegionPartitioner< VDimension >

Class for partitioning of an ImageRegion.

This class provides threading over an ImageRegion. It provides a SplitRequestedObject method that splits the provided ImageRegion into subregions, along the z-axis. Additionally it makes setting up a threaded operation easier.

Call SetOverallRegion to define the ImageRegion over which to thread. Call SetThreadedGenerateData to define the worker callback function, which is called from each thread with a unique region to process.

Warning:: This callback function must be static if it is a class method.

Call SetHolder to provide a pointer to DataHolder object to store arbitrary user data for use in the threader callback (typically a class instance).

Call GenerateData to begin threaded processing.

This class is templated over image dimension and DataHolder type. The third template parameter TDomain should always be left as default.

Warning:: The actual number of threads used may be less than the requested number of threads. Either because the requested number is greater than the number available, or the SplitRequestedObject method decides that fewer threads would be more efficient. After the threader has run, m_NumberOfThreadsUsed holds the actual number used. See DetermineNumberOfThreadsToUse to get the number of threads before running.

See also:: ThreadedDomainPartitioner

Definition at line 63 of file itkThreadedImageRegionPartitioner.h.