ml-savitzky-golay
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

savitzky-golay

NPM version build status Test coverage npm download

Savitzky–Golay filter in Javascript.

This code is based on the article: Smoothing and Differentiation of Data by Simplified Least Squares Procedures

Installation

$ npm i ml-savitzky-golay

SavitzkyGolay(data, h, [options])

Uses the Savitzky-Golay filter based in the array of y values(data) and the difference between x dots(h).

Options:

  • windowSize: The amount of dots used to make the filtering evaluation, the default value is 5.
  • derivative: The grade for the derivative, the default value is 1.
  • polynomial: The grade of the polynomial function to use for calculation, the default value is 2.
  • pad: How to pad the array to handle borders. Can be one of:
    • 'none' (default): No padding. The resulting array will be smaller than the original one.
    • 'pre': Pad the original array before applying the filter
    • 'post': Pad the resulting array after applying the filter
  • padValue: If pad is not none, Determine how to fill the values, if the value don't match with the next strings, the new values are going to be filled with that value. The default value is 0. The special strings are:
    • 'circular': Pad with circular repetition of elements within the dimension.
    • 'replicate': Pad by repeating border elements of array.
    • 'symmetric': Pad array with mirror reflections of itself.

Examples

Smoothing

const savitzkyGolay = require('ml-savitzky-golay');
let data = [
  /* ... */
];
let options = { derivative: 0 };
let ans = savitzkyGolay(data, 1, options);
console.log(ans); // smoothed data

or

import savitzkyGolay from 'ml-savitzky-golay';

let data = [
  /* ... */
];
let options = { derivative: 0 };
let ans = savitzkyGolay(data, 1, options);

First derivative with padding

var SG = require('ml-savitzky-golay');
var X = [
  /* ... */
];
var options = {
  derivative: 1,
  pad: 'post',
  padValue: 'replicate',
};
var dX = SG(X, 1, options);
console.log(dX); // first derivative

API Documentation

Contributors

License

MIT

Package Sidebar

Install

npm i ml-savitzky-golay

Weekly Downloads

1,153

Version

5.0.0

License

MIT

Unpacked Size

19.2 kB

Total Files

10

Last publish

Collaborators

  • stropitek
  • targos
  • lpatiny
  • mljs-bot
  • maasencioh
  • jeffersonh44
  • andcastillo
  • ml-bot