ITK  5.4.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
itk::ProgressAccumulator Class Reference

#include <itkProgressAccumulator.h>

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.

+ Inheritance diagram for itk::ProgressAccumulator:
+ Collaboration diagram for itk::ProgressAccumulator:

Classes

struct  FilterRecord
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using GenericFilterPointer = GenericFilterType::Pointer
 
using GenericFilterType = ProcessObject
 
using Pointer = SmartPointer< Self >
 
using Self = ProgressAccumulator
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual float GetAccumulatedProgress () const
 
virtual ProcessObjectGetModifiableMiniPipelineFilter ()
 
const char * GetNameOfClass () const override
 
void RegisterInternalFilter (GenericFilterType *filter, float weight)
 
virtual void SetMiniPipelineFilter (ProcessObject *_arg)
 
void UnregisterAllFilters ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProgressAccumulator ()
 
 ~ProgressAccumulator () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Types

using CommandPointer = CommandType::Pointer
 
using CommandType = MemberCommand< Self >
 
using FilterRecordVector = std::vector< struct FilterRecord >
 

Private Member Functions

void ReportProgress (Object *who, const EventObject &event)
 

Private Attributes

float m_AccumulatedProgress {}
 
float m_BaseAccumulatedProgress {}
 
CommandPointer m_CallbackCommand {}
 
FilterRecordVector m_FilterRecord {}
 
GenericFilterPointer m_MiniPipelineFilter {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ CommandPointer

Definition at line 128 of file itkProgressAccumulator.h.

◆ CommandType

Command for observing progress of pipeline filters

Definition at line 127 of file itkProgressAccumulator.h.

◆ ConstPointer

Definition at line 48 of file itkProgressAccumulator.h.

◆ FilterRecordVector

using itk::ProgressAccumulator::FilterRecordVector = std::vector<struct FilterRecord>
private

An array of record structures

Definition at line 154 of file itkProgressAccumulator.h.

◆ GenericFilterPointer

Definition at line 52 of file itkProgressAccumulator.h.

◆ GenericFilterType

Typedef for inputting filters

Definition at line 51 of file itkProgressAccumulator.h.

◆ Pointer

Definition at line 47 of file itkProgressAccumulator.h.

◆ Self

Standard class type aliases.

Definition at line 45 of file itkProgressAccumulator.h.

◆ Superclass

Definition at line 46 of file itkProgressAccumulator.h.

Constructor & Destructor Documentation

◆ ProgressAccumulator()

itk::ProgressAccumulator::ProgressAccumulator ( )
protected
Deprecated:
Reset the progress accumulator. This method should not be necessary because this functionality is already present in the filter constructor.
Deprecated:
Reset the filter progress but keep the accumulated progress. This method is deprecated because the ProgressAccumulator now internally checks if a filter has been restarted and updates the accumulated progress automatically. This method also used to have the unfortunate side effect of forcing filters to rerun even if their parameters and input had not changed. This is because it called SetProgress(0) on the filters, which triggered a ModifiedTime and thus caused the filters to rerun. To avoid this behavior, the implementation of this method is now empty.

◆ ~ProgressAccumulator()

itk::ProgressAccumulator::~ProgressAccumulator ( )
overrideprotected

Member Function Documentation

◆ GetAccumulatedProgress()

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

Get the total progress accumulated by this object

◆ GetModifiableMiniPipelineFilter()

virtual ProcessObject* itk::ProgressAccumulator::GetModifiableMiniPipelineFilter ( )
virtual

Set the mini-pipeline filter

◆ GetNameOfClass()

const char* itk::ProgressAccumulator::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

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

Standard New method.

◆ PrintSelf()

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

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.

◆ RegisterInternalFilter()

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. The sum of the weights for all filters that are registered should be 1. However, if streaming is used, the weight should be divided by the number of streams because each stream will reset the filter after capturing its progress. For example, if the desired weight of a filter is 0.4, but it is streamed into 4 streams, the weight should be 0.1. The ProgressAccumulator will then ensure that each of the 4 runs of this filter will add 0.1 to the filter's progress.

◆ ReportProgress()

void itk::ProgressAccumulator::ReportProgress ( Object who,
const EventObject event 
)
private

A callback function that is called by the progressing filters

◆ SetMiniPipelineFilter()

virtual void itk::ProgressAccumulator::SetMiniPipelineFilter ( ProcessObject _arg)
virtual

Set the mini-pipeline filter

◆ UnregisterAllFilters()

void itk::ProgressAccumulator::UnregisterAllFilters ( )

Unregister all filters that have been registered with this object

Member Data Documentation

◆ m_AccumulatedProgress

float itk::ProgressAccumulator::m_AccumulatedProgress {}
private

The total accumulated progress

Definition at line 157 of file itkProgressAccumulator.h.

◆ m_BaseAccumulatedProgress

float itk::ProgressAccumulator::m_BaseAccumulatedProgress {}
private

The total accumulated progress for multiple runs of the mini-pipeline

Definition at line 160 of file itkProgressAccumulator.h.

◆ m_CallbackCommand

CommandPointer itk::ProgressAccumulator::m_CallbackCommand {}
private

The callback command

Definition at line 169 of file itkProgressAccumulator.h.

◆ m_FilterRecord

FilterRecordVector itk::ProgressAccumulator::m_FilterRecord {}
private

A list of progress proportions of the different filters in the pipeline

Definition at line 166 of file itkProgressAccumulator.h.

◆ m_MiniPipelineFilter

GenericFilterPointer itk::ProgressAccumulator::m_MiniPipelineFilter {}
private

The client mini-pipeline filter

Definition at line 151 of file itkProgressAccumulator.h.


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