ev::CircularBuffer_< T > Class Template Reference

This class extends boost::circular_buffer to implement event circular buffers. For more information, please refer here. More...

#include <circular.hpp>

Inheritance diagram for ev::CircularBuffer_< T >:

Public Member Functions
double	duration () const
	Time difference between the last and the first event.
double	rate () const
	Compute event rate as the ratio between the number of events and the time difference between the last and the first event.
Eventd	mean () const
	Compute the mean of the events.
cv::Point2d	meanPoint () const
	Compute the mean x,y point of the events.
double	meanTime () const
	Compute the mean time of the events.
double	midTime () const
	Calculate the midpoint time between the oldest and the newest event.

Detailed Description

template<typename T>
class ev::CircularBuffer_< T >

This class extends boost::circular_buffer to implement event circular buffers. For more information, please refer here.

Event circular buffers inherit all the properties from boost circular buffers. Circular buffers are fixed-size data structures in a circular fashion (i.e, the end of the buffer is reached, it wraps around to the beginning).

Member Function Documentation

duration()

template<typename T >

double ev::CircularBuffer_< T >::duration ( ) const

inlinenodiscard

Time difference between the last and the first event.

Returns

Time difference

mean()

template<typename T >

Eventd ev::CircularBuffer_< T >::mean ( ) const

inlinenodiscard

Compute the mean of the events.

Returns

An Eventd object containing the mean values of x, y, t, and p attributes.

meanPoint()

template<typename T >

cv::Point2d ev::CircularBuffer_< T >::meanPoint ( ) const

inlinenodiscard

Compute the mean x,y point of the events.

Returns

Mean point

meanTime()

template<typename T >

double ev::CircularBuffer_< T >::meanTime ( ) const

inlinenodiscard

Compute the mean time of the events.

Returns

Mean time

midTime()

template<typename T >

double ev::CircularBuffer_< T >::midTime ( ) const

inlinenodiscard

Calculate the midpoint time between the oldest and the newest event.

Returns

Midpoint time.

rate()

template<typename T >

double ev::CircularBuffer_< T >::rate ( ) const

inlinenodiscard

Compute event rate as the ratio between the number of events and the time difference between the last and the first event.

Returns

Event rate

---

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

• modules/containers/include/openev/containers/circular.hpp