Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 2.34 KB

README.md

File metadata and controls

51 lines (39 loc) · 2.34 KB

autocrop

Automatically crop and rotate scanned images using OpenCV. Should work on Windows, Linux and Mac.

Install requirements

pip install opencv-python
pip install numpy

Usage

Simple

Place autocrop.py into a folder of scanned images. Those images should be roughly cropped already (see examples). Also: only one image per scan!

python autocrop.py

This creates a new folder crop where all cropped and rotated images will be saved to.

Additional options

python autocrop.py [-h] [-i INPUT_PATH] [-o OUTPUT_PATH] [-t THRESHOLD] [-c CROP] [-p THREADS] [-s]

Argument Description
-h, --help Show this help message and exit.
-i INPUT_PATH Input path. Specify the folder containing the images you want be processed.
-o OUTPUT_PATH Output path. Specify the folder name to which processed images will be written.
-r ROTATION Rotate images before cropping. Values can be 0 (Default), 90, -90 or 180.
-t THRESHOLD Threshold value. Higher values represent less aggressive contour search. If it's chosen too high, a white border will be introduced.
-c CROP Standard extra crop. After crop/rotate often a small white border remains. This removes this. If it cuts off too much of your image, adjust this.
-q QUALITY JPEG quality for output images (Default = 92).
-b, --black Set this if you are using black/very dark (but uniform) backgrounds.
-p THREADS Specify the number of threads to be used to process the images in parallel. If not provided, the script will try to find the value itself (which doesn't work on Windows or MacOS -> defaults to 1 thread only).
-s, --single Process single image. i.e.: -i img.jpg -o crop/

Troubleshooting

I have a black/dark background and using -b doesn't help:

If you don't need the ability to rotate your images (i.e. if you're scanning slides), check out this cool project: Dias_Autocrop.

ValueError: too many values to unpack (expected 2):

You likely use an outdated version of OpenCV. Make sure you have OpenCV 4.0 or higher installed. The version can be checked by executing the following code in the terminal.

python -c 'import cv2; print(f"OpenCV version: {cv2.__version__}")'
> OpenCV version: 4.2.0

Todo: executables for Windows + basic GUI

To make it usable for less nerdy people.