Metadata-Version: 2.1
Name: bbox-utils
Version: 0.0.9
Summary: Utilities to easily convert between different bounding box formats (YOLO, XYWH, XYXY, etc.).
Home-page: https://github.com/EricWiener/bbox-utils.git
Author: Eric Wiener
Author-email: ericwiener3@gmail.com
License: MIT
Project-URL: Documentation, https://bbox-utils.readthedocs.io/en/latest/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst; charset=UTF-8
Requires-Dist: numpy (>=1.13.3)
Requires-Dist: pyquaternion
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: testing
Requires-Dist: setuptools ; extra == 'testing'
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: numpy (>=1.13.3) ; extra == 'testing'
Requires-Dist: pillow ; extra == 'testing'
Requires-Dist: pyquaternion ; extra == 'testing'

==========
bbox-utils
==========

Utilities to easily convert between different bounding box formats (YOLO, XYWH, XYXY, etc.).

Description
===========
You can find documentation for the project at `here <https://bbox-utils.readthedocs.io/en/latest/>`_.

**2D Bounding Box Conversions**

* List of points [top left, top right, bottom right, bottom left]
* XYWH: top left, width, height
* XYXY: top left, bottom right
* YOLO

**3D Bounding Box Conversions**
You can create a 3D bounding box with either:

* A center point, width, height, depth, and rotation
* The back-bottom-left point, width, height, depth, and rotation

You can convert between the two forms and also get a triangular polygon to use for plotting triangular meshes.

The majority of the 3D Bounding Box implementation comes from the `bbox PyPI package
<https://github.com/varunagrawal/bbox>`_.

Making Changes & Contributing
=============================

This project uses `pre-commit`_, please make sure to install it before making any
changes::

    pip install pre-commit
    cd bbox-utils
    pre-commit install

It is a good idea to update the hooks to the latest version::

    pre-commit autoupdate


.. _pre-commit: http://pre-commit.com/

Note
====

This project has been set up using PyScaffold 4.0rc1. For details and usage
information on PyScaffold see https://pyscaffold.org/.


