cvhelper 0.1.0
A helper package for OpenCV
License: MIT
Requires Python: >=3.7
Keywords: opencv

# Simple helper package for opencv-python
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

cvhelper is a simpler wrapper for the opencv-python package. As mentioned package only
gives access to OpenCV functions, in a C++ style, it can be tedious to write. There is
also no support for the OpenCV classes like Rect, Point etc. cvhelper attempts to fix that.

The package is at an early state, and contributions are welcome! The contents of the package
have been a demand-and-supply model, where functionality is added as new tedious things in
opencv-python are found. Do not hesitate to file an issue, requesting new functionality or 
enhancement proposals! 

## Installation
Installation is by the python package manager, pip. 
```bash
pip install cvhelper
```
This also installs the dependencies `opencv-python`, `opencv-contrib-python` and `numpy`, if not already present.

## Examples
### Reading videos
This code speaks for itself.

Vanilla OpenCV:
```python
import cv2 as cv
video = cv.VideoCapture("path/to/file")
if not video.isOpened():
    raise ValueError("Could not open video")

while True:
    ok, frame = video.read()
    if not ok:
        break
    cv.imshow("Frame", frame)
    if cv.waitKey(0) & 0xFF == ord('q'):
        break 
video.release()
``` 

cvhelper:
```python
import cv2 as cv
import cvhelper as cvh
with cvh.load_video("path/to/file") as video:
   for frame in cvh.read_frames(video, start, stop, step):
       cv.imshow("Frame", frame)
       if cvh.wait_key(0) == ord('q'):
            break 
```

### Rotate A Color Wheel
Say we have the following color wheel image, which we want to rotate.

![alt text](https://raw.githubusercontent.com/anbergem/cvhelper/master/images/color_wheel.png)

We of course want to rotate it at it's center, which is not in the center
of the image. A possible solution using OpenCV would be 

```python
import cv2 as cv
import random

img = cv.imread("resources/color_wheel_invert.png")
gray = cv.cvtColor(img, cv.COLOR_BGR2GRAY)
_, otsu = cv.threshold(gray, 250, 255, cv.THRESH_BINARY_INV)
_, contours, _ = cv.findContours(otsu, cv.RETR_EXTERNAL, cv.CHAIN_APPROX_SIMPLE)
contour = contours[0]
rect = cv.boundingRect(contour)  # Gives a tuple (x, y, w, h)
x, y, w, h = rect

color = [random.randint(0, 255) for _ in range(3)]

degrees = 60
center = (x + w / 2), (y + h / 2)
rotation_matrix = cv.getRotationMatrix2D(center, degrees, 1)
rotated_image = cv.warpAffine(img, rotation_matrix, gray.shape[::-1])

cv.rectangle(rotated_image, (x, y), (x + w, y + h), color)

cv.imshow("Image", rotated_image)
cv.waitKey(0)
```
We first convert the image to gray scale. The color wheel in gray scale does not 
contain any values of pure white. We can therefore threshold the image at a high
threshold, to segment the color wheel. 

We then find contours in the image (which in this case only will be one contour), and
find the bounding rectangle enclosing the contour. From this rectangle we can find the center
point by the means of the top left corner, the height and width. We use this to create
a rotation matrix, and call the affine warp function. Lastly, we draw a rectangle around
the found contour. This is just for viewing pruposes.

We get the following result.

![alt text](https://raw.githubusercontent.com/anbergem/cvhelper/master/images/helper.png)

Although a perfectly fine solution, we cannot help but rotate the whole image.
Here is a solution using cvhelper.

cvhelper:
```python
import cv2 as cv
import cvhelper as cvh

img = cv.imread("resources/color_wheel_invert.png")
gray = cvh.bgr2gray(img)
otsu = cvh.threshold_binary(gray, 250, inverse=True)
contours = cvh.find_external_contours(otsu)
contour = contours[0]
rect = contour.bounding_rect  # Gives a Rect object
degrees = 60

center = rect.center  # Gives a Point object
top_left = rect.tl  # Gives a Point object
new_center = center - top_left 
img[rect.slice] = cvh.rotate_image(
    img[rect.slice], new_center, degrees, unit=cvh.AngleUnit.DEGREES
)
cvh.rectangle(img, rect, cvh.Color.RANDOM)

cv.imshow("Image", img)
cvh.wait_key(0)
```
We again follow the same approach. However, with the Contour class, we can
simply call the bounding rect property. This yields a Rect object, which
has a center property. Convenient. 

Where we before were left with no (obvious) choice but to rotate the whole image,
we can now simply slice the image at the rectangle, only rotating the figure itself.
For this exact purpose, it doesn't make much different, but it is a demonstration.
We find the new center from which to rotatet, and simply call the rotate image function. 
We can here choose whether to use degrees or radians. Lastly we draw a rectangle with
a random color.

We get the following result.

![alt text](https://raw.githubusercontent.com/anbergem/cvhelper/master/images/opencv.png)

Not only is this a tad less tedious to write, but we are also easily able to 
rotate only the relevant part of the circle by slicing. The contour, rectangle
and point objects are also an ease to work with. 

### Other Area of Ease
While not providing examples, there are many other parts of the OpenCV 
that become an ease to work with, when using cvhelper. Areas include

* Morphology 
* Image normalization
* Color conversion
* Thresholding
* Image smoothing