Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::ProgressAccumulator Class Reference

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

#include <itkProgressAccumulator.h>

Inheritance diagram for itk::ProgressAccumulator:

Inheritance graph
[legend]
Collaboration diagram for itk::ProgressAccumulator:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ProgressAccumulator Self
typedef Object Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef ProcessObject GenericFilterType
typedef GenericFilterType::Pointer GenericFilterPointer

Public Member Functions

virtual const char * GetClassName () const
virtual float GetAccumulatedProgress ()
virtual void SetMiniPipelineFilter (ProcessObject *_arg)
virtual const ProcessObjectGetMiniPipelineFilter ()
void RegisterInternalFilter (GenericFilterType *filter, float weight)
void UnregisterAllFilters ()
void ResetProgress ()
void ResetFilterProgressAndKeepAccumulatedProgress ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

 ProgressAccumulator ()
virtual ~ProgressAccumulator ()
void PrintSelf (std::ostream &s, Indent indent) const

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.txx for an implementation example.

See also:
DiscreteGaussianImageFilter

Definition at line 39 of file itkProgressAccumulator.h.


Member Typedef Documentation

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

Reimplemented from itk::Object.

Definition at line 47 of file itkProgressAccumulator.h.

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

Definition at line 51 of file itkProgressAccumulator.h.

typedef ProcessObject itk::ProgressAccumulator::GenericFilterType
 

Typedef for inputting filters Definition at line 50 of file itkProgressAccumulator.h.

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

Reimplemented from itk::Object.

Definition at line 46 of file itkProgressAccumulator.h.

typedef ProgressAccumulator itk::ProgressAccumulator::Self
 

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 44 of file itkProgressAccumulator.h.

typedef Object itk::ProgressAccumulator::Superclass
 

Reimplemented from itk::Object.

Definition at line 45 of file itkProgressAccumulator.h.


Constructor & Destructor Documentation

itk::ProgressAccumulator::ProgressAccumulator  )  [protected]
 

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


Member Function Documentation

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

Get the total progress accumulated by this object

virtual const char* itk::ProgressAccumulator::GetClassName  )  const [virtual]
 

Runtime information support.

Reimplemented from itk::Object.

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

Set the mini-pipeline filter

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

Standard New method.

Reimplemented from itk::Object.

void itk::ProgressAccumulator::PrintSelf std::ostream &  s,
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.

void itk::ProgressAccumulator::RegisterInternalFilter GenericFilterType filter,
float  weight
 

Register a filter with the progress accumulator and specify the fraction of the overall progress associated with this filter

void itk::ProgressAccumulator::ResetFilterProgressAndKeepAccumulatedProgress  ) 
 

Reset the progress accumulator. This method should be called in the beginning of the GenerateData() method in the mini-pipeline filter.

void itk::ProgressAccumulator::ResetProgress  ) 
 

Reset the progress accumulator. This method should be called in the beginning of the GenerateData() method in the mini-pipeline filter.

virtual void itk::ProgressAccumulator::SetMiniPipelineFilter ProcessObject _arg  )  [virtual]
 

Set the mini-pipeline filter

void itk::ProgressAccumulator::UnregisterAllFilters  ) 
 

Unregister all filters that have been registered with this object


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 02:59:20 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000