qurator-spk/eynollah
1
0
Fork 0
mirror of https://github.com/qurator-spk/eynollah.git synced 2025-06-18 16:49:55 +02:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Clemens Neudecker 2020-11-20 22:12:06 +01:00 • committed by GitHub
parent 59b2dcb619
commit 6b65cea24a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,9 +1,21 @@
# Textline Detection # Eynollah
> Detect textlines in document images > Document Layout Analysis
## Introduction ## Introduction
This tool (eynollah) performs border, region and textline detection and scaling and enhancing from document image data and returns the results as [PAGE-XML](https://github.com/PRImA-Research-Lab/PAGE-XML). This tool (eynollah) performs document layout analysis (segmentation) from document image data and returns the results as [PAGE-XML](https://github.com/PRImA-Research-Lab/PAGE-XML).
The goal of this project is to extract textlines of a document in order to feed them to an OCR model. This is achieved by four successive stages as follows:
It can currently detect the following layout classes:
* Border
* Textregion
* Image
* Textline
* Separator
* Marginalia
* Initial
The final goal is to feed the output to an OCR model.
The tool uses a combination of various models and heuristics:
* [Border detection](https://github.com/qurator-spk#border-detection) * [Border detection](https://github.com/qurator-spk#border-detection)
* [Layout detection](https://github.com/qurator-spk#layout-detection) * [Layout detection](https://github.com/qurator-spk#layout-detection)
* [Textline detection](https://github.com/qurator-spk#textline-detection) * [Textline detection](https://github.com/qurator-spk#textline-detection)
@ -47,9 +59,17 @@ In order to run this tool you also need trained models. You can download our pre
The basic command-line interface can be called like this: The basic command-line interface can be called like this:
eynollah -i <image file name> -o <directory to write output xml or enhanced image> -m <directory of models> -fl <if this parameter is set to true, full layout will be done> -ae <if true, this tool would resize and enhance image and result will be written in output> -as <if true, this tool would check whether the document needs scaling or not> -cl <if true, the tool will try to extract contours of texlines instead of rectangle bounding boxes> -si <if a directory is given here, this tool would write image regions inside documents there> eynollah \
-i <image file name> \
-o <directory to write output xml or enhanced image> \
-m <directory of models> \
-fl <if this parameter is set to true, full layout will be done> \
-ae <if true, this tool would resize and enhance image and result will be written in output> \
-as <if true, this tool would check whether the document needs scaling or not> \
-cl <if true, the tool will try to extract contours of texlines instead of rectangle bounding boxes> \
-si <if a directory is given here, this tool would write image regions inside documents there>
The tool does accepts and works better on original images (RGB format). The tool does accept and works better on original images (RGB format) than binarized images.
### How and where to use ### How and where to use