#include <itkIterationReporter.h>

Collaboration diagram for itk::IterationReporter:

Public Member Functions
	IterationReporter (ProcessObject *filter, ThreadIdType threadId, unsigned long stepsPerUpdate=100)

	~IterationReporter ()=default

ProcessObject *	m_Filter

ThreadIdType	m_ThreadId

unsigned long	m_StepsPerUpdate

unsigned long	m_StepsBeforeUpdate

void	CompletedStep ()

Detailed Description

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 established. 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 55 of file itkIterationReporter.h.

Constructor & Destructor Documentation

◆ IterationReporter()

itk::IterationReporter::IterationReporter	(	ProcessObject *	filter,
		ThreadIdType	threadId,
		unsigned long	stepsPerUpdate = `100`
	)

Constructor sets progress to 0 because the filter is starting.

◆ ~IterationReporter()

itk::IterationReporter::~IterationReporter ( )

default

Destructor