Tesseract API with KADMOS add-on Integration Example

Tesseract API mit KADMOS Add-on Integration Beispiel

This guide demonstrates how to integrate the Tesseract OCR API with the KADMOS add-on to perform Optical Character Recognition (OCR) and Intelligent Character Recognition (ICR).
With the KADMOS add-on, one can significantly increase the recognition performance of Tesseract in terms of both speed and quality - all while retaining the familiar user interface of Tesseract. The add-on combines the performance of the established KADMOS recognition technology with the flexibility of Tesseract.
The KADMOS add-on enhances Tesseract's OCR capabilities and adds ICR support, enabling the recognition of both printed and handwritten text.

Diese Anleitung zeigt, wie man die Tesseract OCR API mit dem KADMOS Add-on integriert, um optische Zeichenerkennung (OCR) und intelligente Zeichenerkennung (ICR) durchzuführen.
Mit dem KADMOS Add-on, kann man die Erkennungsleistung von Tesseract sowohl in Bezug auf die Geschwindigkeit als auch auf die Qualität erheblich steigern - und das alles unter Beibehaltung der vertrauten Benutzeroberfläche von Tesseract. Das Add-on kombiniert die Leistung der bewährten KADMOS-Erkennungstechnologie mit der Flexibilität von Tesseract.
Das KADMOS-Zusatzmodul erweitert die OCR-Fähigkeiten von Tesseract und fügt ICR-Unterstützung hinzu, so dass sowohl gedruckter als auch handgeschriebener Text erkannt werden kann.

Prerequisites

Visual Studio 2022: make sure to indude the C++ development tools during installation.
CMake: Version 3.10 or higher.
Software Network Tool: to download the required libraries (Link).
Tesseract Ianguage data files: download the necessary language data files from the Tesseract GitHub repositoiy.

Voraussetzungen

Visual Studio 2022: Stellen Sie sicher, dass die C++-Entwicklungstools während der Installation aktiviert sind.
CMake: Version 3.10 oder höher.
Software Network Tool: zum Herunterladen der erforderlichen Bibliotheken (Link).
Tesseract Ianguage data files: laden Sie die erforderlichen Sprachdateien aus dem Tesseract GitHub Repository herunter.

Installation

1. Setup Environment

Setup Software Network Tool:


    PS > sw setup

Configure CMake:


    PS > mkdir build
    PS > cd bulid
    PS > cmake ..

Installation

1. Setup-Umgebung

Setup Software Network Tool:


    PS > sw setup

CMake konfigurieren:


    PS > mkdir build
    PS > cd bulid
    PS > cmake ..

2. Integration Example

Set integration example as the startup project in Visual Studio 2022.

2. Integrationsbeispiel

Legen Sie das Integrationsbeispiel als Startprojekt in Visual Studio 2022 fest.

3. Build the Project

Open the generated project in Visual Studio 2022 and build it using either the Debug or Release target.

3. Projekt erstellen

Öffnen Sie das generierte Projekt in Visual Studio 2022 und erstellen Sie es entweder mit dem Debug oder Release-Ziel.

Configuration

This section describes the configurable parameters for the Tesseract API integration, including KADMOS-spedfic options and additional debug configurations.

Konfiguration

Dieser Abschnitt beschreibt die konfigurierbaren Parameter für die Tesseract-API-Integration, einschliesslich der KADMOS-Optionen und zusätzlicher Debug-Konfigurationen.

OCR Engine Modes (OEM)

The Tesseract API supports multiple OCR Engine Modes (OEM), allowing you to choose which recognition engines to use during OCR processing. Here are the new available modes, specific to the KADMOS add-on:

OEM_LSTM_KADMOS_COMBINED (recommended and default): Runs the KADMOS recognizer with the option to fallback to the LSTM recognizer in challenging situations. This mode aims to leverage the spedalized features of KADMOS while still benefiting from the general versatility of LSTM.
OEM KADMOS_ONLY: Use only the KADMOS recognition engine.

OCR Engine Modes (OEM)

