ClassOneEuroFilter

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

Hierarchy

  • OneEuroFilterBase
    • OneEuroFilter

Constructors

constructor

Properties

beta dcutoff dx frequency lastcutoff lasttime minCutoff x

Methods

alpha filter reset

Constructors

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

  • 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.

filter

  • filter(value, timestamp): 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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods