Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bensouchet/ibex-1d
Image Barcode EXtractor - Detect and Extract 1D Barcode(s) in photographs
https://github.com/bensouchet/ibex-1d
barcode computer-vision detection-algorithm image-recognition opencv4 python python-3 python3 roi
Last synced: 8 days ago
JSON representation
Image Barcode EXtractor - Detect and Extract 1D Barcode(s) in photographs
- Host: GitHub
- URL: https://github.com/bensouchet/ibex-1d
- Owner: BenSouchet
- License: mit
- Created: 2022-12-23T13:43:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T22:02:53.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T22:22:39.145Z (about 1 month ago)
- Topics: barcode, computer-vision, detection-algorithm, image-recognition, opencv4, python, python-3, python3, roi
- Language: Python
- Homepage: https://pypi.org/project/ibex-1d/
- Size: 72.3 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# IBEX 1D : Image 1D Barcode EXtractor
### Detect 1D Barcode(s) in Photographs, Extract & Straighten them!
A `Python 3` command line script to detect & extract barcode(s) in images, using **OpenCV** and **NumPy**.
## Install
### Via PIP
```sh
pip3 install ibex-1d
```
And for update to latest version use:
```sh
pip3 install --upgrade ibex-1d
```
### Via Source Code
Download the [latest release](https://github.com/BenSouchet/ibex-1d/releases) or clone/download this repository.
## Usage
If you installed the package (via `pip3`) you can either import the package in your project:
```python
import ibex_1d
image_path = "/Users/bensouchet/Desktop/IMG_3212.png"
settings = ibex_1d.Settings()
settings.use_adaptive_threshold = True
barcode_extract = ibex_1d.ImageBarcodeExtract1D(settings)
results = barcode_extract.find_barcodes([image_path])
```
Or use it as a script directly in you terminal:
```sh
ibex_1d -i ~/Desktop/IMG_3212.png
```
If you download a release or clone the repository, to use it as a script:
```sh
python3 ibex_1d.py -i ~/Desktop/IMG_3212.png
```
## Results
If you called **IBEX 1D** via your terminal (as a script), the barcode images extracted will be saved into a newly created folder inside a folder `./results/`, if nothing has been generated please check the log(s) in your terminal.
Otherwise if you called the function `find_barcodes` you will received a python list of `ibex_1d.Result` instances, this class store info about the execution (like execution status, message, debug steps) and the barcode(s) image(s) extracted for each image path passed to the function.
## Multiple images
You can pass one or more images/photographs to the script like this:
```sh
ibex_1d -i ~/Desktop/IMG_3205.png ./object_12.jpg ~/Documents/photo_0345.jpeg
```
Inside the corresponding result sub-folder, extracted barcodes will be named `barcode_001.png`, `barcode_002.png`, `barcode_003.png`, ...
## Incorrect result ?
If the barcode hasn't been extracted (or the resulting barcode image isn't good) this can be due to the OTSU threshold method.
You can try using the script with the argument `-a` (or `--adaptive-threshold`):
```sh
ibex_1d -i ~/Desktop/IMG_3205.png -a
```
This threshold method isn't set as default because it's slower than OTSU.
## Debug
You can visualize some steps of the sheet detection.
For the script call you need to add the argument `-d` or `--debug` to the command:
```sh
ibex_1d -i ~/Documents/product_03.jpeg -d
```
if you imported the package, you need to enable the `save_detection_steps` in the settings instance like this:
```python
settings = Settings()
settings.save_detection_steps = True
barcode_extract = ImageBarcodeExtract1D(settings)
results = barcode_extract.find_barcodes(images_paths)
```
This will add debug/steps images into the result sub-folders.
## Errors / Warnings
In case of an error you should see a formatted log message in your terminal telling you exactly what is the issue.
If the script crash or something don't work you can open an issue [here](https://github.com/BenSouchet/ibex-1d/issues).
## Author / Maintainer
**IBEX 1D** has been created and is currently maintained by [Ben Souchet](https://github.com/BenSouchet).
## Licenses
The code present in this repository is under [MIT license](https://github.com/BenSouchet/ibex-1d/blob/main/LICENSE).