Base class for SimpleITK classes based on ProcessObject. More...

#include <sitkProcessObject.h>

Inheritance diagram for itk::simple::ProcessObject:

Collaboration diagram for itk::simple::ProcessObject:

Classes
struct	EventCommand

Public Types
typedef ProcessObject	Self

Public Member Functions
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual std::string	GetName () const =0

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual std::string	ToString () const

virtual	~ProcessObject ()


virtual void	DebugOn ()

virtual void	DebugOff ()


virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)


virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

Static Public Member Functions
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)


static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()


static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()


static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

Protected Member Functions
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)


template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Private Member Functions
unsigned long	AddObserverToActiveProcessObject (EventCommand &e)

void	RemoveObserverFromActiveProcessObject (EventCommand &e)

Private Attributes
itk::ProcessObject *	m_ActiveProcess

std::list< EventCommand >	m_Commands

bool	m_Debug

unsigned int	m_NumberOfThreads

float	m_ProgressMeasurement

Friends
class	itk::simple::Command

Detailed Description

Base class for SimpleITK classes based on ProcessObject.

Examples:: FilterProgressReporting/FilterProgressReporting.cxx.

Definition at line 50 of file sitkProcessObject.h.

Member Typedef Documentation

typedef ProcessObject itk::simple::ProcessObject::Self

Definition at line 54 of file sitkProcessObject.h.

Constructor & Destructor Documentation

itk::simple::ProcessObject::ProcessObject ( )

Default Constructor that takes no arguments and initializes default parameters

virtual itk::simple::ProcessObject::~ProcessObject ( )

virtual

Default Destructor

Member Function Documentation

virtual void itk::simple::ProcessObject::Abort ( )

virtual

Sets an abort flag on the active process.

Requests the current active process to abort. Additional, progress or iteration event may occur. If aborted then, an AbortEvent should occur. The Progress should be set to 1.0 after aborting.

The expected behavior is that not exception should be throw out of this processes Execute method. Additionally, the results returned are valid but undefined content. The content may be only partially updated, uninitialized or the a of size zero.

If there is no active process the method has no effect.

virtual int itk::simple::ProcessObject::AddCommand	(	itk::simple::EventEnum	event,
		itk::simple::Command &	cmd
	)

virtual

Add a Command Object to observer the event.

The Command object's Execute method will be invoked when the internal ITK Object has the event. These events only occur during this ProcessObject's Execute method when the ITK filter is running. The command occurs in the same thread as this objects Execute methods was called in.

An internal reference is made between the Command and this ProcessObject which enable automatic removal of the command when deleted. This enables both object to exist as stack based object and be automatically cleaned up.

Unless specified otherwise, it's safe to get any value during execution. "Measurements" will have valid values only after the Execute method has returned. "Active Measurements" will have valid values during events, and access the underlying ITK object.

Deleting a command this object has during a command call-back will produce undefined behavior.

For more information see the page Commands and Events for SimpleITK.

Note: The return value is reserved for latter usage.

Examples:: DemonsRegistration1/DemonsRegistration1.cxx, DemonsRegistration2/DemonsRegistration2.cxx, FilterProgressReporting/FilterProgressReporting.cxx, ImageRegistrationMethod1/ImageRegistrationMethod1.cxx, ImageRegistrationMethod2/ImageRegistrationMethod2.cxx, ImageRegistrationMethodBSpline1/ImageRegistrationMethodBSpline1.cxx, ImageRegistrationMethodBSpline3/ImageRegistrationMethodBSpline3.cxx, and ImageRegistrationMethodDisplacement1/ImageRegistrationMethodDisplacement1.cxx.

virtual unsigned long itk::simple::ProcessObject::AddITKObserver	(	const itk::EventObject &	,
		itk::Command *
	)

protectedvirtual

Reimplemented in itk::simple::ImageRegistrationMethod.

unsigned long itk::simple::ProcessObject::AddObserverToActiveProcessObject ( EventCommand & e )

private

template<class TImageType >

