SoftFilters  0.1.0
Arduino framework and library of software data filters.
OneEuroFilter< VAL_T, TS_T > Class Template Reference

The 1-euro filter is based on the paper of the same name by Gery Casiez. More...

#include <SoftFilters.h>

Inheritance diagram for OneEuroFilter< VAL_T, TS_T >:
Collaboration diagram for OneEuroFilter< VAL_T, TS_T >:

Public Member Functions

 OneEuroFilter (double _freq, VAL_T _mincutoff, VAL_T _beta, VAL_T _dcutoff)
 
VAL_T mincutoff ()
 
VAL_T mincutoff (VAL_T v)
 
VAL_T beta ()
 
VAL_T beta (VAL_T v)
 
VAL_T dcutoff ()
 
VAL_T dcutoff (VAL_T v)
 
- Public Member Functions inherited from Filter
bool push (void const *const input, void *const output)
 Push a new data through the filter. More...
 

Protected Member Functions

virtual bool update (void const *const input) override
 Internally update the filter output based on the given input. More...
 
- Protected Member Functions inherited from BaseFilter< Reading< VAL_T, TS_T >, Reading< VAL_T, TS_T > >
virtual void const *const get_output_val_ptr () final
 Push a new data through the filter. More...
 
virtual void copy_to_client (void *const output) final
 Copy the output to client memory.
 

Private Attributes

one_euro_filter< VAL_T, TS_T > filter
 

Additional Inherited Members

- Protected Attributes inherited from BaseFilter< Reading< VAL_T, TS_T >, Reading< VAL_T, TS_T > >
Reading< VAL_T, TS_T > out_val
 Internally managed storage of the output value.
 

Detailed Description

template<typename VAL_T, typename TS_T>
class OneEuroFilter< VAL_T, TS_T >

The 1-euro filter is based on the paper of the same name by Gery Casiez.

Member Function Documentation

◆ update()

template<typename VAL_T , typename TS_T >
virtual bool OneEuroFilter< VAL_T, TS_T >::update ( void const *const  input)
inlineoverrideprotectedvirtual

Internally update the filter output based on the given input.

This method behaves similarly to the public Filter::push method, but without copying the output to the client memory. This method is for internal workings of the filter framework.

Implements Filter.


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