object-detection/README.md

Detect single objects in small, background-blurred and close-focused images

Detect single objects in small, background-blurred and close-focused images.<br /><br />
NPM link: [object-detection](https://www.npmjs.com/package/object-detection)
# Installation
`npm install object-detection`
# Usage
```

var detectObject = require('object-detection')

// Tweak the Sensitivity and the Tolerance for optimal result

var config = {
  imageName: 'path-to-image', // preferrably in JPG format and less than 100 kB
  sensitivity: 50, // ranges from 1 to 100
  tolerance: 50, // ranges from 1 to 100
}

detectObject(config).then(function(response) {

  var base64Img = response.base64Img

  // use base64Img in html image tag ...
  imageElement.setAttribute('src', 'data:image/jpeg;base64,' + base64Img)

  // save base64Img as image file ...
  fs.writeFile('object.jpg', base64Img, { encoding: 'base64' }, function() {
  	console.log('Saved object image')
  })
  
})

```
# Caution
- Use small images, preferably in JPG format and less than 100 kB
- Currently works for single object.
- Behaviour is not strongly defined for multi-objects.
- Contiguous objects are considered as single object.
- Optimizer is not well tuned yet.
# Web console
[object-detection-console](https://github.com/rosesonfire/objectDetectionConsole) is a simple web console for the object-detection package.
# Examples
Name|Image|Object|Sensitivity|Tolerance
-|-|-|-|-
Baseball|<img src="./examples/images/baseball.jpg" width="200" />|<img src="./examples/objects/baseball.jpg" width="200">|87|50
Birb|<img src="./examples/images/birb.jpg" width="200" />|<img src="./examples/objects/birb.jpg" width="200">|94|57
Cherry|<img src="./examples/images/cherry.jpg" width="200" />|<img src="./examples/objects/cherry.jpg" width="200">|86|21
Mic|<img src="./examples/images/mic.jpg" width="200" />|<img src="./examples/objects/mic.jpg" width="200">|87|20
Sunflower|<img src="./examples/images/sunflower.jpg" width="200" />|<img src="./examples/objects/sunflower.jpg" width="200">|94|22
Flower|<img src="./examples/images/flower.jpg" width="200" />|<img src="./examples/objects/flower.jpg" width="200">|80|17