@bencevans/kalman-filter
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

@bencevans/kalman-filter

Typescript / JavaScript Implementation of Kalman Filter

Install

npm install --save @bencevans/kalman-filter

Example (Single Measurement)

> import KalmanFilter from '@bencevans/kalman-filter';

> const filter = new KalmanFilter({
    initialEstimate: 0,
    initialErrorInEstimate: 1
  })

> const [estimate, errorInEstimate] = filter.update({
    measurement: 20,
    errorInMeasurement: 0
  });

> estimate
20
> errorInEstimate
0

Example (Multiple Measurements)

Measurements with multiple numeric values e.g. coordinates.

> import { KalmanFilterArray } from '@bencevans/kalman-filter';

> const filter = new KalmanFilterArray({
    initialEstimate: [0, 1],
    initialErrorInEstimate: 1
  })

> const [estimate, errorInEstimate] = filter.update({
    measurement: [1, 1],
    errorInMeasurement: 0.4
  });

> estimate
[ 0.7142857142857143, 1 ]
> errorInEstimate
0.2857142857142857

Related:

Package Sidebar

Install

npm i @bencevans/kalman-filter

Weekly Downloads

17

Version

1.0.0

License

GPL-3.0-or-later

Unpacked Size

12.7 kB

Total Files

10

Last publish

Collaborators

  • bencevans