ubii-processing-module-ocr 0.2.1.dev4
"Ubi Interact Processing Module to perform OCR tasks via Tesseract"
Requires Python: >=3.7
Keywords: ocr,tesseract,ubi-interact,ubii,opencv

ubii-processing-module-ocr
==========================

Tesseract OCR for Ubi Interact
Documentation available `here <https://ubii-processing-module-ocr.readthedocs.io/en/latest/>`_.

Requirements
------------

-  `tesseract <https://tesseract-ocr.github.io/>`__ OCR Engine with
   appropriate language packs *(>= 4.0.0)*

-  opencv (some of the modules try to improve OCR performance with
   additional preprocessing, in the future this might become an optional
   requirement)

-  numpy

-  `tesserocr <https://github.com/sirfz/tesserocr>`__

    .. warning:: On windows ``tesserocr`` can’t be installed from PyPi.
        Windows builds for tesserocr are available for
        `some python versions <https://github.com/simonflueckiger/tesserocr-windows_build/releases>`__.
        Only python version **>=3.7 < 3.8** is supported by both
        ``tesserocr`` and the ``ubi-interact-python`` node on Windows.
        Tesseract 5.+ should be compatible with Tesseract 4.0.0 (which is
        used for the Windows builds).

Known Issues
------------

-  The processing modules which use opencv seem to sometimes randomly
   crash under Windows
-  Processing Frequency depends on the module implementation. Typically
   ``TesseractOCR_EAST`` allows for a slightly higher processing
   frequency and is run at **10fps** while the ``TesseractOCR_PURE``
   module is run at **5fps**.


.. _api-docs:

API
---

Autogenerated documentation can be found here:


.. toctree::
    :maxdepth: 1
    :glob:

    api/*

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


BSD 3-Clause License

Copyright (c) 2022, Maximilian Schmidt (ga97lul@mytum.de)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.