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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkTimeProbe_h
#define itkTimeProbe_h
#include "itkConfigure.h"
#include "itkResourceProbe.h"
#include "itkRealTimeClock.h"
namespace itk
{
/** \class TimeProbe
*
* \brief Computes the time passed between two points in code.
*
* This class allows the user to trace the time passed between the execution
* of two pieces of code. It can be started and stopped in order to evaluate
* the execution over multiple passes. The values of time are taken from the
* RealTimeClock.
*
* \sa RealTimeClock
*
* \ingroup ITKCommon
*
* \sphinx
* \sphinxexample{Core/Common/ComputeTimeBetweenPoints,Compute Time Between Points}
* \endsphinx
*/
class ITKCommon_EXPORT TimeProbe : public ResourceProbe<RealTimeClock::TimeStampType, RealTimeClock::TimeStampType>
{
public:
using Superclass = ResourceProbe<RealTimeClock::TimeStampType, RealTimeClock::TimeStampType>;
/** Type for counting how many times the probe has been started and stopped.
*/
using CountType = unsigned long;
/** Type for measuring time. See the RealTimeClock class for details on the
* precision and units of this clock signal */
using TimeStampType = RealTimeClock::TimeStampType;
public:
/** Constructor */
TimeProbe();
/** Destructor */
~TimeProbe() override;
void
Print(std::ostream & os, Indent indent) const override;
/** Get the current time.
* Warning: the returned value is not the elapsed time since the last Start() call.
*/
TimeStampType
GetInstantValue() const override;
/** Get a handle to m_RealTimeClock. */
itkGetConstObjectMacro(RealTimeClock, RealTimeClock);
private:
RealTimeClock::Pointer m_RealTimeClock{};
};
} // end namespace itk
#endif // itkTimeProbe_h
|
