Class OneEuroFilter

OneEuroFilter provides a mechanism for filtering noisy signals with a one euro filter algorithm. It extends the OneEuroFilterBase class.

Hierarchy

OneEuroFilterBase
- OneEuroFilter

Index

Constructors

Properties

beta dcutoff dx frequency lastcutoff lasttime minCutoff x

Methods

alpha filter reset

Constructors

constructor

new OneEuroFilter(config: OneEuroFilterConfig): OneEuroFilter
Parameters
- config: OneEuroFilterConfig
Returns OneEuroFilter
Inherited from OneEuroFilterBase.constructor

Properties

beta

beta: number

dcutoff

dcutoff: number

dx

dx: LowPassFilter

frequency

frequency: number

lastcutoff

lastcutoff: number

lasttime

lasttime: number

minCutoff

minCutoff: number

x

x: LowPassFilter

Methods

alpha

alpha(cutoff: number): number
Calculates the alpha value used for smoothing in the filter, based on a cutoff frequency.
Parameters
- cutoff: number
  The cutoff frequency at which the filter should attenuate the signal.
Returns number
The calculated alpha value for the filter.

Inherited from OneEuroFilterBase.alpha

filter

filter(value: number, timestamp: number): number
Applies the filter to the given value using the current filter configuration and updates the internal state.
Parameters
- value: number
  The new value to be filtered.
- timestamp: number
  The timestamp associated with the value, used to calculate the dynamic parameters of the filter.
Returns number
The filtered value after applying the filter's algorithm.

reset

reset(): void
Resets the internal state to uninitialized.

Returns void
Inherited from OneEuroFilterBase.reset