itk::WatershedMiniPipelineProgressCommand Class Reference

#include <itkWatershedMiniPipelineProgressCommand.h>

Inheritance diagram for itk::WatershedMiniPipelineProgressCommand:

Collaboration diagram for itk::WatershedMiniPipelineProgressCommand:

List of all members.

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 int GetReferenceCount () const

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

virtual void Modified () const

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)

virtual void SetReferenceCount (int)

virtual void UnRegister () const

unsigned long AddObserver (const EventObject &event, Command *) const

unsigned long AddObserver (const EventObject &event, Command *)

void Execute (const Object *caller, const EventObject &event)

void Execute (Object *caller, const EventObject &event)

virtual double GetCount () const

virtual void SetCount (double _arg)

const ProcessObject * GetFilter ()

void SetFilter (ProcessObject *p)

virtual double GetNumberOfFilters () const

virtual void SetNumberOfFilters (double _arg)

Static Public Member Functions

static void BreakOnError ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

bool PrintObservers (std::ostream &os, Indent indent) const

void PrintSelf (std::ostream &os, Indent indent) const

WatershedMiniPipelineProgressCommand ()

virtual ~WatershedMiniPipelineProgressCommand ()

virtual void PrintHeader (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

typedef itk::SmartPointer
< const Self > ConstPointer

typedef itk::SmartPointer< Self > Pointer

typedef
WatershedMiniPipelineProgressCommand Self

typedef Command Superclass

virtual const char * GetNameOfClass () const

static Pointer New ()

Detailed Description

A specialized Command object for updating the progress of a MiniPipeline. Follows the progress of a series of filters and calls UpdateProgress on another filter (i.e. the filter implementing the mini-pipeline).

Definition at line 30 of file itkWatershedMiniPipelineProgressCommand.h.

Member Typedef Documentation

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

Smart pointer declaration methods

Reimplemented from itk::Command.

Definition at line 37 of file itkWatershedMiniPipelineProgressCommand.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

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

Smart pointer declaration methods

Reimplemented from itk::Command.

Definition at line 36 of file itkWatershedMiniPipelineProgressCommand.h.

typedef WatershedMiniPipelineProgressCommand itk::WatershedMiniPipelineProgressCommand::Self

Smart pointer declaration methods

Reimplemented from itk::Command.

Definition at line 34 of file itkWatershedMiniPipelineProgressCommand.h.

typedef Command itk::WatershedMiniPipelineProgressCommand::Superclass

Smart pointer declaration methods

Reimplemented from itk::Command.

Definition at line 35 of file itkWatershedMiniPipelineProgressCommand.h.

Constructor & Destructor Documentation

itk::WatershedMiniPipelineProgressCommand::WatershedMiniPipelineProgressCommand ( ) [inline, protected]

Definition at line 67 of file itkWatershedMiniPipelineProgressCommand.h.

virtual itk::WatershedMiniPipelineProgressCommand::~WatershedMiniPipelineProgressCommand ( ) [inline, protected, virtual]

Definition at line 69 of file itkWatershedMiniPipelineProgressCommand.h.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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.

void itk::WatershedMiniPipelineProgressCommand::Execute	(	const Object *	caller,
		const EventObject &	event
	)			`[virtual]`

Standard Command virtual methods

Implements itk::Command.

void itk::WatershedMiniPipelineProgressCommand::Execute	(	Object *	caller,
		const EventObject &	event
	)			`[virtual]`

Standard Command virtual methods

Implements itk::Command.

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.

virtual double itk::WatershedMiniPipelineProgressCommand::GetCount ( ) const [virtual]

Set/Get the base count for stepping through filter progress values

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

Get the value of the debug flag.

const ProcessObject* itk::WatershedMiniPipelineProgressCommand::GetFilter ( ) [inline]

Set/Get the filter whose UpdateProgress will be set by this command object

Definition at line 51 of file itkWatershedMiniPipelineProgressCommand.h.

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

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

Smart pointer declaration methods

Reimplemented from itk::Command.

virtual double itk::WatershedMiniPipelineProgressCommand::GetNumberOfFilters ( ) const [virtual]

Set/Get the number of filters that this command will expect to be observing

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

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::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

Smart pointer declaration methods

Reimplemented from itk::Object.

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

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

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

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.

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

void itk::WatershedMiniPipelineProgressCommand::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]`

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.

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.

virtual void itk::WatershedMiniPipelineProgressCommand::SetCount ( double _arg ) [virtual]

Set/Get the base count for stepping through filter progress values

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

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

void itk::WatershedMiniPipelineProgressCommand::SetFilter ( ProcessObject * p ) [inline]

Set/Get the filter whose UpdateProgress will be set by this command object

Definition at line 49 of file itkWatershedMiniPipelineProgressCommand.h.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

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

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

Returns:: Set the MetaDataDictionary

virtual void itk::WatershedMiniPipelineProgressCommand::SetNumberOfFilters ( double _arg ) [virtual]

Set/Get the number of filters that this command will expect to be observing

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Member Data Documentation

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

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

itkWatershedMiniPipelineProgressCommand.h


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 int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
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)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

void	Execute (const Object *caller, const EventObject &event)
void	Execute (Object *caller, const EventObject &event)

virtual double	GetCount () const
virtual void	SetCount (double _arg)

const ProcessObject *	GetFilter ()
void	SetFilter (ProcessObject *p)

virtual double	GetNumberOfFilters () const
virtual void	SetNumberOfFilters (double _arg)
Static Public Member Functions
static void	BreakOnError ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	WatershedMiniPipelineProgressCommand ()
virtual	~WatershedMiniPipelineProgressCommand ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
typedef itk::SmartPointer < const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef WatershedMiniPipelineProgressCommand	Self
typedef Command	Superclass
virtual const char *	GetNameOfClass () const
static Pointer	New ()