Die Tesseract-API unterstützt mehrere OCR-Engine-Modi (OEM), so dass Sie wählen können, welche Erkennungssysteme während der OCR-Verarbeitung verwendet werden sollen. Hier sind die neuen verfügbaren Modi, speziell für das KADMOS Add-on:

OEM_LSTM_KADMOS_COMBINED (empfohlen und Standard): Führt die KADMOS-Erkennung mit der Option aus, in schwierigen Situationen auf den LSTM-Erkenner zurückzugreifen. Dieser Modus zielt auf die Nutzung der Funktionen von KADMOS zu nutzen und gleichzeitig von der allgemeinen Vielseitigkeit von LSTM zu profitieren.
OEM KADMOS_ONLY: Nur das KADMOS-Erkennungsmodul wird verwendet.

Tesseract API Initialization Parameters

The project initializes the Tesseract API with the following parameters:

1. Datapath

Description:: The directory path where Tesseract language data files are located. This is required for the OEM_LSTM_KADMOS_COMBINED mode.
Configuration:: Ensure the data directory is at the specified relative path and contains the necessary language data files (e.g., 'eng.traineddata').

2. Language

Description:: Specifies the language used for OCR.
Configuration:: Change this to another language code as needed, ensuring the corresponding '.traineddata' file is present in the tessdata directory.
⚠️: currently only English ('eng') is supported for the KADMOS-related modes. Please contact re Recognition (office@rerecognition.com) if you require support for different languages.

3. KADMOS Trial Activation Key

