ml-savitzky-golay-generalized

Savitzky–Golay filter in Javascript

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
ml-savitzky-golay-generalized
904.2.0a month ago8 years agoMinified + gzip package size for ml-savitzky-golay-generalized in KB

Readme

savitzky-golay-generalized
General Least-Squares Smoothing and Differentiation by the Convolution (Savitzky-Golay) Method Peter A. Gorry
Pretty much the same as the savitzky-golay method, but without border problems, and without inventing points. It can be maybe merged into the savitzky-golay project but by the now this is the version used in the last GSD project.
I'll try an automatic parameter tunning based on the SNR or in the entropy of the signal.
Usage
npm i ml-savitzky-golay-generalized
const {sgg} = require("ml-savitzky-golay-generalized");
sgg(dataY, deltaX|X, options)

Parameters

dataY

The data to be filtered.

deltaX | X

deltaX specifies the difference between 2 consecutive points of the independent: deltaX = Xi+1 - Xi. Specficiying a deltaX suppose that all your points are equally spaced on the independent variable. If your points are not equally spaced in the ordinate variable, then you have to provide explicitly your X values. The algorithm will use the average deltaX within each bin of 'windowSize' points to approximate the derivatives. This fast approximation only works if the X is almost locally equally spaced.

options

windowSize:

The odd number of points to approximate the regression polynomial. Default 9

derivative:

The grade of the derivative. 0 by default (Smoothing)

polynomial:

The order of the regression polynomial. Default 3

Examples

const { sgg } = require('ml-savitzky-golay-generalized');

Smoothing example

const options = {
  windowSize: 15,
  derivative: 0,
  polynomial: 3,
};

const noiseLevel = 0.1;
const data = new Array(200);
for (let i = 0; i < data.length; i++)
  data[i] =
    Math.sin((i * Math.PI * 2) / data.length) +
    (Math.random() - 0.5) * noiseLevel;
const answer = sgg(data, (Math.PI * 2) / data.length, options);
console.log(answer);

First derivative test (Equally spaced x)

const options = {
  windowSize: 45,
  derivative: 1,
  polynomial: 3,
};

const noiseLevel = 0.1;
const data = new Array(200);
for (let i = 0; i < data.length; i++) {
  data[i] =
    Math.sin((i * Math.PI * 2) / data.length) +
    (Math.random() - 0.5) * noiseLevel;
}
const answer = sgg(data, (Math.PI * 2) / data.length, options);
console.log(answer);

First derivative test x as vector(It could be non-equally spaced!!)

const options = {
  windowSize: 47,
  derivative: 1,
  polynomial: 3,
};

const noiseLevel = 0.1;
const data = new Array(200);
const x = new Array(200);
for (let i = 0; i < data.length; i++) {
  data[i] =
    Math.sin((i * Math.PI * 2) / data.length) +
    (Math.random() - 0.5) * noiseLevel;
  x[i] = (i * Math.PI * 2) / data.length;
}

const ans = sgg(data, (Math.PI * 2) / data.length, options);
const ans2 = sgg(data, x, options);