itk::MultiThreader Class Reference

#include <itkMultiThreader.h>

Inheritance diagram for itk::MultiThreader:

[legend]Collaboration diagram for itk::MultiThreader:

[legend]List of all members.

---

Detailed Description

A class for performing multithreaded execution.

Multithreader is a class that provides support for multithreaded execution using sproc() on an SGI, or pthread_create on any platform supporting POSIX threads. This class can be used to execute a single method on multiple threads, or to specify a method per thread.

Note

If ITK_USE_SPROC is defined, then sproc() will be used to create multiple threads on an SGI. If ITK_USE_PTHREADS is defined, then pthread_create() will be used to create multiple threads (on a sun, for example).

Definition at line 136 of file itkMultiThreader.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef MultiThreader	Self
typedef Object	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetNumberOfThreads ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	MultipleMethodExecute ()
Set Get the value which is used to initialize the NumberOfThreads *in the constructor Initially this default is set to the number of *processors	or (which ever is less).*/static void SetGlobalDefaultNumberOfThreads(int val)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMultipleMethod (int index, ThreadFunctionType, void *data)
Get Set the number of threads to create It will be clamped to the range so the caller of this method should check that the *requested number of threads was accepted *virtual void	SetNumberOfThreads (int _arg)
virtual void	SetReferenceCount (int)
void	SetSingleMethod (ThreadFunctionType, void *data)
void	SingleMethodExecute ()
int	SpawnThread (ThreadFunctionType, void *data)
void	TerminateThread (int thread_id)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static int	GetGlobalDefaultNumberOfThreads ()
static int	GetGlobalMaximumNumberOfThreads ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
Set Get the maximum number of threads to use when multithreading *This limits and overrides any other settings for multithreading *A value of zero indicates no limit *static void	SetGlobalMaximumNumberOfThreads (int val)
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Get Set the number of threads to create It will be clamped to the range *	ITK_MAX_THREADS
Protected Member Functions
	MultiThreader ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	~MultiThreader ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual Print() to print information about the object *including superclasses.Typically not called by the user(use Print()*instead) but used in the hierarchical print process to combine the *output of several classes.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const
Friends
class	ProcessObject
Classes
struct	ThreadInfoStruct

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::MultiThreader::ConstPointer

Reimplemented from itk::Object. Definition at line 143 of file itkMultiThreader.h.

typedef SmartPointer<Self> itk::MultiThreader::Pointer

Reimplemented from itk::Object. Definition at line 142 of file itkMultiThreader.h.

typedef MultiThreader itk::MultiThreader::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 140 of file itkMultiThreader.h.

typedef Object itk::MultiThreader::Superclass

Reimplemented from itk::Object. Definition at line 141 of file itkMultiThreader.h.

---

Constructor & Destructor Documentation

itk::MultiThreader::MultiThreader (   )  [protected]

itk::MultiThreader::~MultiThreader (   )  [protected]

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static int itk::MultiThreader::GetGlobalDefaultNumberOfThreads (   )  [static]

static int itk::MultiThreader::GetGlobalMaximumNumberOfThreads (   )  [static]

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

virtual const char* itk::MultiThreader::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

virtual int itk::MultiThreader::GetNumberOfThreads (   )  [virtual]

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

void itk::MultiThreader::MultipleMethodExecute (   )

Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required m_NumberOfThreads methods) using m_NumberOfThreads threads.

static Pointer itk::MultiThreader::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

Set Get the value which is used to initialize the NumberOfThreads* in the constructor Initially this default is set to the number of* processors itk::MultiThreader::or (  which ever is  less  )

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

void itk::MultiThreader::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::Object.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

Set Get the maximum number of threads to use when multithreading* This limits and overrides any other settings for multithreading* A value of zero indicates no limit* static void itk::MultiThreader::SetGlobalMaximumNumberOfThreads (  int  val  )  [static]

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

void itk::MultiThreader::SetMultipleMethod (  int  index, ThreadFunctionType  , void *  data )

Set the MultipleMethod at the given index to f() and the UserData field of the ThreadInfoStruct that is passed to it will be data.

Get Set the number of threads to create It will be clamped to the range so the caller of this method should check that the* requested number of threads was accepted* virtual void itk::MultiThreader::SetNumberOfThreads (  int  _arg  )  [virtual]

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

void itk::MultiThreader::SetSingleMethod (  ThreadFunctionType  , void *  data )

Set the SingleMethod to f() and the UserData field of the ThreadInfoStruct that is passed to it will be data. This method (and all the methods passed to SetMultipleMethod) must be of type itkThreadFunctionType and must take a single argument of type void *.

void itk::MultiThreader::SingleMethodExecute (   )

Execute the SingleMethod (as define by SetSingleMethod) using m_NumberOfThreads threads.

int itk::MultiThreader::SpawnThread (  ThreadFunctionType  , void *  data )

Create a new thread for the given function. Return a thread id which is a number between 0 and ITK_MAX_THREADS - 1. This id should be used to kill the thread at a later time.

void itk::MultiThreader::TerminateThread (  int  thread_id  )

Terminate the thread that was created with a SpawnThreadExecute()

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Friends And Related Function Documentation

friend class ProcessObject [friend]

Friends of Multithreader. ProcessObject is a friend so that it can call PrintSelf() on its Multithreader. Definition at line 308 of file itkMultiThreader.h.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

Get Set the number of threads to create It will be clamped to the range* itk::MultiThreader::ITK_MAX_THREADS

Definition at line 149 of file itkMultiThreader.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual Print () to print information about the object * including superclasses. Typically not called by the user (use Print() * instead) but used in the hierarchical print process to combine the * output of several classes. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkMultiThreader.h

---