ITK  5.4.0
Insight Toolkit
Public Member Functions | Protected Attributes | List of all members
itk::ProgressReporter Class Reference

#include <itkProgressReporter.h>

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 )

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:

Definition at line 60 of file itkProgressReporter.h.

+ Collaboration diagram for itk::ProgressReporter:

Public Member Functions

 ProgressReporter (ProcessObject *filter, ThreadIdType threadId, SizeValueType numberOfPixels, SizeValueType numberOfUpdates=100, float initialProgress=0.0f, float progressWeight=1.0f)
 ~ProgressReporter ()
void CheckAbortGenerateData ()
void CompletedPixel ()

Protected Attributes

SizeValueType m_CurrentPixel
float m_InitialProgress
float m_InverseNumberOfPixels
SizeValueType m_PixelsBeforeUpdate
SizeValueType m_PixelsPerUpdate
float m_ProgressWeight
ThreadIdType m_ThreadId

Constructor & Destructor Documentation

◆ ProgressReporter()

itk::ProgressReporter::ProgressReporter ( ProcessObject filter,
ThreadIdType  threadId,
SizeValueType  numberOfPixels,
SizeValueType  numberOfUpdates = 100,
float  initialProgress = 0.0f,
float  progressWeight = 1.0f 

Constructor sets progress to 0 because the filter is starting.

◆ ~ProgressReporter()

itk::ProgressReporter::~ProgressReporter ( )

Destructor sets progress to 1 because the filter has finished.

Member Function Documentation

◆ CheckAbortGenerateData()

void itk::ProgressReporter::CheckAbortGenerateData ( )

Check if the filter has the ProcessObject::AbortGenerateData flag set. If true, then a ProcessAborted exception will be thrown.

Definition at line 80 of file itkProgressReporter.h.

References itk::Math::e.

◆ CompletedPixel()

void itk::ProgressReporter::CompletedPixel ( )

Member Data Documentation

◆ m_CurrentPixel

SizeValueType itk::ProgressReporter::m_CurrentPixel

Definition at line 119 of file itkProgressReporter.h.

◆ m_Filter

ProcessObject* itk::ProgressReporter::m_Filter

Definition at line 116 of file itkProgressReporter.h.

◆ m_InitialProgress

float itk::ProgressReporter::m_InitialProgress

Definition at line 122 of file itkProgressReporter.h.

◆ m_InverseNumberOfPixels

float itk::ProgressReporter::m_InverseNumberOfPixels

Definition at line 118 of file itkProgressReporter.h.

◆ m_PixelsBeforeUpdate

SizeValueType itk::ProgressReporter::m_PixelsBeforeUpdate

Definition at line 121 of file itkProgressReporter.h.

◆ m_PixelsPerUpdate

SizeValueType itk::ProgressReporter::m_PixelsPerUpdate

Definition at line 120 of file itkProgressReporter.h.

◆ m_ProgressWeight

float itk::ProgressReporter::m_ProgressWeight

Definition at line 123 of file itkProgressReporter.h.

◆ m_ThreadId

ThreadIdType itk::ProgressReporter::m_ThreadId

Definition at line 117 of file itkProgressReporter.h.

The documentation for this class was generated from the following file:
ProgressReporter(ProcessObject *filter, ThreadIdType threadId, SizeValueType numberOfPixels, SizeValueType numberOfUpdates=100, float initialProgress=0.0f, float progressWeight=1.0f)