itk::TimeProbe Class Reference

#include <itkTimeProbe.h>

Inheritance diagram for itk::TimeProbe:

[legend]Collaboration diagram for itk::TimeProbe:

[legend]List of all members.

---

Detailed Description

Class for computing the time passed between two points in the 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

Examples:

Testing/Code/Common/itkVectorImageTest.cxx.

Definition at line 42 of file Common/itkTimeProbe.h.

Public Types
typedef unsigned long	CountType
typedef unsigned long	CountType
typedef RealTimeClock::TimeStampType	TimeStampType
typedef RealTimeClock::TimeStampType	TimeStampType
Public Member Functions
virtual RealTimeClock::TimeStampType	GetInstantValue (void) const
MeanType	GetMean (void) const
TimeStampType	GetMeanTime (void) const
TimeStampType	GetMeanTime (void) const
CountType	GetNumberOfStarts (void) const
CountType	GetNumberOfStops (void) const
ValueType	GetTotal (void) const
std::string	GetType (void) const
std::string	GetUnit (void) const
void	Start (void)
void	Stop (void)
	TimeProbe ()
	TimeProbe ()
virtual	~TimeProbe ()
	~TimeProbe ()

---

Member Typedef Documentation

typedef unsigned long itk::TimeProbe::CountType

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

Reimplemented from itk::Probe< ValueType, MeanType >.

Definition at line 44 of file Review/itkTimeProbe.h.

typedef unsigned long itk::TimeProbe::CountType

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

Reimplemented from itk::Probe< ValueType, MeanType >.

Definition at line 48 of file Common/itkTimeProbe.h.

typedef RealTimeClock::TimeStampType itk::TimeProbe::TimeStampType

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

Definition at line 48 of file Review/itkTimeProbe.h.

typedef RealTimeClock::TimeStampType itk::TimeProbe::TimeStampType

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

Definition at line 52 of file Common/itkTimeProbe.h.

---

Constructor & Destructor Documentation

itk::TimeProbe::TimeProbe

(

)

Constructor

itk::TimeProbe::~TimeProbe

(

)

Destructor

itk::TimeProbe::TimeProbe

(

)

Constructor

virtual itk::TimeProbe::~TimeProbe

(

)

[virtual]

Destructor

---

Member Function Documentation

virtual RealTimeClock::TimeStampType itk::TimeProbe::GetInstantValue

(

void

)

const [virtual]

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

Implements itk::Probe< ValueType, MeanType >.

template<class ValueType, class MeanType>

MeanType itk::Probe< ValueType, MeanType >::GetMean

(

void

)

const [inherited]

Returns the average value changes between the starts and stops of the probe. Stop() has to be called at least once, returns 0 otherwise.

TimeStampType itk::TimeProbe::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.

TimeStampType itk::TimeProbe::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.

Examples:

Testing/Code/Common/itkVectorImageTest.cxx.

Referenced by itk::XMLFilterWatcher::EndFilter().

CountType itk::TimeProbe::GetNumberOfStarts

(

void

)

const

Returns the number of times that the probe has been started.

Reimplemented from itk::Probe< ValueType, MeanType >.

CountType itk::TimeProbe::GetNumberOfStops

(

void

)

const

Returns the number of times that the probe has been stopped.

Reimplemented from itk::Probe< ValueType, MeanType >.

template<class ValueType, class MeanType>

ValueType itk::Probe< ValueType, MeanType >::GetTotal

(

void

)

const [inherited]

Returns the accumulated value changes between the starts and stops of the probe

template<class ValueType, class MeanType>

std::string itk::Probe< ValueType, MeanType >::GetType

(

void

)

const [inherited]

Returns the type probed value

template<class ValueType, class MeanType>

std::string itk::Probe< ValueType, MeanType >::GetUnit

(

void

)

const [inherited]

Returns the unit probed value

void itk::TimeProbe::Start

(

void

)

Start counting the time

Reimplemented from itk::Probe< ValueType, MeanType >.

Examples:

Testing/Code/Common/itkVectorImageTest.cxx.

Referenced by itk::XMLFilterWatcher::StartFilter().

void itk::TimeProbe::Stop

(

void

)

Stop counting the time

Reimplemented from itk::Probe< ValueType, MeanType >.

Examples:

Testing/Code/Common/itkVectorImageTest.cxx.

Referenced by itk::XMLFilterWatcher::EndFilter().

---

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

• Common/itkTimeProbe.h
• Review/itkTimeProbe.h

---