https://github.com/jaysalvat/jquery.facedetection

A jQuery plugin to detect faces on images, videos and canvases.
https://github.com/jaysalvat/jquery.facedetection

Last synced: 2 months ago
JSON representation

A jQuery plugin to detect faces on images, videos and canvases.

• Host: GitHub
• URL: https://github.com/jaysalvat/jquery.facedetection
• Owner: jaysalvat
• License: other
• Fork: true (liuliu/ccv)
• Created: 2010-11-03T16:38:39.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2021-02-28T14:58:19.000Z (almost 4 years ago)
• Last Synced: 2024-09-25T23:34:10.944Z (3 months ago)
• Language: JavaScript
• Homepage: http://facedetection.jaysalvat.com
• Size: 2.23 MB
• Stars: 2,791
• Watchers: 158
• Forks: 486
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
jQuery Face Detection Plugin

============================

[![Build Status](https://travis-ci.org/jaysalvat/jquery.facedetection.png?branch=master)](https://travis-ci.org/jaysalvat/https://travis-ci.org/jaysalvat/jquery.facedetection)

[![NPM version](https://badge.fury.io/js/jquery.facedetection.svg)](http://badge.fury.io/js/jquery.facedetection)

[![Bower version](https://badge.fury.io/bo/jquery.facedetection.svg)](http://badge.fury.io/bo/jquery.facedetection)

A jQuery/Zepto plugin to detect faces on images, videos and canvases to get theirs coordinates.

**Importante note:** This plugin uses an algorithm by [Liu Liu](http://liuliu.me/).

Demos

-----

Website and demo here:

[http://facedetection.jaysalvat.com/](http://facedetection.jaysalvat.com/)

Get started

-----------

Download the plugin with the method of your choice.

- Download the [last release](http://jaysalvat.github.io/jquery.facedetection/releases/latest/jquery.facedetection.zip) manually

- Or install it with [Bower](http://bower.io/).

        bower install jquery.facedetection

- Or install it with [NPM](https://www.npmjs.org/package/jquery.facedetection).

        npm install jquery.facedetection

Include [jQuery](https://code.jquery.com/jquery-3.2.1.min.js) and the plugin.

    

    

Set a picture with some faces in your HTML page.

    

Apply the plugin to this image and get the face coordinates.

    

        $('#picture').faceDetection({

            complete: function (faces) {

                console.log(faces);

            }

        });

    

Results

-------

Returns an array of found faces object:

- **x** — X coord of the face in the picture

- **y** — Y coord of the face in the picture

- **width** — Width of the face

- **height** — Height of the face

- **positionX** — X position relative to the document

- **positionY** — Y position relative to the document

- **offsetX** — X position relative to the offset parent

- **offsetY** — Y position relative to the offset parent

- **scaleX** — Ratio between original image width and displayed width

- **scaleY** — Ratio between original image height and displayed height

- **confidence** — Level of confidence

Settings

--------

- **interval** — Interval (default 4)

- **minNeighbors** — Minimum neighbors threshold which sets the cutoff level for discarding rectangle groups as face (default 1)

- **confidence** — Minimum confidence (default null)

- **async** — Async mode if Worker available (default false). The async mode uses Workers and needs the script to be on the same domain.

- **grayscale** — Convert to grayscale before processing (default true)

- **complete** — Callback function trigged after the detection is completed

        complete: function (faces) {

            // ...

        }

- **error** — Callback function trigged on errors

        error: function (code, message) {

            // ...

        }