autocrop 0.3.2

Automatically crops faces from batches of pictures

autocrop

Perfect for profile picture processing for your website or batch work for ID cards, autocrop will output images centered around the biggest face detected.

Use

From the command line:

usage: [-h] [-o OUTPUT] [-i INPUT] [-w WIDTH] [-H HEIGHT] [-v]

Automatically crops faces from batches of pictures

optional arguments:
  -h, --help            Show this help message and exit
  -o, --output, -p, --path
			Folder where cropped images will be placed.
			Default: current working directory
	-r, --reject
			Folder where images without detected faces will be placed.
			Default: output directory
  -i, --input
			Folder where images to crop are located.
			Default: current working directory
  -w, --width
			Width of cropped files in px. Default=500
  -H, --height
			Height of cropped files in px. Default=500
  --facePercent   Percentage of Face height to image height (zoom factor)
  --padUp         Padding up value compared to padDown. Default=50
  --padDown       Padding down value compared to padDown. Default=50
  --padLeft       Padding left value compared to padRight. Default=50
  --padRight      Padding right value compared to padLeft. Default=50
  -v, --version         Show program's version number and exit

Params (width, height, facePercent)

• Example: autocrop -i pics -o crop -w 400 -H 400 --facePercent 50.
• Example with reject folder: autocrop -i pics -o crop -r nofaces -w 400 -H 400 --facePercent 50.
• Example more padding down: autocrop -i pics -o crop -w 400 -H 400 --facePercent 50 --padUp 20 --padDown 50.

What it does

The previous command will:

1. Copy all images found in the top level of pics to crop,
2. Crop around the face and resize to 400x400 pixels all images in crop.

Images where a face can't be detected will be left in crop. If no output folder is added, asks for confirmation and destructively crops images in-place.

Supported file types

The following file types are supported:

• EPS files (.eps)
• GIF files (.gif) (only the first frame of an animated GIF is used)
• JPEG 2000 files (.j2k, .j2p, .jp2, .jpx)
• JPEG files (.jpeg, .jpg, .jpe)
• LabEye IM files (.im)
• macOS ICNS files (.icns)
• Microsoft Paint bitmap files (.msp)
• MSP files (.msp)
• MSP files (.msp)
• PCX files (.pcx)
• Portable Network Graphics (.png)
• Portable Pixmap files (.pbm, .pgm, .ppm)
• SGI files (.sgi)
• SPIDER files (.spi)
• TGA files (.tga)
• TIFF files (.tif, .tiff)
• WebP (.webp)
• Windows bitmap files (.bmp, .dib)
• Windows ICO files (.ico)
• X bitmap files (.xbm)

Installation

Simple! In your command line, type:

pip install autocrop

Gotchas

Autocrop uses OpenCV to perform face detection, which is installed through binary wheels. If you already have OpenCV 3+ installed, you may wish to uninstall the additional OpenCV installation: pip uninstall opencv-python.

Installing directly

In some cases, you may wish the package directly, instead of through PyPI:

cd ~
git clone https://github.com/leblancfg/autocrop
cd autocrop
pip install .

conda

Development of a conda-forge package for the Anaconda Python distribution is also currently slated for development. Please leave feedback on issue #7 if you are insterested in helping out.

Requirements

Best practice for your projects is of course to use virtual environments. At the very least, you will need to have pip installed.

Autocrop is currently being tested on:

• Python:
  • 2.7
  • 3.4
  • 3.5
  • 3.6
• OS:
  • Linux
  • macOS
  • Windows

More Info

Check out:

• http://docs.opencv.org/master/d7/d8b/tutorial_py_face_detection.html#gsc.tab=0
• http://docs.opencv.org/master/d5/daf/tutorial_py_histogram_equalization.html#gsc.tab=0

Adapted from:

• http://photo.stackexchange.com/questions/60411/how-can-i-batch-crop-based-on-face-location

Contributing

Although autocrop is essentially a CLI wrapper around a single OpenCV function, it is actively developed. It has active users throughout the world.

If you would like to contribute, please consult the contribution docs.