Implements iterations tracking for a filter. More...
#include <itkIterationReporter.h>
Public Member Functions | |
IterationReporter (ProcessObject *filter, int threadId, unsigned long stepsPerUpdate=100) | |
~IterationReporter () | |
| |
ProcessObject * | m_Filter |
int | m_ThreadId |
unsigned long | m_StepsPerUpdate |
unsigned long | m_StepsBeforeUpdate |
void | CompletedStep () |
Implements iterations tracking for a filter.
This is a utility class for use by filter implementations in GenerateData() and ThreadedGenerateData().
This class is intended to be used in iterative filter for which a progress cannot be stablished. These filters run until an stopping criterion is reached and it is not possible to anticipate how long it will take to get to the stopping point.
This class is constructed before entering the iteration loop in the filter. The CompletedStep() method should be called at every iteration. The reporter will count the number of calls and will invoke an IterationEvent every certain number of calls. The default period is 100.
Example usage:
IterationReporter iteration(this, threadId, 100);
for( each pixel ) { ... iteration.CompletedStep(); }
When used in a non-threaded filter, the threadId argument should be 0.
Definition at line 54 of file itkIterationReporter.h.
itk::IterationReporter::IterationReporter | ( | ProcessObject * | filter, | |
int | threadId, | |||
unsigned long | stepsPerUpdate = 100 | |||
) |
Constructor sets progress to 0 because the filter is starting.
itk::IterationReporter::~IterationReporter | ( | ) | [inline] |
Destructor
Definition at line 62 of file itkIterationReporter.h.
void itk::IterationReporter::CompletedStep | ( | ) | [inline] |
Called by a filter once per iteration.
Definition at line 65 of file itkIterationReporter.h.
ProcessObject* itk::IterationReporter::m_Filter [protected] |
Called by a filter once per iteration.
Definition at line 78 of file itkIterationReporter.h.
unsigned long itk::IterationReporter::m_StepsBeforeUpdate [protected] |
Called by a filter once per iteration.
Definition at line 81 of file itkIterationReporter.h.
unsigned long itk::IterationReporter::m_StepsPerUpdate [protected] |
Called by a filter once per iteration.
Definition at line 80 of file itkIterationReporter.h.
int itk::IterationReporter::m_ThreadId [protected] |
Called by a filter once per iteration.
Definition at line 79 of file itkIterationReporter.h.