static TImageType::ConstPointer itk::simple::ProcessObject::CastImageToITK ( const Image & img )

inlinestaticprotected

Definition at line 270 of file sitkProcessObject.h.

References itk::simple::Image::GetDimension(), itk::simple::Image::GetITKBase(), itk::simple::Image::GetPixelIDTypeAsString(), itk::simple::GetPixelIDValueAsString(), and sitkExceptionMacro.

template<class TImageType >

static Image itk::simple::ProcessObject::CastITKToImage ( TImageType * img )

inlinestaticprotected

Definition at line 288 of file sitkProcessObject.h.

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>

static Image itk::simple::ProcessObject::CastITKToImage ( itk::Image< TVector< TPixelType, VLength >, VImageDimension > * img )

inlinestaticprotected

Definition at line 296 of file sitkProcessObject.h.

References itk::simple::Image::CopyInformation(), and itk::simple::Image::GetNumberOfPixels().

virtual void itk::simple::ProcessObject::DebugOff ( )

virtual

Turn debugging output on/off.

Enabling debugging prints additional information to stdout about the execution of the internal filters.

virtual void itk::simple::ProcessObject::DebugOn ( )

virtual

Turn debugging output on/off.

Enabling debugging prints additional information to stdout about the execution of the internal filters.

virtual itk::ProcessObject* itk::simple::ProcessObject::GetActiveProcess ( )

protectedvirtual

virtual bool itk::simple::ProcessObject::GetDebug ( ) const

virtual

Get the value of the debug flag.

static double itk::simple::ProcessObject::GetGlobalDefaultCoordinateTolerance ( )

static

Access the global tolerance to determine congruent spaces.

The default tolerance is governed by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

static bool itk::simple::ProcessObject::GetGlobalDefaultDebug ( )

static

Get the value of the default debug flag.

static double itk::simple::ProcessObject::GetGlobalDefaultDirectionTolerance ( )

static

Access the global tolerance to determine congruent spaces.

The default tolerance is governed by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

static unsigned int itk::simple::ProcessObject::GetGlobalDefaultNumberOfThreads ( )

static

Set the number of threads that all new process objects are initialized with.

static bool itk::simple::ProcessObject::GetGlobalWarningDisplay ( )

static

Manage warnings produced by ITK.

Enabled by default, this parameter may enable printing of warnings indicating unstable state or parameters during execution. It is a global value set for all ITK filters and processes.

static const itk::EventObject& itk::simple::ProcessObject::GetITKEventObject ( EventEnum e )

staticprotected

virtual std::string itk::simple::ProcessObject::GetName ( ) const

pure virtual

return user readable name for the filter

virtual unsigned int itk::simple::ProcessObject::GetNumberOfThreads ( ) const

virtual

The number of threads used when executing a filter if the filter is multi-threaded

virtual float itk::simple::ProcessObject::GetProgress ( ) const

virtual

An Active Measurement of the progress of execution.

Get the execution progress of the current process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution (or aborted).

This is an Active Measurement so it can be accessed during Events during the execution.

static void itk::simple::ProcessObject::GlobalDefaultDebugOff ( )

static

static void itk::simple::ProcessObject::GlobalDefaultDebugOn ( )

static

Turn default debugging output value on/off.

This is the initial values used for new classes and procedural methods.

static void itk::simple::ProcessObject::GlobalWarningDisplayOff ( )

static

Manage warnings produced by ITK.

Enabled by default, this parameter may enable printing of warnings indicating unstable state or parameters during execution. It is a global value set for all ITK filters and processes.

static void itk::simple::ProcessObject::GlobalWarningDisplayOn ( )

static

Manage warnings produced by ITK.

Enabled by default, this parameter may enable printing of warnings indicating unstable state or parameters during execution. It is a global value set for all ITK filters and processes.

virtual bool itk::simple::ProcessObject::HasCommand ( itk::simple::EventEnum event ) const

virtual

Query of this object has any registered commands for event.

virtual void itk::simple::ProcessObject::OnActiveProcessDelete ( )

