cv2-rgb/README.md

# Image Decode Implementation with CV2

*author: Kaiyuan Hu, Rentong Guo*

<br />

## Description

An image decode operator implementation with OpenCV.

<br />

## Code Example

Load a image from path './src_dog.jpg'. 

*Write a pipeline with explicit inputs/outputs name specifications:*

```python
from towhee.dc2 import pipe, ops, DataCollection

p = (
  pipe.input('path')
  .map('path', 'image', ops.image_decode.cv2_rgb())
  .output('path', 'image')
)
```

<img src="./result.png" height="150px"/>



<br />



## Factory Constructor

Create the operator via the following factory method:

***image_decode.cv2_rgb()***



<br />



## Interface

An image decode operator takes an image path as input. It decodes the image back to ndarray.



**Parameters:**

**img**: *str*

​	Image file path.



**Returns**: *towhee.types.Image (a sub-class of numpy.ndarray)* 

​	The decoded image data as numpy.ndarray.