ITK  4.13.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
RealTimeClock
Wiki Examples:
Examples:
SphinxExamples/src/Core/Common/ComputeTimeBetweenPoints/Code.cxx.

Definition at line 44 of file itkTimeProbe.h.

Public Types

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

Public Member Functions

virtual TimeStampType GetInstantValue (void) const override
 
virtual const RealTimeClockGetRealTimeClock () const
 
 itkLegacyMacro (TimeStampType GetMeanTime(void) const)
 
 TimeProbe ()
 
virtual ~TimeProbe () override
 
- Public Member Functions inherited from itk::ResourceProbe< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType >
virtual void ExpandedReport (std::ostream &os=std::cout, bool printSystemInfo=true, bool printReportHead=true, bool useTabs=false)
 
virtual
RealTimeClock::TimeStampType 
GetMaximum () const
 
virtual
RealTimeClock::TimeStampType 
GetMean () const
 
virtual
RealTimeClock::TimeStampType 
GetMinimum () const
 
virtual std::string GetNameOfProbe () const
 
CountType GetNumberOfIteration () const
 
CountType GetNumberOfStarts () const
 
CountType GetNumberOfStops () const
 
virtual
RealTimeClock::TimeStampType 
GetStandardDeviation ()
 
virtual
RealTimeClock::TimeStampType 
GetStandardError ()
 
virtual
RealTimeClock::TimeStampType 
GetTotal () const
 
std::string GetType () const
 
std::string GetUnit () const
 
virtual void JSONReport (std::ostream &os=std::cout)
 
virtual void PrintJSONSystemInformation (std::ostream &os=std::cout)
 
virtual void PrintSystemInformation (std::ostream &os=std::cout)
 
virtual void Report (std::ostream &os=std::cout, bool printSystemInfo=true, bool printReportHead=true, bool useTabs=false)
 
virtual void Reset ()
 
 ResourceProbe (const std::string &type, const std::string &unit)
 
virtual void SetNameOfProbe (const char *nameOfProbe)
 
virtual void Start ()
 
virtual void Stop ()
 
virtual ~ResourceProbe ()
 

Private Attributes

RealTimeClock::Pointer m_RealTimeClock
 

Additional Inherited Members

- Protected Member Functions inherited from itk::ResourceProbe< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType >
virtual void GetSystemInformation ()
 
virtual void PrintExpandedReportHead (std::ostream &os=std::cout, bool useTabs=false)
 
void PrintJSONvar (std::ostream &os, const char *varName, T varValue, unsigned indent=4, bool comma=true)
 
virtual void PrintReportHead (std::ostream &os=std::cout, bool useTabs=false)
 
virtual void UpdateMinimumMaximumMeasuredValue (RealTimeClock::TimeStampTypevalue)
 

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 ( )

Constructor

virtual itk::TimeProbe::~TimeProbe ( )
overridevirtual

Destructor

Member Function Documentation

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

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 >.

virtual const RealTimeClock* itk::TimeProbe::GetRealTimeClock ( ) const
virtual

Get a handle to m_RealTimeClock.

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.

Deprecated:

Member Data Documentation

RealTimeClock::Pointer itk::TimeProbe::m_RealTimeClock
private

Definition at line 79 of file itkTimeProbe.h.


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