Skip to content

Commit aa6bb24

Browse files
committed
Added README.md
1 parent d8fb092 commit aa6bb24

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# License Plate Recognition System
2+
3+
This project is a License Plate Recognition system that utilizes a combination of computer vision and machine learning techniques to identify and process license plates from video footage.
4+
5+
## Project Structure
6+
7+
The project is organized as follows:
8+
9+
- `main.py`: The main script that provides a GUI for uploading videos, processing them, and exporting the results.
10+
- `models/`: Contains the pre-trained models for license plate detection and object detection.
11+
- `license_plate_detector.pt`: The model for detecting license plates.
12+
- `yolov8n.pt`: The YOLO model for object detection.
13+
- `sort/`: Implements the SORT algorithm for object tracking.
14+
- `sort.py`: The main SORT algorithm implementation.
15+
- `data/`: Training data for the SORT algorithm.
16+
- `src/`: Contains the core functionality for processing videos and license plates.
17+
- `get_plates.py`: Functions for extracting license plate data.
18+
- `interpolate.py`: Interpolation utilities for smoothing bounding box coordinates.
19+
- `process.py`: Core processing functions for video and license plate recognition.
20+
- `util.py`: Utility functions.
21+
- `visualize.py`: Functions for visualizing the results.
22+
23+
## Setup
24+
25+
To set up the project, follow these steps:
26+
27+
1. Ensure Python 3.8 or higher is installed.
28+
2. Install the required Python packages by running `pip install -r requirements.txt`.
29+
3. Download the pre-trained models and place them in the `models/` directory.
30+
31+
## Usage
32+
33+
To use the system, run `main.py` and follow the GUI prompts:
34+
35+
1. Upload a video file.
36+
2. Click "Process Video" to start the license plate recognition process.
37+
3. Export the results to an Excel file or visualize the processed video.
38+
39+
## Dependencies
40+
41+
- filterpy
42+
- scikit-image
43+
- pandas
44+
- ultralytics
45+
- easyocr
46+
- scipy
47+
- lap
48+
- opencv-python
49+
50+
## License
51+
52+
This project is licensed under the MIT License - see the LICENSE file for details.

0 commit comments

Comments
 (0)