1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile: itkIterationReporter.h,v $
Language: C++
Date: $Date: 2006-02-06 22:01:56 $
Version: $Revision: 1.4 $
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkIterationReporter_h
#define __itkIterationReporter_h
#include "itkProcessObject.h"
namespace itk
{
/** \class IterationReporter
* \brief 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.
*/
class ITKCommon_EXPORT IterationReporter
{
public:
/** Constructor sets progress to 0 because the filter is starting. */
IterationReporter(ProcessObject* filter, int threadId,
unsigned long stepsPerUpdate = 100);
/** Destructor */
~IterationReporter() {};
/** Called by a filter once per iteration. */
void CompletedStep()
{
// Inline implementation for efficiency.
// We don't need to test for thread id 0 here because the
// constructor sets m_StepsBeforeUpdate to a value larger than
// the number of pixels for threads other than 0.
if(--m_StepsBeforeUpdate == 0)
{
m_StepsBeforeUpdate = m_StepsPerUpdate;
m_Filter->InvokeEvent( IterationEvent() );
}
}
protected:
ProcessObject* m_Filter;
int m_ThreadId;
unsigned long m_StepsPerUpdate;
unsigned long m_StepsBeforeUpdate;
};
} // end namespace itk
#endif
|
