Metadata-Version: 2.1
Name: brambox
Version: 5.0.0
Summary: Basic Requisites for Algorithms on iMages toolBOX
Author: EAVISE, Tanguy Ophoff, Maarten Vandersteegen
License: Copyright 2017 EAVISE
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://gitlab.com/EAVISE/brambox
Project-URL: Documentation, https://eavise.gitlab.io/brambox
Project-URL: Repository, https://gitlab.com/EAVISE/brambox
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas >=1.1
Requires-Dist: scipy
Requires-Dist: tqdm >=4.27
Provides-Extra: segment
Requires-Dist: pgpd >=3.0.3 ; extra == 'segment'
Provides-Extra: segmentation
Requires-Dist: pgpd >=3.0.3 ; extra == 'segmentation'

<img src="https://gitlab.com/EAVISE/brambox/raw/master/docs/.static/logo-wide.png" alt="Logo" width="1000" />

_Basic Requisites for Algorithms on iMages toolBOX_

[![Version][version-badge]][release-url]
[![Documentation][documentation-badge]][documentation-url]
[![Pipeline][pipeline-badge]][pipeline-url]
[![Coverage][coverage-badge]][coverage-url]
<a href="https://ko-fi.com/D1D31LPHE"><img alt="Ko-Fi" src="https://www.ko-fi.com/img/githubbutton_sm.svg" height="20"></a>  
[![Python][python-badge]][python-url]
[![Pandas][pandas-badge]][pandas-url]
[![Wheel][wheel-badge]][wheel-url]

Brambox is a python toolbox that provides the necessary tools to convert image annotations, compute statistics and more.
Its main use is for object detection algorithms and datasets.


## Installing
```bash
# From wheel
pip install brambox

# From source
pip install git+https://gitlab.com/eavise/brambox
```
> This project is python 3.6 and higher so on some systems you might want to use 'pip3.6' instead of 'pip'


## Using
Once you installed brambox, you can import it in your own python program with:
```python
import brambox as bb
```
For tutorials and the API documentation [click here][documentation-url].


## Contributing
See [the contribution guidelines](CONTRIBUTING.md)


## Main Contributors
Here is a list of people that made noteworthy contributions and helped to get this project where it stands today!

  - [Tanguy Ophoff](https://gitlab.com/0phoff) [![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D31LPHE)
  - [Maarten Vandersteegen](https://gitlab.com/maartenvds)


[version-badge]: https://img.shields.io/pypi/v/brambox.svg?label=version
[release-url]: https://gitlab.com/EAVISE/brambox/tags
[documentation-badge]: https://img.shields.io/badge/-Documentation-2E90D1.svg
[documentation-url]: https://eavise.gitlab.io/brambox
[pipeline-badge]: https://gitlab.com/EAVISE/brambox/badges/master/pipeline.svg
[pipeline-url]: https://gitlab.com/EAVISE/brambox/-/pipelines
[coverage-badge]: https://img.shields.io/codecov/c/gitlab/eavise/brambox?token=EG18cFdzfX
[coverage-url]: https://codecov.io/gl/EAVISE/brambox
[python-badge]: https://img.shields.io/badge/python-3.6%20%7C%203.12-9cf
[python-url]: https://python.org
[pandas-badge]: https://img.shields.io/badge/pandas-1.1%2B-e70488
[pandas-url]: https://pandas.pydata.org
[wheel-badge]: https://img.shields.io/pypi/wheel/brambox.svg
[wheel-url]: https://pypi.org/project/brambox
