jstracking v0.0.3

jstracking

The jstracking library is created based on tracking.js library, which is a JavaScript library bringing different computer vision algorithms and techniques into the browser environment.

While, the original tracking.js library is not written in CommonJS or ES6 modules, which leads to difficulty in using the library in modern ES6 and Node.js development. The jstracking library solves the problem by rewriting the tracking.js library in CommonJS modules, so it is totally npm compatible, and can also be used by Node.js programs. Additionally, all of the tracking.js APIs are kept, so it's very simple to upgrade any code using tracking.js: just replace tracking(-min).js file.

Install

Install via npm, or download as a zip:

npm install jstracking

Usage

If tracking(-min).js is embedded in HTML, the usage of jstracking is the same as that of tracking.js.

For ES6 or CommonJS modules, an example of usage is shown below.

import tracking from 'jstracking';  // ES6
// Or
// const tracking = require('jstracking');  // CommonJS

const tracker = new tracking.ObjectTracker('face');
tracker.setInitialScale(4);
tracker.setStepSize(2);
tracker.setEdgesDensity(0.1);

tracking.track('#video', tracker, {
    camera: true,
    fps: 10,
    scaled: true
});

tracker.on('track', event => {
    // handle event...
});

APIs

The tracking.js library APIs are all kept, so you can refer to documentation of tracking.js for details.

New Features

• Written in CommonJS modules.
• Auto-scaling option to boost performance, especially for large videos/images.
• FPS option to set tracking count in one second.

License

The MIT License
Copyright (c) 2017 Joshua Tang