Point Cloud Library (PCL)  1.10.1-dev
List of all members | Public Member Functions
pcl::EventFrequency Class Reference

A helper class to measure frequency of a certain event. More...

#include <pcl/common/time.h>

Public Member Functions

 EventFrequency (std::size_t window_size=30)
 Constructor. More...
void event ()
 Notifies the class that the event occurred. More...
double getFrequency () const
 Retrieve the estimated frequency. More...
void reset ()
 Reset frequency computation. More...

Detailed Description

A helper class to measure frequency of a certain event.

To use this class create an instance and call event() function every time the event in question occurs. The estimated frequency can be retrieved with getFrequency() function.

Sergey Alexandrov

Definition at line 134 of file time.h.

Constructor & Destructor Documentation

◆ EventFrequency()

pcl::EventFrequency::EventFrequency ( std::size_t  window_size = 30)


[in]window_sizenumber of most recent events that are considered in frequency estimation (default: 30)

Definition at line 143 of file time.h.

Member Function Documentation

◆ event()

void pcl::EventFrequency::event ( )

Notifies the class that the event occurred.

Definition at line 150 of file time.h.

◆ getFrequency()

double pcl::EventFrequency::getFrequency ( ) const

Retrieve the estimated frequency.

Definition at line 159 of file time.h.

◆ reset()

void pcl::EventFrequency::reset ( )

Reset frequency computation.

Definition at line 168 of file time.h.

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