peterbraden/node-opencv is a open-source project on GitHub, written primarily in C++. It has 4.4k stars. OpenCV Bindings for node.js
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
OpenCV bindings for Node.js. OpenCV is
the defacto computer vision library - by interfacing with it natively in node,
we get powerful real time vision in js.
People are using node-opencv to fly control quadrocoptors, detect faces from
webcam images and annotate video streams. If you're using it for something
cool, I'd love to hear about it!
Install
You'll need OpenCV 2.3.1 or newer installed before installing node-opencv.
Specific for macOS
Install OpenCV using brew
brew install pkg-config
brew install opencv@2
brew link --force opencv@2
Specific for Windows
Download and install OpenCV (Be sure to use a 2.4 version) @
http://opencv.org/releases.html
For these instructions we will assume OpenCV is put at C:\OpenCV, but you can
adjust accordingly.
If you haven't already, create a system variable called OPENCV_DIR and set it
to C:\OpenCV\build\x64\vc12
Make sure the "x64" part matches the version of NodeJS you are using.
Also add the following to your system PATH
;%OPENCV_DIR%\bin
Install Visual Studio 2013. Make sure to get the C++ components.
You can use a different edition, just make sure OpenCV supports it, and you
set the "vcxx" part of the variables above to match.
findContours returns a Contours collection object, not a native array. This object provides
functions for accessing, computing with, and altering the contours contained in it.
See relevant source code and examples
var contours = im.findContours();
// Count of contours in the Contours object
contours.size();
// Count of corners(verticies) of contour `index`
contours.cornerCount(index);
// Access vertex data of contours
for(var c = 0; c < contours.size(); ++c) {
console.log("Contour " + c);
for(var i = 0; i < contours.cornerCount(c); ++i) {
var point = contours.point(c, i);
console.log("(" + point.x + "," + point.y + ")");
}
}
// Computations of contour `index`
contours.area(index);
contours.arcLength(index, isClosed);
contours.boundingRect(index);
contours.minAreaRect(index);
contours.isConvex(index);
contours.fitEllipse(index);
// Destructively alter contour `index`
contours.approxPolyDP(index, epsilon, isClosed);
contours.convexHull(index, clockwise);
Face Recognization
It requires to train then predict. For acceptable result, the face should be cropped, grayscaled and aligned, I ignore this part so that we may focus on the api usage.
** Please ensure your OpenCV 3.2+ is configured with contrib. MacPorts user may port install opencv +contrib **
const fs = require('fs');
const path = require('path');
const cv = require('opencv');
function forEachFileInDir(dir, cb) {
let f = fs.readdirSync(dir);
f.forEach(function (fpath, index, array) {
if (fpath != '.DS_Store')
cb(path.join(dir, fpath));
});
}
let dataDir = "./_training";
function trainIt (fr) {
// if model existe, load it
if ( fs.existsSync('./trained.xml') ) {
fr.loadSync('./trained.xml');
return;
}
// else train a model
let samples = [];
forEachFileInDir(dataDir, (f)=>{
cv.readImage(f, function (err, im) {
// Assume all training photo are named as id_xxx.jpg
let labelNumber = parseInt(path.basename(f).substring(3));
samples.push([labelNumber, im]);
})
})
if ( samples.length > 3 ) {
// There are async and sync version of training method:
// .train(info, cb)
// cb : standard Nan::Callback
// info : [[intLabel,matrixImage],...])
// .trainSync(info)
fr.trainSync(samples);
fr.saveSync('./trained.xml');
}else {
console.log('Not enough images uploaded yet', cvImages)
}
}
function predictIt(fr, f){
cv.readImage(f, function (err, im) {
let result = fr.predictSync(im);
console.log(`recognize result:(${f}) id=${result.id} conf=${100.0-result.confidence}`);
});
}
//using defaults: .createLBPHFaceRecognizer(radius=1, neighbors=8, grid_x=8, grid_y=8, threshold=80)
const fr = new cv.FaceRecognizer();
trainIt(fr);
forEachFileInDir('./_bench', (f) => predictIt(fr, f));
Test
Using tape. Run with command:
npm test.
Contributing
I (@peterbraden) don't spend much time maintaining this library, it runs
primarily on contributor support. I'm happy to accept most PR's if the tests run
green, all new functionality is tested, and there are no objections in the PR.
Because I haven't got much time for maintenance, I'd prefer to keep an absolute
minimum of dependencies.
MIT License
The library is distributed under the MIT License - if for some reason that
doesn't work for you please get in touch.
TopGit's last sync did not record any GitHub topics for peterbraden/node-opencv. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on peterbraden/node-opencv?
The most recent commit recorded on peterbraden/node-opencv was 2.4 years ago, based on the GitHub push timestamp. The repository has 833 forks — one of the better signals of community interest.
How many stars does peterbraden/node-opencv have?
peterbraden/node-opencv has 4.4k GitHub stars — refresh the page for the live number, or check github.com/peterbraden/node-opencv. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What language is peterbraden/node-opencv written in?
peterbraden/node-opencv is written primarily in C++. GitHub's language field is based on the largest share of bytes in the default branch.
Where do I read more about peterbraden/node-opencv?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/peterbraden/node-opencv is the definitive source.
Read full README in the tab above.
Is node-opencv worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of node-opencv.