Main Page
Groups
Namespace List
Class Hierarchy
Alphabetical List
Compound List
File
List
Namespace Members
Compound Members
File Members
Concepts
itk::ProgressReporter Class Reference
Implements progress tracking for a filter.
More...
#include <itkProgressReporter.h>
Collaboration diagram for itk::ProgressReporter:
[legend]List of all members.
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:
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 |
|
) |
|
|
|
|
Constructor sets progress to 0 because the filter is starting. |
|
|
Destructor sets progress to 1 because the filter has finished. |
Member Function Documentation
| void itk::ProgressReporter::CompletedPixel |
( |
|
) |
[inline] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
Generated at Sun Apr 1 03:12:38 2007 for ITK by 
1.3.8 written by Dimitri van Heesch,
© 1997-2000