No description
Find a file
Robert Sachunsky 867a7261de
pil_cv2.check_dpi: fix class membership test
(depending on how the `PIL.Image` was instantiated – file plugin or array interface – the previous `isinstance` could fail, provoking a fall-through to `cv2pil` which does not work)
2023-06-12 00:45:57 +02:00
.circleci Merge branch 'main' into eynollah_light 2023-05-09 00:46:58 +02:00
.github/workflows re-enable Action for Python 3.8 2023-05-13 02:39:18 +02:00
qurator pil_cv2.check_dpi: fix class membership test 2023-06-12 00:45:57 +02:00
tests allow passing PIL image to Eynollah w/o disk I/O 2021-04-15 17:25:05 +02:00
.gitignore 📦 v0.0.3 2021-05-11 13:15:25 +02:00
CHANGELOG.md Update CHANGELOG.md 2023-05-13 12:44:45 +02:00
LICENSE extend setup.py, add Makefile, gitignore, requirements.txt 2020-11-20 17:48:06 +01:00
Makefile use the SavedModel format 2023-04-12 23:59:46 +02:00
ocrd-tool.json OCR-D CLI 2021-04-13 17:38:02 +02:00
README.md improve links to GT guidelines 2023-05-13 15:36:24 +02:00
requirements-test.txt 🎨 reformat cli.py with black 2020-11-23 11:24:58 +01:00
requirements.txt Update requirements.txt 2023-03-28 23:14:29 +02:00
setup.py Revert "Merge pull request #97 from qurator-spk/420-namespace-package" 2023-06-09 19:22:34 +02:00

Eynollah

Document Layout Analysis (segmentation) using pre-trained models and heuristics

PyPI Version CircleCI Build Status GH Actions Test License: ASL

Features

  • Support for up to 10 segmentation classes:
  • Support for various image optimization operations:
    • cropping (border detection), binarization, deskewing, dewarping, scaling, enhancing, resizing
  • Text line segmentation to bounding boxes or polygons (contours) including for curved lines and vertical text
  • Detection of reading order
  • Output in PAGE-XML
  • OCR-D interface

Installation

Python versions 3.7-3.10 with Tensorflow >=2.4 are currently supported.

For (limited) GPU support the matching CUDA toolkit >=10.1 needs to be installed.

You can either install via

pip install eynollah

or clone the repository, enter it and install (editable) with

git clone git@github.com:qurator-spk/eynollah.git
cd eynollah; pip install -e .

Alternatively, you can run make install or make install-dev for editable installation.

Models

Pre-trained models can be downloaded from qurator-data.de.

In case you want to train your own model to use with Eynollah, have a look at sbb_pixelwise_segmentation.

Usage

The command-line interface can be called like this:

eynollah \
  -i <image file> \
  -o <output directory> \
  -m <path to directory containing model files> \
     [OPTIONS]

The following options can be used to further configure the processing:

option description
-fl full layout analysis including all steps and segmentation classes
-light lighter and faster but simpler method for main region detection and deskewing
-tab apply table detection
-ae apply enhancement (the resulting image is saved to the output directory)
-as apply scaling
-cl apply countour detection for curved text lines instead of bounding boxes
-ib apply binarization (the resulting image is saved to the output directory)
-ep enable plotting (MUST always be used with -sl, -sd, -sa, -si or -ae)
-ho ignore headers for reading order dectection
-di <directory> process all images in a directory in batch mode
-si <directory> save image regions detected to this directory
-sd <directory> save deskewed image to this directory
-sl <directory> save layout prediction as plot to this directory
-sp <directory> save cropped page image to this directory
-sa <directory> save all (plot, enhanced/binary image, layout) to this directory

If no option is set, the tool will perform layout detection of main regions (background, text, images, separators and marginals). The tool produces better quality output when RGB images are used as input than greyscale or binarized images.

Use as OCR-D processor

Eynollah ships with a CLI interface to be used as OCR-D processor.

In this case, the source image file group with (preferably) RGB images should be used as input like this:

ocrd-eynollah-segment -I OCR-D-IMG -O SEG-LINE -P models

Any image referenced by @imageFilename in PAGE-XML is passed on directly to Eynollah as a processor, so that e.g.

ocrd-eynollah-segment -I OCR-D-IMG-BIN -O SEG-LINE -P models

uses the original (RGB) image despite any binarization that may have occured in previous OCR-D processing steps