Description:: A parameter used for activating the KADMOS trial. This key is only required for initial license activation and download. See [Licensing](#licensing) for more information on licensing.
Configuration:: Replace this activation key with a valid key if different, and ensure it is correctly configured during Tesseract initialization.

For more information on Tesseract-specific API initialization parameters, please refer to the (Tesseract-Dokumentation).

Tesseract-API-Initialisierungs-Parameter

Das Projekt initialisiert die Tesseract-API mit den folgenden Parametern:

1. Datenpfad

Beschreibung:: Der Verzeichnispfad, in dem sich die Tesseract-Sprachdateien befinden. Dies ist für den Modus OEM_LSTM_KADMOS_COMBINED erforderlich.
Konfiguration: Stellen Sie sicher, dass sich das Datenverzeichnis im angegebenen relativen Pfad befindet und die erforderlichen Sprachdatendateien enthält (z. B. „eng.traineddata“).

2. Sprachen

Beschreibung:: Angabe der für die OCR verwendeten Sprache.
Konfiguration: Ändern Sie diesen Code nach Bedarf in einen anderen Sprachcode und stellen Sie sicher, dass die entsprechende '.traineddata'-Datei im tessdata-Verzeichnis vorhanden ist.
⚠️: Derzeit wird nur Englisch ('eng') für die KADMOS-bezogenen Modi unterstützt. Bitte wenden Sie sich an re Recognition (office@rerecognition.com), wenn Sie Unterstützung für andere Sprachen benötigen.

3. KADMOS Testversion Aktivierungsschlüssel

Beschreibung:: Ein Parameter, der für die Aktivierung der KADMOS-Testversion verwendet wird. Dieser Schlüssel ist nur für die erste Lizenzaktivierung und den Download erforderlich. Weitere Informationen zur Lizenzierung finden Sie unter [Licensing](#licensing).
Konfiguration: Ersetzen Sie diesen Aktivierungsschlüssel durch einen gültigen Schlüssel, falls er nicht identisch ist, und stellen Sie sicher, dass er bei der Initialisierung von Tesseract korrekt konfiguriert wird.

Weitere Informationen zu Tesseract-spezifischen API-Initialisierungsparametern finden Sie in der (Tesseract-Dokumentation).

Tesseract API Variables

The following variables are set using api->SetVariable, allowing customization of the OCR process:

1. Debug File

Description:: Specifies the file path for logging debug information.
Configuration:: Set this path to specify where debug logs should be saved. Ensure the path is writable by the application. This setting is optional and can be omitted if not needed.

2. Multilingual Debug Level

Description:: Enables extensive logging for classification.
Default Value:: '0' (Disabled)
Configuration:: Set this to '1' to enable detailed logging, which can assist in debugging complex OCR tasks.

3. KADMOS Image Padding

Description:: Sets the number of pixels to pad around text boxes for KADMOS recognition.
Default Value:: '2'
Configuration:: Change this value to adjust padding if necessary, which can affect OCR accuracy for text boxes.

4. KADMOS Enable ICR

Description:: Activates ICR features in KADMOS for handwritten text recognition. Use this with the OEM_KADMOS_ONLY engine mode.
Default Value:: '0' (Disabled)
Configuration:: Set this to '1' to enable ICR features, allowing the KADMOS engine to recognize handwritten text.

Tesseract-API-Variablen

Die folgenden Variablen werden mit api->SetVariable gesetzt und ermöglichen eine individuelle Anpassung des OCR-Prozesses:

1. Debug-Datei

Beschreibung:: Gibt den Dateipfad für die Protokollierung von Debug-Informationen an.
Konfiguration:: Legen Sie diesen Pfad fest, um anzugeben, wo die Debug-Protokolle gespeichert werden sollen. Stellen Sie sicher, dass der Pfad von der Anwendung beschreibbar ist. Diese Einstellung ist optional und kann weggelassen werden, wenn sie nicht benötigt wird.

2. Mehrsprachige Debug-Ebene

Beschreibung:: Ermöglicht eine umfangreiche Protokollierung zur Klassifizierung.
Standardwert:: '0' (Deaktiviert)
Konfiguration:: Setzen Sie diesen Wert auf '1', um eine detaillierte Protokollierung zu aktivieren, die bei der Fehlersuche bei komplexen OCR-Aufgaben hilfreich sein kann.

3. KADMOS Image-Padding

Beschreibung:: Legt die Anzahl der Pixel fest, die für die KADMOS-Erkennung um Textfelder herum aufgefüllt werden.
Standardwert:: '2'
Konfiguration:: Ändern Sie diesen Wert, um ggf. die Auffüllung anzupassen, was die OCR-Genauigkeit für Textfelder beeinträchtigen kann.

4. KADMOS ICR aktivieren

Beschreibung:: Aktiviert die ICR-Funktionen in KADMOS zur Erkennung von handgeschriebenem Text. Verwenden Sie dies mit dem Modus OEM_KADMOS_ONLY.
Default Value:: '0' (Deaktiviert)
Konfiguration:: Ist dieser Wert auf '1' gesetzt, werden die ICR-Funktionen aktiviert, so dass die KADMOS-Engine handschriftlichen Text erkennen kann.

Licensing

The KADMOS add-on requires a license key for activation. A valid trial activation key can be obtained from re Recognition by registering your email address at https://tesseract.rerecognition.com/trial. Activating the trial license will result in downloading a *kadmos.lic* and *kadmos.licactivation* files, which should be placed in the same directory as the executable. The trial allows unlimited use of the KADMOS add-on for a period of 30 days. After the trial period, a valid license key is required for continued use. Please contact re Recognition at office@rerecognition.com for more information.

Lizenzierung

Für die Aktivierung des KADMOS-Add-ons ist ein Lizenzschlüssel erforderlich. Einen gültigen Test-Aktivierungsschlüssel erhalten Sie von re Recognition, indem Sie Ihre E-Mail-Adresse unter https://tesseract.rerecognition.com/trial registrieren. Die Aktivierung der Testlizenz führt zum Herunterladen der Dateien *kadmos.lic* und *kadmos.licactivation*, die in das gleiche Verzeichnis wie die ausführbare Datei gelegt werden sollten. Die Testversion erlaubt die uneingeschränkte Nutzung des KADMOS Add-ons für einen Zeitraum von 30 Tagen. Nach Ablauf der Testphase ist für die weitere Nutzung ein gültiger Lizenzschlüssel erforderlich. Bitte kontaktieren Sie re Recognition unter office@rerecognition.com für weitere Informationen.