Skip to main content

A fast automatic number-plate recognition (ANPR) library

Project description

alt-text

Build Status GitHub release (latest by date) Python Versions License: AGPL-3.0 GitHub stars

Introduction

A fast automatic number-plate recognition (ANPR) library. This package employs YOLOv8, a lightweight model, for detection, and Paddle OCR, a lightweight optical character recognition (OCR) library, for recognizing text in detected number plates. Example outputs

Installation

pip install fastanpr

Usage

import cv2
from fastanpr import FastANPR

# Create an instance of FastANPR
fastanpr = FastANPR()

# Load images (images should be of type numpy ndarray)
files = [...]
images = [cv2.cvtColor(cv2.imread(file), cv2.COLOR_BGR2RGB) for file in files]

# Run ANPR on the images
number_plates = await fastanpr.run(images)

# Print out results
for file, plates in zip(files, number_plates):
    print(file)
    for plate in plates:
        print("Plate Attributes:")
        print("Detection bounding box:", plate.det_box)
        print("Detection confidence:", plate.det_conf)
        print("Recognition text:", plate.rec_text)
        print("Recognition polygon:", plate.rec_poly)
        print("Recognition confidence:", plate.rec_conf)
        print()
    print()

Class: FastANPR

Methods

run(images: List[np.ndarray] -> List[List[NumberPlate]]

Runs ANPR on a list of images and return a list of detected number plates.

  • Parameters:

    • images (List[np.ndarray]): A list of images represented as numpy ndarray.
  • Returns:

    • List[List[NumberPlate]]: A list of detected number plates for every image.

Class: NumberPlate

Attributes

  • det_box (List[int]): Bounding box coordinates of detected number plate.
  • det_conf (float): Confidence score of number plate detection.
  • rec_text (str): Recognized plate number.
  • rec_poly (List[List[int]]): Polygon coordinates of detected texts.
  • rec_conf (float): Confidence score of recognition.

Licence

This project incorporates the YOLOv8 model from Ultralytics, which is licensed under the AGPL-3.0 license. As such, this project is also distributed under the GNU Affero General Public License v3.0 (AGPL-3.0) to comply with the licensing requirements.

For more details on the YOLOv8 model and its license, please visit the Ultralytics GitHub repository.

Contributing

We warmly welcome contributions from the community! If you're interested in contributing to this project, please start by reading our CONTRIBUTING.md guide.

Whether you're looking to submit a bug report, propose a new feature, or contribute code, we're excited to see what you have to offer. Please don't hesitate to reach out by opening an issue or submitting a pull request.

Thank you for considering contributing to our project. Your support helps us make the software better for everyone.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastanpr-0.1.2.tar.gz (5.7 MB view details)

Uploaded Source

Built Distribution

fastanpr-0.1.2-py3-none-any.whl (5.7 MB view details)

Uploaded Python 3

File details

Details for the file fastanpr-0.1.2.tar.gz.

File metadata

  • Download URL: fastanpr-0.1.2.tar.gz
  • Upload date:
  • Size: 5.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for fastanpr-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c4efea66bc8d05191d31fed158e9c6f81622fe1466a9963d28b1b33268b7417d
MD5 de052a0c20fafe86d01041454ad83d1a
BLAKE2b-256 c533f6bf5b9544d7a69a620cbffa5f11ed289280c4d262b3aa4cbaf1f43eef7c

See more details on using hashes here.

File details

Details for the file fastanpr-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: fastanpr-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for fastanpr-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7e1385723f7860383823d2316842c3419558f934397025c12956d01a7dd5db31
MD5 aafd98fa37c93a0bfa74920f16ab11c5
BLAKE2b-256 04770129e5965658b8a409876216672a238aa9c993b11fea9b45693a45e3ff33

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page