|
1 | 1 | # global-spectral-deconvolution |
2 | 2 |
|
3 | 3 | [![NPM version][npm-image]][npm-url] |
4 | | -[![David deps][david-image]][david-url] |
| 4 | +[![build status][ci-image]][ci-url] |
| 5 | +[![Test coverage][codecov-image]][codecov-url] |
5 | 6 | [![npm download][download-image]][download-url] |
6 | 7 |
|
7 | 8 | Global Spectra Deconvolution + Peak optimizer |
8 | 9 |
|
9 | 10 | `gsd`is using an algorithm that is searching for inflection points to determine the position of peaks and the width of the peaks are between the 2 inflection points. The result of GSD yield to an array of object containing {x, y and width}. However this width is based on the inflection point and may be different from the 'fwhm' (Full Width Half Maximum). |
10 | 11 |
|
11 | | -The second algorithm (`optimizePeaks`) will optimize the width as a FWHM to match the original peak. After optimization the width with therefore be always FWHM whichever is the function used. |
| 12 | +The second algorithm (`optimizePeaks`) will optimize the width as a FWHM to match the original peak. After optimization the width with therefore be always FWHM whichever is the function used. |
12 | 13 |
|
13 | 14 | ## [API documentation](http://mljs.github.io/global-spectral-deconvolution/) |
14 | 15 |
|
@@ -83,18 +84,17 @@ console.log(peaks); // array of peaks {x,y,width}, width = distance between infl |
83 | 84 |
|
84 | 85 | let optimized = optimizePeaks(data, peaks); |
85 | 86 | console.log(optimized); // array of peaks {x,y,width}, width = FWHM |
86 | | - |
87 | | - |
88 | | - |
89 | 87 | ``` |
90 | 88 |
|
91 | 89 | ## License |
92 | 90 |
|
93 | 91 | [MIT](./LICENSE) |
94 | 92 |
|
95 | | -[npm-image]: https://img.shields.io/npm/v/ml-gsd.svg?style=flat-square |
| 93 | +[npm-image]: https://img.shields.io/npm/v/ml-gsd.svg |
96 | 94 | [npm-url]: https://npmjs.org/package/ml-gsd |
97 | | -[david-image]: https://img.shields.io/david/mljs/global-spectral-deconvolution.svg?style=flat-square |
98 | | -[david-url]: https://david-dm.org/mljs/global-spectral-deconvolution |
99 | | -[download-image]: https://img.shields.io/npm/dm/ml-gsd.svg?style=flat-square |
| 95 | +[codecov-image]: https://img.shields.io/codecov/c/github/mljs/global-spectral-deconvolution.svg |
| 96 | +[codecov-url]: https://codecov.io/gh/mljs/global-spectral-deconvolution |
| 97 | +[ci-image]: https://github.com/mljs/global-spectral-deconvolution/workflows/Node.js%20CI/badge.svg?branch=master |
| 98 | +[ci-url]: https://github.com/mljs/global-spectral-deconvolution/actions?query=workflow%3A%22Node.js+CI%22 |
| 99 | +[download-image]: https://img.shields.io/npm/dm/ml-gsd.svg |
100 | 100 | [download-url]: https://npmjs.org/package/ml-gsd |
0 commit comments