Content aware image resize library
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
Caire is a content aware image resize library based on Seam Carving for Content-Aware Image Resizing paper.
| Original image | Energy map | Seams applied |:--:|:--:|:--:| | | | | |
Key features which differentiates this library from the other existing open source solutions:
The library is capable detecting human faces prior resizing the images via https://github.com/esimov/pigo, which does not require to have OpenCV installed.
The image below illustrates the application capabilities to detect human faces prior resizing. It's clearly visible from the image that with face detection activated the algorithm will avoid cropping pixels inside the detected faces, retaining the face zone unaltered.
| Original image | With face detection | Without face detection |:--:|:--:|:--:| | | | |
First, install Go, set your
, and make sure
is on your
$ export GOPATH="$HOME/go" $ export PATH="$PATH:$GOPATH/bin"
Next download the project and build the binary file.
$ go get -u -f github.com/esimov/caire/cmd/caire $ go install
The library now can be installed via Homebrew. The only thing you need is to run the commands below.
$ brew tap esimov/caire $ brew install caire
$ caire -in input.jpg -out output.jpg
$ caire --help
The following flags are supported:
| Flag | Default | Description | | --- | --- | --- | |
| - | Input file | |
| - | Output file | |
| n/a | New width | |
| n/a | New height | |
| false | Reduce image by percentage | |
| false | Reduce image to square dimensions | |
| false | Proportional scaling | |
| 1 | Blur radius | |
| 10 | Sobel filter threshold | |
| false | Use debugger | |
| false | Use face detection | |
| float | Plane rotated faces angle | |
| string | Cascade classifier |
To detect faces prior rescaling use the
flag and provide the face clasification binary file included in the
folder. The sample code below will rescale the provided image with 20% but will check for human faces prior rescaling.
For the face detection related arguments check the Pigo documentation.
$ caire -in input.jpg -out output.jpg -face=1 -cc="data/facefinder" -perc=1 -width=20
In case you wish to scale down the image by a specific percentage, it can be used the **``` -perc
options are expressed in percentage and not pixel values. For example to reduce the image dimension by 20% both horizontally and vertically you can use the following command:
$ caire -in input/source.jpg -out ./out.jpg -perc=1 -width=20 -height=20 -debug=false
Also the library supports the **``` -square ```** option. When this option is used the image will be resized to a squre, based on the shortest edge. The **``` -scale ```** option will resize the image proportionally. First the image is scaled down preserving the image aspect ratio, then the seam carving algorithm is applied only to the remaining points. Ex. : given an image of dimensions 2048x1536 if we want to resize to the 1024x500, the tool first rescale the image to 1024x768, then will remove only the remaining 268px. **Notice: Using the
option will reduce drastically the processing time. Use this option whenever is possible!** The CLI command can process all the images from a specific directory:
$ caire -in ./input-directory -out ./output-directory
You can also use
$ cat input/source.jpg | caire -in - -out - >out.jpg
so you can also use:
$ cat input/source.jpg | caire >out.jpg $ caire -out out.jpg < input/source.jpg
### Caire integrations - [x] Caire can be used as a servesless function via OpenFaaS: https://github.com/esimov/caire-openfaas - [x] Caire can also be used as a
$ snap run caire --h
| Original | Shrunk | | --- | --- | | | | | | | | | | | | |
| Original | Extended | | --- | --- | | | | | | |
Copyright © 2018 Endre Simo
This project is under the MIT License. See the LICENSE file for the full license text.