ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
itk::ThreadedImageRegionPartitioner< VDimension > Class Template Reference

#include <itkThreadedImageRegionPartitioner.h>

+ Inheritance diagram for itk::ThreadedImageRegionPartitioner< VDimension >:
+ Collaboration diagram for itk::ThreadedImageRegionPartitioner< VDimension >:

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.

Public Types

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

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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 &)
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

template<unsigned int VDimension>
typedef SmartPointer<const Self> itk::ThreadedImageRegionPartitioner< VDimension >::ConstPointer

Definition at line 71 of file itkThreadedImageRegionPartitioner.h.

template<unsigned int VDimension>
typedef Superclass::DomainType itk::ThreadedImageRegionPartitioner< VDimension >::DomainType

Type of the object being threaded over

Definition at line 77 of file itkThreadedImageRegionPartitioner.h.

template<unsigned int VDimension>
typedef ImageRegion<VDimension> itk::ThreadedImageRegionPartitioner< VDimension >::ImageRegionType

Definition at line 86 of file itkThreadedImageRegionPartitioner.h.

template<unsigned int VDimension>
typedef Index<VDimension> itk::ThreadedImageRegionPartitioner< VDimension >::IndexType

Definition at line 88 of file itkThreadedImageRegionPartitioner.h.

template<unsigned int VDimension>
typedef SmartPointer<Self> itk::ThreadedImageRegionPartitioner< VDimension >::Pointer

Definition at line 70 of file itkThreadedImageRegionPartitioner.h.

template<unsigned int VDimension>
typedef ThreadedImageRegionPartitioner itk::ThreadedImageRegionPartitioner< VDimension >::Self

Standard class typedefs.

Definition at line 68 of file itkThreadedImageRegionPartitioner.h.

template<unsigned int VDimension>
typedef Size<VDimension> itk::ThreadedImageRegionPartitioner< VDimension >::SizeType

Definition at line 87 of file itkThreadedImageRegionPartitioner.h.

template<unsigned int VDimension>
typedef ThreadedDomainPartitioner<ImageRegion<VDimension> > itk::ThreadedImageRegionPartitioner< VDimension >::Superclass

Definition at line 69 of file itkThreadedImageRegionPartitioner.h.

Constructor & Destructor Documentation

template<unsigned int VDimension>
itk::ThreadedImageRegionPartitioner< VDimension >::ThreadedImageRegionPartitioner ( )
protected
template<unsigned int VDimension>
virtual itk::ThreadedImageRegionPartitioner< VDimension >::~ThreadedImageRegionPartitioner ( )
protectedvirtual
template<unsigned int VDimension>
itk::ThreadedImageRegionPartitioner< VDimension >::ThreadedImageRegionPartitioner ( const Self )
private

Member Function Documentation

template<unsigned int VDimension>
virtual::itk::LightObject::Pointer itk::ThreadedImageRegionPartitioner< VDimension >::CreateAnother ( void  ) 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.

template<unsigned int VDimension>
virtual const char* itk::ThreadedImageRegionPartitioner< VDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ThreadedDomainPartitioner< ImageRegion< VDimension > >.

template<unsigned int VDimension>
static Pointer itk::ThreadedImageRegionPartitioner< VDimension >::New ( )
static

Method for creation through the object factory.

template<unsigned int VDimension>
void itk::ThreadedImageRegionPartitioner< VDimension >::operator= ( const Self )
private
template<unsigned int VDimension>
virtual ThreadIdType itk::ThreadedImageRegionPartitioner< VDimension >::PartitionDomain ( const ThreadIdType  i,
const ThreadIdType  requestedTotal,
const DomainType completeRegion,
DomainType subRegion 
) const
virtual

Split the ImageRegion overallRegion into requestedTotal subregions, returning subregion i as splitRegion. This method is called requestedTotal times. 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.

Member Data Documentation

template<unsigned int VDimension>
const unsigned int itk::ThreadedImageRegionPartitioner< VDimension >::ImageDimension = VDimension
static

Some convenient typedefs.

Definition at line 84 of file itkThreadedImageRegionPartitioner.h.


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