Skip to main content

An interactive PyQt5 image annotation tool for segmentation masks and bounding boxes.

Project description

Tadqeeq โ€“ Image Annotator Tool

An interactive image annotation tool built with PyQt5, designed for efficient labeling of segmentation masks and bounding boxes.

Developed by Mohamed Behery @ RTR Software Development - An "Orbits" Subsidiary ๐Ÿ“… April 30, 2025 ๐Ÿชช Licensed under the MIT License


๐Ÿš€ Widget Features

  • โœ… Minimalist Interactive Design
  • ๐Ÿ–Œ๏ธ Scroll through label classes / Adjust pen size with the mouse wheel
  • ๐ŸŽจ Supports segmentation masks (.png) and bounding boxes (.txt)
  • ๐Ÿง  Dynamic label color generation (HSV-based)
  • ๐Ÿ’ฌ Floating labels showing hovered and selected classes
  • ๐Ÿ’พ Auto-save and manual save (Ctrl+S)
  • ๐Ÿงฝ Flood-fill segmentation with a postprocessing stage of binary hole filling
  • ๐Ÿšซ Right-click erase mode and double-click to clear all

๐Ÿš€ CLI Features

  • โœ… Minimalist Design
  • ๐ŸŽจ Navigate through images using A and D.

๐Ÿ“ฆ Installation

Option 1: Install via pip

pip install tadqeeq

Option 2: Run from source

git clone https://github.com/orbits-it/tadqeeq.git
cd tadqeeq
pip install -r requirements.txt

๐Ÿ› ๏ธ Usage

Import in your code:

from tadqeeq import ImageAnnotator

Run CLI tool from command line (if installed via pip):

tadqeeq [--autosave|--use_bounding_boxes]* <images_directory_path> <annotations_directory_path>

Notes: 1. Use A and D to navigate through images. 2. If "--use_bounding_boxes" is included: a) the annotations files are PNG for segmentation masks with class-labeled pixels on a white background. b) the annotations files are txt for YOLO-style bounding boxes formatted as: label_index x_offset y_offset width height


๐Ÿงญ Controls

Action Mouse/Key
Draw / Fill segment Left-click / double-click
Erase (one object) Right-click + Left-click
Toggle erase mode Right-click
Clear all Double right-click
Scroll through labels / Adjust pen size Mouse wheel
Save annotations Ctrl+S
Show label on hover Hover cursor
Navigate through images (CLI only) A / D

๐Ÿ“ Project Structure

root/
โ”œโ”€โ”€ tadqeeq/
|   โ”œโ”€โ”€ __init__.py         # Entry point for importing
|   โ”œโ”€โ”€ widgets.py          # Contains ImageAnnotator class
|   โ”œโ”€โ”€ utils.py            # Helper methods (flood fill, bounding box logic)
|   โ”œโ”€โ”€ implementations.py  # Contains an example integration of ImageAnnotator class
|   โ”œโ”€โ”€ cli.py              # Entry point for full solution
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ LICENSE
โ”œโ”€โ”€ setup.py
โ”œโ”€โ”€ pyproject.toml
โ””โ”€โ”€ requirements.txt

๐Ÿง‘โ€๐Ÿ’ป Contributing

Repository

Pull requests are welcome!
If you add features (e.g. COCO export, brush tools, batch processing), please document them in the README.


๐Ÿ“„ License

This project is licensed under the MIT License.
See LICENSE for the full license text.


๐Ÿ’ก Acknowledgements

๐ŸŽ‰ Built for computer vision practitioners needing fast, mouse-based labeling with clean overlays and autosave logic.

๐ŸŒŸ Special thanks to PyQt5 for providing the powerful and flexible GUI toolkit that made the development of this interactive image annotator possible.


๐Ÿ”— Related Resources

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

tadqeeq-1.4.3.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tadqeeq-1.4.3-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

Details for the file tadqeeq-1.4.3.tar.gz.

File metadata

  • Download URL: tadqeeq-1.4.3.tar.gz
  • Upload date:
  • Size: 43.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for tadqeeq-1.4.3.tar.gz
Algorithm Hash digest
SHA256 806bf1ccca229a16b30b0a8fcef987f4d7800ad53c488ed7989c6bb47dd25c0a
MD5 aef1518c232209b131d03336c076ec07
BLAKE2b-256 561926c42b474efbe2f576dff3769d6f3756a32eb5fed3bfee3aadf927252542

See more details on using hashes here.

File details

Details for the file tadqeeq-1.4.3-py3-none-any.whl.

File metadata

  • Download URL: tadqeeq-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 45.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for tadqeeq-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2c8055c88ac6005defa61eea67bb5c92513982c3f11db514bdb8b5a56e455108
MD5 229bed9fa26991c5d2d9d3d44a9a7a0e
BLAKE2b-256 4390978f844891aa1d78ed52b23f3ca28b9cc904e714755d91ea97a6f1186d41

See more details on using hashes here.

Supported by

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