o
hm- @ s d Z ddlZddlmZ ddlmZmZmZmZm Z ddl
Z
ddl Z ddl
mZ ddlmZmZmZ ddlmZmZ dd lmZ G d
d d eZdS ) ag Read/Write images using OpenCV.
Backend Library: `OpenCV `_
This plugin wraps OpenCV (also known as ``cv2``), a popular image processing
library. Currently, it exposes OpenCVs image reading capability (no video or GIF
support yet); however, this may be added in future releases.
Methods
-------
.. note::
Check the respective function for a list of supported kwargs and their
documentation.
.. autosummary::
:toctree:
OpenCVPlugin.read
OpenCVPlugin.iter
OpenCVPlugin.write
OpenCVPlugin.properties
OpenCVPlugin.metadata
Pixel Formats (Colorspaces)
---------------------------
OpenCV is known to process images in BGR; however, most of the python ecosystem
(in particular matplotlib and other pydata libraries) use the RGB. As such,
images are converted to RGB, RGBA, or grayscale (where applicable) by default.
N)Path)AnyDictListOptionalUnion )Request) URI_BYTESInitializationErrorIOMode)ImagePropertiesPluginV3) ArrayLikec
s e Zd Zdeddf fdd Zddejddedeee f d ede
j fd
d Z dejfdeee f d ede
j fd d
Z
ddeeee f dedee dee fddZddejfdedeee f d edefddZ ddededee ef fddZ ZS ) OpenCVPluginrequestreturnNc s t | | | _|jtu rd| _n|j| _|jj }|t
j kr0t
| js0td| j d|t
jkrDt | jsFtd| j dd S d S )NzzOpenCV can't read ``.zOpenCV can't write to `)super__init__get_local_filename file_handle _uri_typer
filenameraw_urimodeio_moder readcv2haveImageReaderr writehaveImageWriter)selfr r __class__ Q/var/www/html/scripts/venv/lib/python3.10/site-packages/imageio/plugins/opencv.pyr / s
zOpenCVPlugin.__init__)index
colorspaceflagsr' r( r) c
sH |du rt | j|}|dkrdnd}|du r$t j| j|d\}}d}nt j| j|d|d\}}d}|du rBtd| d | j d
|d jd krPd }|pNd } n|d jd
dkr`d}|p^d} nd}|ped} t|t rn| n||
krwd n|
} t t d| d| durt
fdd|D }nt
|}|r|S |d S )a Read an image from the ImageResource.
Parameters
----------
index : int, Ellipsis
If int, read the index-th image from the ImageResource. If ``...``,
read all images from the ImageResource and stack them along a new,
prepended, batch dimension. If None (default), use ``index=0`` if
the image contains exactly one image and ``index=...`` otherwise.
colorspace : str, 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"``.
flags : int
The OpenCV flag(s) to pass to the reader. Refer to the `OpenCV docs
`_
for details.
Returns
-------
ndimage : np.ndarray
The decoded image as a numpy array.
N r .)r) TFzCould not read index `z` from `r r GRAY BGRARGBABGRRGBCOLOR_2c s g | ]}t | qS r% )r cvtColor.0x cvt_spacer% r&
s z%OpenCVPlugin.read..)r imcountr imreadmulti
ValueErrorr ndimshape
isinstanceintuppergetattrnpstack)
r" r' r( r) n_imagesretvalimgis_batch
in_colorspaceout_colorspacer% r8 r& r > s8 &
zOpenCVPlugin.readc c s. t t| jD ] }| j|||dV q dS )aU Yield images from the ImageResource.
Parameters
----------
colorspace : str, 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"``.
flags : int
The OpenCV flag(s) to pass to the reader. Refer to the `OpenCV docs
`_
for details.
Yields
------
ndimage : np.ndarray
The decoded image as a numpy array.
r' r) r( N)ranger r; r r )r" r( r) idxr% r% r& iter s zOpenCVPlugin.iterFndimagerI paramsc C s t |tr
tj|dd}n|s|d }|d jdkr d}n|d jd }|dkr0dd |D }n|d kr`_.
Returns
-------
encoded_image : bytes, None
If the ImageResource is ``""`` the call to write returns the
encoded image as a bytes string. Otherwise it returns None.
r )axis)N.r r* r, c S s g | ]}|qS r% r% r5 r% r% r& r: s z&OpenCVPlugin.write..r- c S g | ] }t |t jqS r% )r r4 COLOR_RGBA2BGRAr5 r% r% r& r: c S rS r% )r r4
COLOR_RGB2BGRr5 r% r% r& r: rU FzOpenCV failed to write.N)r@ listrD rE r> r? r imwritemultir IOErrorr r r
r
read_bytes)r" rP rI rQ
n_channels ndimage_cv2rG r% r% r& r s$
zOpenCVPlugin.writec C s |du rt | j|}|dk}n|tu r t | j|}d}nd}|r8| jd||d}t|g|jR |j|ddS | j|||d}t|j|jddS ) aV Standardized image metadata.
Parameters
----------
index : int, 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.
colorspace : str, 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"``.
flags : int
The OpenCV flag(s) to pass to the reader. Refer to the `OpenCV docs
`_
for details.
Returns
-------
props : ImageProperties
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.
Nr* TFr rL )r? dtyperF rI )r? r] rI )r r; r Ellipsisr r
r? r] )r" r' r( r) rF rI rH r% r% r&
properties s" *
zOpenCVPlugin.propertiesTexclude_appliedc C s t dt t S )aj Format-specific metadata.
.. warning::
OpenCV does not support reading metadata. When called, this function
will raise a ``NotImplementedError``.
Parameters
----------
index : int
This parameter has no effect.
exclude_applied : bool
This parameter has no effect.
z)OpenCV does not support reading metadata.)warningswarn UserWarningdict)r" r' r` r% r% r& metadata& s zOpenCVPlugin.metadata)FN)NT)__name__
__module__ __qualname__r r r IMREAD_COLORrA r strrD ndarrayr rO r r boolr bytesr r
r_ r r re
__classcell__r% r% r# r& r . sl
O
$
<
A
r )__doc__ra pathlibr typingr r r r r r numpyrD corer core.requestr
r r core.v3_plugin_apir
r r r r% r% r% r& s