Implements progress tracking for a filter. More...

#include <itkProgressReporter.h>

Collaboration diagram for itk::ProgressReporter:

Public Member Functions
	ProgressReporter (ProcessObject *filter, int threadId, unsigned long numberOfPixels, unsigned long numberOfUpdates=100, float initialProgress=0.0f, float progressWeight=1.0f)
	~ProgressReporter ()


void	CompletedPixel ()
Protected Attributes
unsigned long	m_CurrentPixel
ProcessObject *	m_Filter
float	m_InitialProgress
float	m_InverseNumberOfPixels
unsigned long	m_PixelsBeforeUpdate
unsigned long	m_PixelsPerUpdate
float	m_ProgressWeight
int	m_ThreadId

Detailed Description

Implements progress tracking for a filter.

This is a utility class for use by filter implementations in GenerateData() and ThreadedGenerateData().

The class constructor sets the progress to 0, and the destructor sets it to 1. In between, there should be one call to CompletedPixel() per pixel. The reporter will automatically update the filter's progress at an interval resulting in the specified number of updates. The default number of updates is 100.

Example usage:

   ProgressReporter progress(this, threadId,
                             threadRegion.GetNumberOfPixels(), 100);
   for( each pixel )
     {
     ...
     progress.CompletedPixel();
     }

When used in a non-threaded filter, the threadId argument should be 0.

See also:

This class is a tool for filter implementers to equip a filter to report on its progress. For information on how to acquire this progress information, see:

ProcessObject::ReportProgress()
Object::AddObserver()

Definition at line 58 of file itkProgressReporter.h.

Constructor & Destructor Documentation

itk::ProgressReporter::ProgressReporter	(	ProcessObject *	filter,
		int	threadId,
		unsigned long	numberOfPixels,
		unsigned long	numberOfUpdates = `100`,
		float	initialProgress = `0.0f`,
		float	progressWeight = `1.0f`
	)