imageio.plugins.opencv.OpenCVPlugin.properties#

OpenCVPlugin.properties(index: Optional[int] = None, colorspace: Optional[Union[int, str]] = None, flags: int = cv2.IMREAD_COLOR) → ImageProperties[source]#

Standardized image metadata.

Parameters:

indexint, Ellipsis: If int, get the properties of the index-th image in the ImageResource. If ..., get the properties of the image stack that contains all images. If None (default), use index=0 if the image contains exactly one image and index=... otherwise.
colorspacestr, int: The colorspace to convert into after loading and before returning the image. If None (default) keep grayscale images as is, convert images with an alpha channel to RGBA and all other images to RGB. If int, interpret colorspace as one of OpenCVs conversion flags and use it for conversion. If str, convert the image into the given colorspace. Possible string values are: "RGB", "BGR", "RGBA", "BGRA", "GRAY", "HSV", or "LAB".
flagsint: The OpenCV flag(s) to pass to the reader. Refer to the OpenCV docs for details.

Returns:

propsImageProperties: A dataclass filled with standardized image metadata.

Notes

Reading properties with OpenCV involves decoding pixel data, because OpenCV doesn’t provide a direct way to access metadata.