Metadata-Version: 2.1
Name: pyROI
Version: 0.2.3
Summary: pyROI — A simple roi selector built by python-opencv
Author-email: Chung-Kuan Chen <b97b01045@gmail.com>
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: numpy
Requires-Dist: opencv-python
Requires-Dist: dataclasses
Requires-Dist: black ; extra == "dev"
Requires-Dist: flake8 ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pytest ; extra == "test"
Project-URL: Home, https://github.com/lycantrope/pyROI
Provides-Extra: dev
Provides-Extra: test

# opencv-roi
pyROI — A simple roi selector built by python-opencv


# Installation

- from pypi
```console
> pip install pyROI
```

- from github
```console
> pip install -U git+https://github.com/lycantrope/pyROI
```
# Usage

```python
import pyROI

img_path = "luna.jpg"
img = cv2.imread(img_path)

# Support rect, circle, polygon, ellipse
rect_roi = pyROI.select(src = img, selector_type =  "rect")
print(rect_roi)

# generate mask
mask = rect_roi.mask
```

