php tesseract,在PHP中使用Tesseract OCR的一个封装包
Tesseract OCR for PHP
A wrapper to work with Tesseract OCR inside PHP.
Installation
$ composer require thiagoalessio/tesseract_ocr
‼️
This library depends on Tesseract OCR, version 3.02 or later.
Note for Windows users
There are many ways to install Tesseract OCR on your system, but if you just want something quick to get up and running, I recommend installing the Capture2Text package with Chocolatey.
choco install capture2text --version 3.9
⚠️
Recent versions of Capture2Text stopped shipping the tesseract binary.
Note for macOS users
With MacPorts you can install support for individual languages, like so:
$ sudo port install tesseract-
But that is not possible with Homebrew. It comes only with English support by default, so if you intend to use it for other language, the quickest solution is to install them all:
$ brew install tesseract --with-all-languages
Usage
Basic usage
use thiagoalessio\TesseractOCR\TesseractOCR;
echo (new TesseractOCR('text.png'))
->run();
The quick brown fox
jumps over
the lazy dog.
Other languages
use thiagoalessio\TesseractOCR\TesseractOCR;
echo (new TesseractOCR('german.png'))
->lang('deu')
->run();
Bülowstraße
Multiple languages
use thiagoalessio\TesseractOCR\TesseractOCR;
echo (new TesseractOCR('mixed-languages.png'))
->lang('eng', 'jpn', 'spa')
->run();
I eat すし y Pollo
Inducing recognition
use thiagoalessio\TesseractOCR\TesseractOCR;
echo (new TesseractOCR('8055.png'))
->whitelist(range('A', 'Z'))
->run();
BOSS
Breaking CAPTCHAs
Yes, I know some of you might want to use this library for the noble purpose of breaking CAPTCHAs, so please take a look at this comment:
API
image
Define the path of an image to be recognized by tesseract.
$ocr = new TesseractOCR();
$ocr->image('/path/to/image.png');
$ocr->run();
executable
Define a custom location of the tesseract executable, if by any reason it is not present in the $PATH.
echo (new TesseractOCR('img.png'))
->executable('/path/to/tesseract')
->run();
version
Returns the current version of tesseract.
echo (new TesseractOCR())->version();
availableLanguages
Returns a list of available languages/scripts.
foreach((new TesseractOCR())->availableLanguages() as $lang) echo $lang;
tessdataDir
Specify a custom location for the tessdata directory.
echo (new TesseractOCR('img.png'))
->tessdataDir('/path')
->run();
userWords
Specify the location of user words file.
This is a plain text file containing a list of words that you want to be considered as a normal dictionary words by tesseract.
Useful when dealing with contents that contain technical terminology, jargon, etc.
$ cat /path/to/user-words.txt
foo
bar
echo (new TesseractOCR('img.png'))
->userWords('/path/to/user-words.txt')
->run();
userPatterns
Specify the location of user patterns file.
If the contents you are dealing with have known patterns, this option can help a lot tesseract's recognition accuracy.
$ cat /path/to/user-patterns.txt'
1-\d\d\d-GOOG-441
www.\n\\\*.com
echo (new TesseractOCR('img.png'))
->userPatterns('/path/to/user-patterns.txt')
->run();
lang
Define one or more languages to be used during the recognition. A complete list of available languages can be found at: https://github.com/tesseract-ocr/tesseract/blob/master/doc/tesseract.1.asc#languages
Tip from @daijiale: Use the combination ->lang('chi_sim', 'chi_tra') for proper recognition of Chinese.
echo (new TesseractOCR('img.png'))
->lang('lang1', 'lang2', 'lang3')
->run();
psm
Specify the Page Segmentation Method, which instructs tesseract how to interpret the given image.
echo (new TesseractOCR('img.png'))
->psm(6)
->run();
oem
Specify the OCR Engine Mode. (see tesseract --help-oem)
echo (new TesseractOCR('img.png'))
->oem(2)
->run();
whitelist
This is a shortcut for ->config('tessedit_char_whitelist', 'abcdef....').
echo (new TesseractOCR('img.png'))
->whitelist(range('a', 'z'), range(0, 9), '-_@')
->run();
configFile
Specify a config file to be used. It can either be the path to your own config file or the name of one of the predefined config files: https://github.com/tesseract-ocr/tesseract/tree/master/tessdata/configs
echo (new TesseractOCR('img.png'))
->configFile('hocr')
->run();
format (deprecated)
Specify an output format other than text. Available options are HOCR and TSV (TSV is only available on Tesseract 3.05+)
echo (new TesseractOCR('img.png'))
->format('hocr')
->run();
digits
Shortcut for ->configFile('digits').
echo (new TesseractOCR('img.png'))
->digits()
->run();
hocr
Shortcut for ->configFile('hocr').
echo (new TesseractOCR('img.png'))
->hocr()
->run();
Shortcut for ->configFile('pdf').
echo (new TesseractOCR('img.png'))
->pdf()
->run();
quiet
Shortcut for ->configFile('quiet').
echo (new TesseractOCR('img.png'))
->quiet()
->run();
tsv
Shortcut for ->configFile('tsv').
echo (new TesseractOCR('img.png'))
->tsv()
->run();
txt
Shortcut for ->configFile('txt').
echo (new TesseractOCR('img.png'))
->txt()
->run();
Other options
Any configuration option offered by Tesseract can be used like that:
echo (new TesseractOCR('img.png'))
->config('config_var', 'value')
->config('other_config_var', 'other value')
->run();
Or like that:
echo (new TesseractOCR('img.png'))
->configVar('value')
->otherConfigVar('other value')
->run();
Thread-limit
Sometimes, it may be useful to limit the number of threads that tesseract is allowed to use (e.g. in this case). Set the maxmium number of threads as param for the run function:
echo (new TesseractOCR('img.png'))
->threadLimit(1)
->run();
Where to get help
Join the chat on Gitter.
How to contribute
You can contribute to this project by:
Helping new users on Gitter;
Opening an Issue if you found a bug or wish to propose a new feature;
Placing a Pull Request with code that fix a bug, missing/wrong documentation or implement a new feature;
Just make sure you take a look at our Code of Conduct and Contributing instructions.
License
tesseract-ocr-for-php is released under the MIT License.
Made with in Berlin