Fix the documentation of the constructor of Image and ImageFrame Python classes.

PiperOrigin-RevId: 495739875
This commit is contained in:
Jiuqiang Tang 2022-12-15 17:40:29 -08:00 committed by Copybara-Service
parent 8d2473c751
commit 6bf5648430
2 changed files with 8 additions and 6 deletions

View File

@ -52,14 +52,15 @@ void ImageSubmodule(pybind11::module* module) {
```python ```python
import cv2 import cv2
cv_mat = cv2.imread(input_file)[:, :, ::-1] cv_mat = cv2.imread(input_file)[:, :, ::-1]
rgb_frame = mp.Image(format=ImageFormat.SRGB, data=cv_mat) rgb_frame = mp.Image(image_format=ImageFormat.SRGB, data=cv_mat)
gray_frame = mp.Image( gray_frame = mp.Image(
format=ImageFormat.GRAY, data=cv2.cvtColor(cv_mat, cv2.COLOR_RGB2GRAY)) image_format=ImageFormat.GRAY,
data=cv2.cvtColor(cv_mat, cv2.COLOR_RGB2GRAY))
from PIL import Image from PIL import Image
pil_img = Image.new('RGB', (60, 30), color = 'red') pil_img = Image.new('RGB', (60, 30), color = 'red')
image = mp.Image( image = mp.Image(
format=mp.ImageFormat.SRGB, data=np.asarray(pil_img)) image_format=mp.ImageFormat.SRGB, data=np.asarray(pil_img))
``` ```
The pixel data in an Image can be retrieved as a numpy ndarray by calling The pixel data in an Image can be retrieved as a numpy ndarray by calling

View File

@ -83,14 +83,15 @@ void ImageFrameSubmodule(pybind11::module* module) {
Creation examples: Creation examples:
import cv2 import cv2
cv_mat = cv2.imread(input_file)[:, :, ::-1] cv_mat = cv2.imread(input_file)[:, :, ::-1]
rgb_frame = mp.ImageFrame(format=ImageFormat.SRGB, data=cv_mat) rgb_frame = mp.ImageFrame(image_format=ImageFormat.SRGB, data=cv_mat)
gray_frame = mp.ImageFrame( gray_frame = mp.ImageFrame(
format=ImageFormat.GRAY, data=cv2.cvtColor(cv_mat, cv2.COLOR_RGB2GRAY)) image_format=ImageFormat.GRAY,
data=cv2.cvtColor(cv_mat, cv2.COLOR_RGB2GRAY))
from PIL import Image from PIL import Image
pil_img = Image.new('RGB', (60, 30), color = 'red') pil_img = Image.new('RGB', (60, 30), color = 'red')
image_frame = mp.ImageFrame( image_frame = mp.ImageFrame(
format=mp.ImageFormat.SRGB, data=np.asarray(pil_img)) image_format=mp.ImageFormat.SRGB, data=np.asarray(pil_img))
The pixel data in an ImageFrame can be retrieved as a numpy ndarray by calling The pixel data in an ImageFrame can be retrieved as a numpy ndarray by calling
`ImageFrame.numpy_view()`. The returned numpy ndarray is a reference to the `ImageFrame.numpy_view()`. The returned numpy ndarray is a reference to the