cv::TickMeter Class Reference

a Class to measure passing time. More...

#include <opencv2/core/utility.hpp>

Public Member Functions
	TickMeter ()
	the default constructor More...
double	getAvgTimeMilli () const
	returns average time in milliseconds More...
double	getAvgTimeSec () const
	returns average time in seconds More...
int64	getCounter () const
	returns internal counter value. More...
double	getFPS () const
	returns average FPS (frames per second) value. More...
double	getTimeMicro () const
	returns passed time in microseconds. More...
double	getTimeMilli () const
	returns passed time in milliseconds. More...
double	getTimeSec () const
	returns passed time in seconds. More...
int64	getTimeTicks () const
	returns counted ticks. More...
void	reset ()
	resets internal values. More...
void	start ()
	starts counting ticks. More...
void	stop ()
	stops counting ticks. More...

Detailed Description

a Class to measure passing time.

The class computes passing time by counting the number of ticks per second. That is, the following code computes the execution time in seconds:

        TickMeter tm;
        tm.start();
        // do something ...
        tm.stop();
        cout << "Total time: " << tm.getTimeSec() << endl;

It is also possible to compute the average time over multiple runs:

        TickMeter tm;
        for (int i = 0; i < COUNT; i++)
        {
            tm.start();
            // do something ...
            tm.stop();
        }
        cout << "Average time per iteration in seconds: " << tm.getAvgTimeSec() << endl;
        cout << "Average FPS: " << tm.getFPS() << endl;

See also

getTickCount, getTickFrequency

Examples:

samples/dnn/object_detection.cpp, and samples/dnn/text_detection.cpp.

Constructor & Destructor Documentation

TickMeter()

cv::TickMeter::TickMeter ( )

inline

the default constructor

Member Function Documentation

getAvgTimeMilli()

double cv::TickMeter::getAvgTimeMilli ( ) const

inline

Python:
	cv.TickMeter.getAvgTimeMilli(		) ->	retval

returns average time in milliseconds

getAvgTimeSec()

double cv::TickMeter::getAvgTimeSec ( ) const

inline

Python:
	cv.TickMeter.getAvgTimeSec(		) ->	retval

returns average time in seconds

getCounter()

int64 cv::TickMeter::getCounter ( ) const

inline

Python:
	cv.TickMeter.getCounter(		) ->	retval

returns internal counter value.

getFPS()

double cv::TickMeter::getFPS ( ) const

inline

Python:
	cv.TickMeter.getFPS(		) ->	retval

returns average FPS (frames per second) value.

getTimeMicro()

double cv::TickMeter::getTimeMicro ( ) const

inline

Python:
	cv.TickMeter.getTimeMicro(		) ->	retval

returns passed time in microseconds.

getTimeMilli()

double cv::TickMeter::getTimeMilli ( ) const

inline

Python:
	cv.TickMeter.getTimeMilli(		) ->	retval

returns passed time in milliseconds.

Examples:

samples/dnn/text_detection.cpp.

getTimeSec()

double cv::TickMeter::getTimeSec ( ) const

inline

Python:
	cv.TickMeter.getTimeSec(		) ->	retval

returns passed time in seconds.

getTimeTicks()

int64 cv::TickMeter::getTimeTicks ( ) const

inline

Python:
	cv.TickMeter.getTimeTicks(		) ->	retval

returns counted ticks.

reset()

void cv::TickMeter::reset ( )

inline

Python:
	cv.TickMeter.reset(		) ->	None

resets internal values.

Examples:

samples/dnn/text_detection.cpp.

start()

void cv::TickMeter::start ( )

inline

Python:
	cv.TickMeter.start(		) ->	None

starts counting ticks.

Examples:

samples/dnn/text_detection.cpp.

stop()

void cv::TickMeter::stop ( )

inline

Python:
	cv.TickMeter.stop(		) ->	None

stops counting ticks.

Examples:

samples/dnn/text_detection.cpp.

---

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

• opencv2/core/utility.hpp