lecodeurdudimanche/document-data-extractor

A simple library to extract data from documents with a known structure

0.1.1 2019-11-12 12:51 UTC

Requires

• thiagoalessio/tesseract_ocr: >=2.8.0

Requires (Dev)

• phpunit/phpunit: ^8
• squizlabs/php_codesniffer: 3.*

MIT

• Adrien Duval

README

A simple PHP library to automate data extraction from documents with known formats.

Requirements

This library uses Tesseract to read text from documents and Imagick to manipulate the images.

It relies on GhostScript (gs) to convert pdf files to images.

Installation

Install required php libraries : php-imagick. On Ubuntu :

apt install php7-imagick

Then install the package via composer :

composer require lecodeurdudimanche/document-data-extractor

Usage

First, you'll need to define what data you want to extract and where it is on the image :

    $extractor = new Extractor();
    $regionsOfInterest = [
        // The name of the company is in the rectangle with the top left corner (700, 180) and a size of (1080, 160)
        new ROI('Name of the company')->setRect(700, 180, 1080, 160),
        new ROI('Total', 'integer')->setRect(1980, 1572, 58, 52);
    ];

Next you can add some options forwarded to tesseract in order to get more precise results :

    $tesseractConfiguration = [
        'psm' => 8, // Page segmentation method is set to 8 (single word)
        'tessdataDir' => '/usr/share/tessdata' // Other tesseract options ...
    ];
    $config = Configuration::fromArray(compact('regionsOfInterest', 'tesseractConfiguration'));
    $extractor->setConfig($config);

Then you set the document you want to extract data from :

    $extractor->loadImage('/path/to/image.png'); // or
    $extractor->loadPDF('/path/to/document.pdf'); // or
    $extractor->setImage($imageData); // could be an Imagick or GD image or raw image data

And finally you call the run() method to extract the data :

    $data = $extractor->run();
    /*
    * $data = [
    * ['label' => 'Name of the company', 'type' => 'text', 'data' => 'Company Limited'],
    * ['label' => 'Total', 'type' => 'integer', 'data' => '55']
    * ];
    */

You can save and load a Configuration object with the toFile and fromFile methods. The file format is pretty formatted JSON.