Skip to main content

Converting bounding box annotations to popular formats like a breeze.

Project description

Bboxtools

Installation

git clone https://github.com/ODAncona/bbox-tools.git
cd bbox-tools
python3 setup.py install

or

pip install bboxtools

See the installation guide for more information.

Introduction

What is a bounding box?

Bounding boxes are a crucial component of object detection algorithms, which are used to identify and classify objects within an image or video. A bounding box is a rectangle that surrounds an object of interest in the image, and is typically represented by a set of coordinates that define the box's position and size. These boxes can be used to locate and extract objects from an image, and can also provide important information about the size, shape, and orientation of the objects

Various types and format

When you work with bounding box you have severals things to consider.

First, the bounding box could be stored in different types like:

  • Top-Left Bottom-Right (TLBR), (x_min, y_min, x_max, y_max)
  • Top-Left Width Height (TLWH), (x_min, y_min, width, height)
  • Center Width Height (CWH), (x_center, y_center, width, height)

Which are popular among different formats like :

  • COCO (Common Objects in Context)
  • Pascal_voc (Visual Object Classes)
  • YOLO (You Only Look Once)

Furthermore, the bounding box could be stored in different file formats like:

  • csv
  • xml
  • json
  • manifest
  • parquet
  • pickle

Goal

The goal of this library is to seamlessly convert bounding box format using easy syntax.

It should be a breeze like...

import bboxtools as bt

# Input file path
input_path1 = './examples/example1.csv'

# Output file path
output_path2 = './examples/output/test2.json'

# Mapping between the input file and the bboxtools format
bbox_map = dict(
    class_name='class',
    file_path='name',
    x_min='top_left_x',
    y_min='top_left_y',
    width='w',
    height='h',
    image_width='img_size_x',
    image_height='img_size_y',
)

# Read the input file
parser = bt.read_csv(input_path1, mapping=bbox_map)

# Export the file to the desired format
parser.export(output_path=output_path2, format='coco')

Documentation

API Reference

How to guide

Tutorials

Explanation

Contributing

Contributions are welcome!

License

This project is licensed under the GPLV3 License - see the LICENSE file for details.

Acknowledgments

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

bboxtools_2-0.0.1-py3-none-any.whl (26.5 kB view details)

Uploaded Python 3

File details

Details for the file bboxtools_2-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: bboxtools_2-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 26.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for bboxtools_2-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 36b51e7ba4ba01bc6f4b288fe7078e06d18e6b1dbbd5517f71ef60d8e4a067be
MD5 3e2870db5e6f08f7246564f4c46859c7
BLAKE2b-256 f6d6152ca3731054946b1881c5544132d80769c536ea393202c781665094c48a

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