ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Attributes | List of all members
itk::TimeProbe Class Reference

#include <itkTimeProbe.h>

+ Inheritance diagram for itk::TimeProbe:
+ Collaboration diagram for itk::TimeProbe:

Detailed Description

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.

See Also
Wiki Examples:

Definition at line 44 of file itkTimeProbe.h.

Public Types

typedef unsigned long CountType
- Public Types inherited from itk::ResourceProbe< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType >
typedef SizeValueType CountType

Public Member Functions

GetInstantValue (void) const
 itkLegacyMacro (TimeStampType GetMeanTime(void) const)
 TimeProbe ()
virtual ~TimeProbe ()
- Public Member Functions inherited from itk::ResourceProbe< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType >
RealTimeClock::TimeStampType GetMean (void) const
CountType GetNumberOfStarts (void) const
CountType GetNumberOfStops (void) const
RealTimeClock::TimeStampType GetTotal (void) const
std::string GetType (void) const
std::string GetUnit (void) const
 ResourceProbe (const std::string &type, const std::string &unit)
void Start (void)
void Stop (void)
virtual ~ResourceProbe ()

Private Attributes

RealTimeClock::Pointer m_RealTimeClock

Member Typedef Documentation

typedef unsigned long itk::TimeProbe::CountType

Type for counting how many times the probe has been started and stopped.

Definition at line 51 of file itkTimeProbe.h.

Type for measuring time. See the RealTimeClock class for details on the precision and units of this clock signal

Definition at line 55 of file itkTimeProbe.h.

Constructor & Destructor Documentation

itk::TimeProbe::TimeProbe ( )


virtual itk::TimeProbe::~TimeProbe ( )


Member Function Documentation

virtual RealTimeClock::TimeStampType itk::TimeProbe::GetInstantValue ( void  ) const

Get the current time. Warning: the returned value is not the elapsed time since the last Start() call.

Implements itk::ResourceProbe< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType >.

itk::TimeProbe::itkLegacyMacro ( TimeStampType GetMeanTime(void)  const)

Returns the average times passed between the starts and stops of the probe. See the RealTimeClock for details on the precision and units of this time value. Obsolete method kept for backward compatibility, use Probe::GetMean() instead.


Member Data Documentation

RealTimeClock::Pointer itk::TimeProbe::m_RealTimeClock

Definition at line 79 of file itkTimeProbe.h.

The documentation for this class was generated from the following file: