From ff78d4e85c375213baceb8229d33719e8a9867ad Mon Sep 17 00:00:00 2001 From: Clemens Neudecker <952378+cneud@users.noreply.github.com> Date: Mon, 25 Apr 2022 19:24:04 +0200 Subject: [PATCH] improve usage instructions --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a8c8960..d5cff03 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,7 @@ ## Introduction -This tool performs document image binarization (i.e. transform colour/grayscale -to black-and-white pixels) for OCR using multiple trained models. - -The method used is based on _Calvo-Zaragoza/Gallego, 2018. [A selectional auto-encoder approach for document image binarization](https://arxiv.org/abs/1706.10241)_. +This tool performs document image binarization using trained models. The method is based on [Calvo-Zaragoza and Gallego, 2018](https://arxiv.org/abs/1706.10241). ## Installation @@ -30,14 +27,20 @@ https://qurator-data.de/sbb_binarization/ ```sh sbb_binarize \ --patches \ - -m \ + -m \ \ ``` -**Note** In virtually all cases, the `--patches` flag will improve results. +**Note** In virtually all cases, applying the `--patches` flag will improve the quality of results. + +Example + +```sh +sbb_binarize --patches -m /path/to/models/ myimage.tif myimage-bin.tif +``` -To use the OCR-D interface: +To use the [OCR-D](https://ocr-d.de/) interface: ```sh ocrd-sbb-binarize --overwrite -I INPUT_FILE_GRP -O OCR-D-IMG-BIN -P model "/var/lib/sbb_binarization" ```