jaiabot::utils::HampelFilter Class Reference

#include <jaiabot/utils/hampel_filter.h>

Classes
struct	Result

Public Member Functions
	HampelFilter (std::size_t window_size=7, double num_mads=3.0)
Result	filter (double value)
void	reset ()
bool	is_warmed_up () const
std::size_t	window_size () const
double	num_mads () const
std::size_t	samples_buffered () const

Static Public Attributes
static constexpr double	MAD_TO_STDDEV_SCALE = 1.4826

Detailed Description

Definition at line 22 of file hampel_filter.h.

Constructor & Destructor Documentation

HampelFilter()

jaiabot::utils::HampelFilter::HampelFilter ( std::size_t  window_size = 7, double  num_mads = 3.0  )

inlineexplicit

Definition at line 29 of file hampel_filter.h.

Member Function Documentation

filter()

Result jaiabot::utils::HampelFilter::filter ( double  value )

inline

Definition at line 45 of file hampel_filter.h.

is_warmed_up()

bool jaiabot::utils::HampelFilter::is_warmed_up ( ) const

inline

Definition at line 86 of file hampel_filter.h.

num_mads()

double jaiabot::utils::HampelFilter::num_mads ( ) const

inline

Definition at line 89 of file hampel_filter.h.

reset()

void jaiabot::utils::HampelFilter::reset ( )

inline

Definition at line 83 of file hampel_filter.h.

samples_buffered()

std::size_t jaiabot::utils::HampelFilter::samples_buffered ( ) const

inline

Definition at line 90 of file hampel_filter.h.

window_size()

std::size_t jaiabot::utils::HampelFilter::window_size ( ) const

inline

Definition at line 88 of file hampel_filter.h.

Member Data Documentation

MAD_TO_STDDEV_SCALE

constexpr double jaiabot::utils::HampelFilter::MAD_TO_STDDEV_SCALE = 1.4826

staticconstexpr

Definition at line 25 of file hampel_filter.h.

---

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

• jaiabot/utils/hampel_filter.h