From 4c6d6655e12bc7f63b8a446eace26be2a459d357 Mon Sep 17 00:00:00 2001 From: Robert Sachunsky Date: Sat, 26 Jun 2021 13:50:20 +0200 Subject: [PATCH] improve process() docstring --- ocrd_calamari/recognize.py | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/ocrd_calamari/recognize.py b/ocrd_calamari/recognize.py index 9cb2238..3cdd26f 100644 --- a/ocrd_calamari/recognize.py +++ b/ocrd_calamari/recognize.py @@ -67,7 +67,31 @@ class CalamariRecognize(Processor): def process(self): """ - Performs the recognition. + Perform text recognition with Calamari on the workspace. + + For each page of the input file group, open and deserialize input PAGE-XML + and its respective images. Then iterate over the element hierarchy down to + the line level. + + For each textline, retrieve a segment image according to the layout annotation + (from an existing ``AlternativeImage``, or by cropping into the higher-level + images, and deskewing when applicable). + + If the line element contained any previous text results or word segmentation, + delete it. + + Convert the line image to a Numpy array and pass it to the recognizer. Aggregate + character results on the line level, stripping leading and trailing white space, + and selecting the best hypothesis for each position. Annotate the resulting + TextEquiv string and (average) confidence on the line segment. + + If ``texequiv_level`` is ``word`` or ``glyph``, then additionally create word + level segments by splitting at white space characters, using the vertical + line coordinates and horizontal white space boundaries. In the case of ``glyph``, + create glyph level segments as well, adding all alternative character hypotheses + down to ``glyph_conf_cutoff`` confidence threshold. + + Produce a new PAGE output file by serialising the resulting hierarchy. """ log = getLogger('processor.CalamariRecognize')