mirror of
https://github.com/kerberos-io/openalpr-base.git
synced 2026-04-22 22:47:05 +08:00
update readme mentioning it's a fork
This commit is contained in:
Cedric Verstraeten
@@ -1,21 +1,18 @@
|
||||
openalpr
|
||||
========
|
||||
# OpenALPR
|
||||
|
||||
OpenALPR is an open source *Automatic License Plate Recognition* library written in C++ with bindings in C#, Java, Node.js, Go, and Python. The library analyzes images and video streams to identify license plates. The output is the text representation of any license plate characters.
|
||||
This is a fork of [the original OpenALPR repository](https://github.com/openalpr/openalpr). Within this fork we have added latest FFMpeg and OpenCV build.
|
||||
|
||||
OpenALPR is an open source _Automatic License Plate Recognition_ library written in C++ with bindings in C#, Java, Node.js, Go, and Python. The library analyzes images and video streams to identify license plates. The output is the text representation of any license plate characters.
|
||||
|
||||
Check out a live online demo here: http://www.openalpr.com/demo-image.html
|
||||
|
||||
User Guide
|
||||
-----------
|
||||
## User Guide
|
||||
|
||||
|
||||
OpenALPR includes a command line utility. Simply typing "alpr [image file path]" is enough to get started recognizing license plate images.
|
||||
OpenALPR includes a command line utility. Simply typing "alpr [image file path]" is enough to get started recognizing license plate images.
|
||||
|
||||
For example, the following output is created by analyzing this image:
|
||||
|
||||
|
||||
|
||||
|
||||
```
|
||||
user@linux:~/openalpr$ alpr ./samplecar.png
|
||||
|
||||
@@ -38,17 +35,17 @@ Detailed command line usage:
|
||||
```
|
||||
user@linux:~/openalpr$ alpr --help
|
||||
|
||||
USAGE:
|
||||
USAGE:
|
||||
|
||||
alpr [-c <country_code>] [--config <config_file>] [-n <topN>] [--seek
|
||||
<integer_ms>] [-p <pattern code>] [--clock] [-d] [-j] [--]
|
||||
[--version] [-h] <image_file_path>
|
||||
|
||||
|
||||
Where:
|
||||
Where:
|
||||
|
||||
-c <country_code>, --country <country_code>
|
||||
Country code to identify (either us for USA or eu for Europe).
|
||||
Country code to identify (either us for USA or eu for Europe).
|
||||
Default=us
|
||||
|
||||
--config <config_file>
|
||||
@@ -65,11 +62,11 @@ Where:
|
||||
for Maryland, ca for California)
|
||||
|
||||
--clock
|
||||
Measure/print the total time to process image and all plates.
|
||||
Measure/print the total time to process image and all plates.
|
||||
Default=off
|
||||
|
||||
-d, --detect_region
|
||||
Attempt to detect the region of the plate image. [Experimental]
|
||||
Attempt to detect the region of the plate image. [Experimental]
|
||||
Default=off
|
||||
|
||||
-j, --json
|
||||
@@ -92,9 +89,7 @@ Where:
|
||||
|
||||
```
|
||||
|
||||
|
||||
Binaries
|
||||
----------
|
||||
## Binaries
|
||||
|
||||
Pre-compiled Windows binaries can be downloaded on the [releases page](https://github.com/openalpr/openalpr/releases)
|
||||
|
||||
@@ -102,18 +97,15 @@ Install OpenALPR on Ubuntu 16.04 with the following commands:
|
||||
|
||||
sudo apt-get update && sudo apt-get install -y openalpr openalpr-daemon openalpr-utils libopenalpr-dev
|
||||
|
||||
Documentation
|
||||
---------------
|
||||
## Documentation
|
||||
|
||||
Detailed documentation is available at [doc.openalpr.com](http://doc.openalpr.com/)
|
||||
|
||||
Integrating the Library
|
||||
-----------------------
|
||||
## Integrating the Library
|
||||
|
||||
OpenALPR is written in C++ and has bindings in C#, Python, Node.js, Go, and Java. Please see this guide for examples showing how to run OpenALPR in your application: http://doc.openalpr.com/bindings.html
|
||||
OpenALPR is written in C++ and has bindings in C#, Python, Node.js, Go, and Java. Please see this guide for examples showing how to run OpenALPR in your application: http://doc.openalpr.com/bindings.html
|
||||
|
||||
Compiling
|
||||
-----------
|
||||
## Compiling
|
||||
|
||||
[](https://travis-ci.org/openalpr/openalpr)
|
||||
|
||||
@@ -124,25 +116,24 @@ OpenALPR requires the following additional libraries:
|
||||
- Tesseract OCR v3.0.4 (https://github.com/tesseract-ocr/tesseract)
|
||||
- OpenCV v2.4.8+ (http://opencv.org/)
|
||||
|
||||
After cloning this GitHub repository, you should download and extract Tesseract and OpenCV source code into their own directories. Compile both libraries.
|
||||
After cloning this GitHub repository, you should download and extract Tesseract and OpenCV source code into their own directories. Compile both libraries.
|
||||
|
||||
Please follow these detailed compilation guides for your respective operating system:
|
||||
|
||||
* [Windows](https://github.com/openalpr/openalpr/wiki/Compilation-instructions-(Windows))
|
||||
* [Ubuntu Linux](https://github.com/openalpr/openalpr/wiki/Compilation-instructions-(Ubuntu-Linux))
|
||||
* [OS X](https://github.com/openalpr/openalpr/wiki/Compilation-instructions-(OS-X))
|
||||
* [Android Library](https://github.com/SandroMachado/openalpr-android)
|
||||
* [Android Application Sample](https://github.com/sujaybhowmick/OpenAlprDroidApp)
|
||||
* [iOS](https://github.com/twelve17/openalpr-ios)
|
||||
* [iOS React Native](https://github.com/cardash/react-native-openalpr)
|
||||
* [Xamarin](https://github.com/kevinjpetersen/openalpr-xamarin)
|
||||
- [Windows](<https://github.com/openalpr/openalpr/wiki/Compilation-instructions-(Windows)>)
|
||||
- [Ubuntu Linux](<https://github.com/openalpr/openalpr/wiki/Compilation-instructions-(Ubuntu-Linux)>)
|
||||
- [OS X](<https://github.com/openalpr/openalpr/wiki/Compilation-instructions-(OS-X)>)
|
||||
- [Android Library](https://github.com/SandroMachado/openalpr-android)
|
||||
- [Android Application Sample](https://github.com/sujaybhowmick/OpenAlprDroidApp)
|
||||
- [iOS](https://github.com/twelve17/openalpr-ios)
|
||||
- [iOS React Native](https://github.com/cardash/react-native-openalpr)
|
||||
- [Xamarin](https://github.com/kevinjpetersen/openalpr-xamarin)
|
||||
|
||||
If all went well, there should be an executable named *alpr* along with *libopenalpr-static.a* and *libopenalpr.so* that can be linked into your project.
|
||||
If all went well, there should be an executable named _alpr_ along with _libopenalpr-static.a_ and _libopenalpr.so_ that can be linked into your project.
|
||||
|
||||
Docker
|
||||
------
|
||||
## Docker
|
||||
|
||||
``` shell
|
||||
```shell
|
||||
# Build docker image
|
||||
docker build -t openalpr https://github.com/openalpr/openalpr.git
|
||||
# Download test image
|
||||
@@ -151,22 +142,19 @@ wget http://plates.openalpr.com/h786poj.jpg
|
||||
docker run -it --rm -v $(pwd):/data:ro openalpr -c eu h786poj.jpg
|
||||
```
|
||||
|
||||
Questions
|
||||
---------
|
||||
## Questions
|
||||
|
||||
Please post questions or comments to the Google group list: https://groups.google.com/forum/#!forum/openalpr
|
||||
|
||||
## Contributions
|
||||
|
||||
Contributions
|
||||
-------------
|
||||
Improvements to the OpenALPR library are always welcome. Please review the [OpenALPR design description](https://github.com/openalpr/openalpr/wiki/OpenALPR-Design) and get started.
|
||||
Improvements to the OpenALPR library are always welcome. Please review the [OpenALPR design description](https://github.com/openalpr/openalpr/wiki/OpenALPR-Design) and get started.
|
||||
|
||||
Code contributions are not the only way to help out. Do you have a large library of license plate images? If so, please upload your data to the anonymous FTP located at upload.openalpr.com. Do you have time to "tag" plate images in an input image or help in other ways? Please let everyone know by posting a note in the forum.
|
||||
Code contributions are not the only way to help out. Do you have a large library of license plate images? If so, please upload your data to the anonymous FTP located at upload.openalpr.com. Do you have time to "tag" plate images in an input image or help in other ways? Please let everyone know by posting a note in the forum.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
## License
|
||||
|
||||
Affero GPLv3
|
||||
http://www.gnu.org/licenses/agpl-3.0.html
|
||||
|
||||
Commercial-friendly licensing available. Contact: info@openalpr.com
|
||||
Commercial-friendly licensing available. Contact: info@openalpr.com
|
||||
|
||||
Reference in New Issue
Block a user