#include <itkProgressAccumulator.h>

Inheritance diagram for itk::ProgressAccumulator:

Collaboration diagram for itk::ProgressAccumulator:

Classes
struct	FilterRecord
Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef GenericFilterType::Pointer	GenericFilterPointer
typedef ProcessObject	GenericFilterType
typedef SmartPointer< Self >	Pointer
typedef ProgressAccumulator	Self
typedef Object	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual float	GetAccumulatedProgress () const
virtual const ProcessObject *	GetMiniPipelineFilter ()
virtual const char *	GetNameOfClass () const
void	RegisterInternalFilter (GenericFilterType *filter, float weight)
void	ResetFilterProgressAndKeepAccumulatedProgress ()
void	ResetProgress ()
virtual void	SetMiniPipelineFilter (ProcessObject *_arg)
void	UnregisterAllFilters ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &s, Indent indent) const
	ProgressAccumulator ()
virtual	~ProgressAccumulator ()
Private Types
typedef CommandType::Pointer	CommandPointer
typedef MemberCommand< Self >	CommandType
typedef std::vector< struct FilterRecord >	FilterRecordVector
Private Member Functions
void	ReportProgress (Object *object, const EventObject &event)
Private Attributes
float	m_AccumulatedProgress
float	m_BaseAccumulatedProgress
CommandPointer	m_CallbackCommand
FilterRecordVector	m_FilterRecord
GenericFilterPointer	m_MiniPipelineFilter

Detailed Description

Facilitates progress reporting for filters that wrap around multiple other filters.

This object allows a mini-pipeline filters to easily keep track of the progress performed by the internal filters. See DiscreteGaussianImageFilter.hxx for an implementation example.

See also:: DiscreteGaussianImageFilter

Definition at line 40 of file itkProgressAccumulator.h.

Member Typedef Documentation

typedef CommandType::Pointer itk::ProgressAccumulator::CommandPointer [private]

Definition at line 97 of file itkProgressAccumulator.h.

typedef MemberCommand< Self > itk::ProgressAccumulator::CommandType [private]

Command for observing progress of pipeline filters

Definition at line 96 of file itkProgressAccumulator.h.

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

Reimplemented from itk::Object.

Definition at line 48 of file itkProgressAccumulator.h.

typedef std::vector< struct FilterRecord > itk::ProgressAccumulator::FilterRecordVector [private]

An array of record structures

Definition at line 122 of file itkProgressAccumulator.h.

typedef GenericFilterType::Pointer itk::ProgressAccumulator::GenericFilterPointer

Definition at line 52 of file itkProgressAccumulator.h.

typedef ProcessObject itk::ProgressAccumulator::GenericFilterType

Typedef for inputting filters

Definition at line 51 of file itkProgressAccumulator.h.

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

Reimplemented from itk::Object.

Definition at line 47 of file itkProgressAccumulator.h.

typedef ProgressAccumulator itk::ProgressAccumulator::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 45 of file itkProgressAccumulator.h.

typedef Object itk::ProgressAccumulator::Superclass

Reimplemented from itk::Object.

Definition at line 46 of file itkProgressAccumulator.h.

Constructor & Destructor Documentation

itk::ProgressAccumulator::ProgressAccumulator ( ) [protected]

virtual itk::ProgressAccumulator::~ProgressAccumulator ( ) [protected, virtual]

Member Function Documentation

virtual::itk::LightObject::Pointer itk::ProgressAccumulator::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.

virtual float itk::ProgressAccumulator::GetAccumulatedProgress ( ) const [virtual]

Get the total progress accumulated by this object

virtual const ProcessObject* itk::ProgressAccumulator::GetMiniPipelineFilter ( ) [virtual]

Set the mini-pipeline filter

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

Runtime information support.

Reimplemented from itk::Object.

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

Standard New method.

Reimplemented from itk::Object.

void itk::ProgressAccumulator::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.