protectedvirtual

Reimplemented in itk::simple::ImageRegistrationMethod.

virtual void itk::simple::ProcessObject::onCommandDelete ( const itk::simple::Command * cmd )

protectedvirtual

virtual void itk::simple::ProcessObject::PreUpdate ( itk::ProcessObject * p )

protectedvirtual

Reimplemented in itk::simple::ImageRegistrationMethod.

virtual void itk::simple::ProcessObject::RemoveAllCommands ( )

virtual

Remove all registered commands.

Calling when this object is invoking anther command will produce undefined behavior.

virtual void itk::simple::ProcessObject::RemoveITKObserver ( EventCommand & e )

protectedvirtual

Reimplemented in itk::simple::ImageRegistrationMethod.

void itk::simple::ProcessObject::RemoveObserverFromActiveProcessObject ( EventCommand & e )

private

virtual void itk::simple::ProcessObject::SetDebug ( bool debugFlag )

virtual

Get the value of the debug flag.

static void itk::simple::ProcessObject::SetGlobalDefaultCoordinateTolerance ( double )

static

Access the global tolerance to determine congruent spaces.

The default tolerance is governed by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

static void itk::simple::ProcessObject::SetGlobalDefaultDebug ( bool debugFlag )

static

static void itk::simple::ProcessObject::SetGlobalDefaultDirectionTolerance ( double )

static

Access the global tolerance to determine congruent spaces.

The default tolerance is governed by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

static void itk::simple::ProcessObject::SetGlobalDefaultNumberOfThreads ( unsigned int n )

static

Set the number of threads that all new process objects are initialized with.

static void itk::simple::ProcessObject::SetGlobalWarningDisplay ( bool flag )

static

Manage warnings produced by ITK.

Enabled by default, this parameter may enable printing of warnings indicating unstable state or parameters during execution. It is a global value set for all ITK filters and processes.

virtual void itk::simple::ProcessObject::SetNumberOfThreads ( unsigned int n )

virtual

The number of threads used when executing a filter if the filter is multi-threaded

virtual std::string itk::simple::ProcessObject::ToString ( ) const

virtual

template<typename T >

static std::ostream& itk::simple::ProcessObject::ToStringHelper	(	std::ostream &	os,
		const T &	v
	)

inlinestaticprotected

Output operator to os with conversion to a printable type.

That is char types are presumed to be numbers, and converted to int.

Definition at line 328 of file sitkProcessObject.h.

static std::ostream& itk::simple::ProcessObject::ToStringHelper	(	std::ostream &	os,
		const char &	v
	)

staticprotected

Output operator to os with conversion to a printable type.

That is char types are presumed to be numbers, and converted to int.

static std::ostream& itk::simple::ProcessObject::ToStringHelper	(	std::ostream &	os,
		const signed char &	v
	)

staticprotected

Output operator to os with conversion to a printable type.

That is char types are presumed to be numbers, and converted to int.

static std::ostream& itk::simple::ProcessObject::ToStringHelper	(	std::ostream &	os,
		const unsigned char &	v
	)

staticprotected

Output operator to os with conversion to a printable type.

That is char types are presumed to be numbers, and converted to int.

Friends And Related Function Documentation

friend class itk::simple::Command

friend

Definition at line 262 of file sitkProcessObject.h.

Member Data Documentation

itk::ProcessObject* itk::simple::ProcessObject::m_ActiveProcess

private

Definition at line 358 of file sitkProcessObject.h.

std::list<EventCommand> itk::simple::ProcessObject::m_Commands

private

Definition at line 356 of file sitkProcessObject.h.

bool itk::simple::ProcessObject::m_Debug

private

Definition at line 352 of file sitkProcessObject.h.

unsigned int itk::simple::ProcessObject::m_NumberOfThreads

private

Definition at line 354 of file sitkProcessObject.h.

float itk::simple::ProcessObject::m_ProgressMeasurement

private

Definition at line 361 of file sitkProcessObject.h.

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

sitkProcessObject.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation