dynamic-time-warping
v1.0.0
Published
Dynamic time warping for Javascript
Downloads
1,698
Readme
dynamic-time-warping
Dynamic time warping for Javascript. As simple usecase would be Touch signature identification with Javascript for example.
Install
Several quick start options are available:
- Download the latest release.
- Clone the repo:
git clone https://github.com/GordonLesti/dynamic-time-warping.git
. - Install with npm:
npm install dynamic-time-warping
. - Install with Bower:
bower install dynamic-time-warping
.
Include script (unless you are packaging scripts somehow else):
<script src="/path/to/dynamic-time-warping.js"></script>
The plugin can also be loaded as AMD or Node module.
Usage
Initialization
DynamicTimeWarping
needs two arrays containing objects of the the same type and function that calculates the distance
between two objects and returns a float.
var ser1 = [ 9, 93, 15, 19, 24 ];
var ser2 = [ 31, 97, 81, 82, 39 ];
var distFunc = function( a, b ) {
return Math.abs( a - b );
};
var dtw = new DynamicTimeWarping(ser1, ser2, distFunc);
getDistance
Will return the distance of the dynamic time warping as float.
// 108
var dist = dtw.getDistance();
getPath
Will return the path of the dynamic time warping as array of arrays with two integers.
// [ [ 0, 0 ], [ 1, 1 ], [ 1, 2 ], [ 1, 3 ], [ 2, 4 ], [ 3, 4 ], [ 4, 4 ] ]
var dist = dtw.getPath();
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
$ grunt
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.