bounding-box

KO | EN

gitlite — search

#python #hacktoberfest #golang #go #rust #linux #docker #macos #java #awesome #kubernetes #awesome-list #security #pytorch

(★ 101)

Bounding Box is a library to plot pretty bounding boxes with a simple Python API.

File Explorer

Download Latest Version (.zip)

- __init__.py
- bounding_box.py
- Ubuntu-B.ttf
- - clarifloue.jpg
  - clarifloue_bb.png
  - khatia.jpg
  - khatia_bb.png
  - nao-romeo-pepper.jpg
  - nao-romeo-pepper_bb.png
  - paragliders.jpg
  - paragliders_bb.png
  - pobb.jpg
  - pobb_bb.png
  - selfie.jpg
  - selfie_bb.png
  - ski-paraglider.jpg
  - ski-paraglider_bb.png
  - winton.jpg
  - winton_bb.png
- examples.py
.gitignore
LICENSE
MANIFEST.in
README.md
setup.py

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bounding Box
**Bounding Box** is a library to plot pretty bounding boxes with a simple Python API.

*Please notice this lib does **not** do object detection for you, but only helps to display pretty bounding boxes with a carefully chosen set of colors.*

<table>
<tr>
  <td>Latest Release</td>
  <td>
    <a href="https://pypi.org/project/bounding-box/">
    <img src="https://img.shields.io/pypi/v/bounding-box.svg" alt="latest release" />
    </a>
  </td>
</tr>
<tr>
  <td>License</td>
  <td>
    <a href="https://github.com/nalepae/bounding-box/blob/master/LICENSE">
    <img src="https://img.shields.io/pypi/l/bounding-box.svg" alt="license" />
    </a>
  </td>
</tr>
</table>

**WARNING:** Version 1.0 of this library is not yet released. API breaking changes could still occur!

Please see below some examples of bounding boxes plotted with this library.

## Installation
`$ pip install bounding-box [--user]`

## API
First, you have to import `bounding_box`:
```python
from bounding_box import bounding_box as bb
```

Then, just add the bounding box on an image.
 ```python
bb.add(image, left, top, right, bottom, label, color)
```

This method takes 5 mandatory parameters:
- `image`: A numpy array, channel last (ie. height x width x colors) with
channels in **BGR** order (same as **openCV** format).
- `left`: A integer representing the left side of the bounding box.
- `top`: A integer representing the top side of the bounding box.
- `right`: A integer representing the right side of the bounding box.
- `bottom`: A integer representing the bottom side of the bounding box.

This method takes also 2 optional parameters:
- `label`: A string representing the label of the bounding box.
If not specified, then no label is displayed.
- `color`: A string representing the color of the bounding box.
Possible values are: `navy`, `blue`, `aqua`, `teal`, `olive`, `green`,
`lime`, `yellow`, `orange`, `red`, `maroon`, `fuchsia`, `purple`,
`black`, `gray` ,`silver`.
If `label` is specified and `color` is not, then a color depending
on the `label` is randomly chosen.
If neither `color` and `label` is specified then the bounding box
color is defaulted to `green`.

## Examples
The script to plot exemples of this **README** is available
[here](https://github.com/nalepae/bounding-box/blob/master/docs/examples.py).

To run it, go in top level of this git repository then write:
 ```bash
python docs/examples.py
```

If you run `examples.py` in an other directory it won't work.

bounding-box

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

bounding-box

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README