https://github.com/arghyadeep-k/opencv-facecrop

Auto-detect faces in a picture and crop them out.
https://github.com/arghyadeep-k/opencv-facecrop

face-crop image javascript nodejs npm npm-package npmjs opencv processing

Last synced: 27 days ago
JSON representation

Auto-detect faces in a picture and crop them out.

• Host: GitHub
• URL: https://github.com/arghyadeep-k/opencv-facecrop
• Owner: arghyadeep-k
• License: unlicense
• Created: 2020-09-18T08:21:40.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-10T16:09:50.000Z (over 1 year ago)
• Last Synced: 2024-10-04T13:39:32.332Z (about 1 month ago)
• Topics: face-crop, image, javascript, nodejs, npm, npm-package, npmjs, opencv, processing
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/opencv-facecrop
• Size: 3.43 MB
• Stars: 12
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# OpenCv - Face Crop : Autodetect & crop faces out of an image (Node.js)

![CI](https://github.com/arghyadeep-k/opencv-facecrop/workflows/CI/badge.svg?branch=master)

![codecov.io](https://codecov.io/github/arghyadeep-k/opencv-facecrop/coverage.svg?branch=master)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=arghyadeep-k_opencv-facecrop&metric=alert_status)](https://sonarcloud.io/dashboard?id=arghyadeep-k_opencv-facecrop)

![npm](https://img.shields.io/npm/v/opencv-facecrop)

![npm bundle size](https://img.shields.io/bundlephobia/min/opencv-facecrop)

![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/npm/opencv-facecrop)

![Depfu](https://img.shields.io/depfu/arghyadeep-k/opencv-facecrop)

![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/opencv-facecrop)

![npm](https://img.shields.io/npm/dt/opencv-facecrop)

![NPM](https://img.shields.io/npm/l/opencv-facecrop?color=blue)

This package helps you to auto-detect faces in a picture and crop them out.

## Installation

[![NPM](https://nodei.co/npm/opencv-facecrop.png)](https://nodei.co/npm/opencv-facecrop/)

**Install from command line:**

`npm install --save opencv-facecrop`

## Basic Usage

```javascript

const facecrop = require('opencv-facecrop');

facecrop('./image-file.jpg', './dest/output.jpg', "image/jpeg", 0.95, 1.5);

/* 

Outputs image with file name output.jpg in 'dest' folder with the face cropped out.

If multiple faces are detected, the files will be automatically renamed to output-1.jpg, output-2.jpg and so on.

*/

```

## Results

Original Image:



Image by Free-Photos from Pixabay




Cropped Image:



## API

**facecrop(input_filename, output_filename, type, quality, factor)**

- **input_filename**: Input String containing file name with relative/absolute filepath.

- **output_filename**: (Optional) Requires a string value which will contains the output file name.

- **type**: (Optional) Requires String value which will tell the format of the output image.

- **quality**: (Optional) Requires a float value between 0 to 1 which stands for the quality index of the output file compares to the input file. Set 1 for no reduction in quality.

- **factor**: (Optional) Scaling Factor by which the area of cropping of the face can be increased/decreased to add more details. Must be greater than 0.

## Defaults 

 - **input_filename**: Mandatory parameter

 - **output_filename**: "./output.jpg"

 - **type**: 'image/jpeg'

 - **quality**: 0.95

 - **factor**: 1

## Changelogs:

To view the changelogs, please refer to the Github Releases page of this project.

## License

OpenCv - Face Crop is published under the Unlicense. For more information, see the accompanying LICENSE file. 




---




P.S. - This is a pre-release version. More updates with refinements coming soon.