U
%
dd+ @ 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 Zedd fdd Zddejdeeee f ee
j dddZ dejfeee f ee
j d d
d Z
deeee f eee ee d
ddZddejfeeee f eedddZdeeee ef dddZ ZS ) OpenCVPluginN)requestreturnc s t | | | _|jtkr(d| _n|j| _|jj }|t
j krbt
| jsbtd| j dn(|t
jkrt | jstd| j dd S )NzzOpenCV can't read ``.zOpenCV can't write to `)super__init__Zget_local_filename file_handle _uri_typer
filenameZraw_urimodeZio_moder readcv2ZhaveImageReaderr writeZhaveImageWriter)selfr r __class__ :/tmp/pip-unpacked-wheel-x84omsqu/imageio/plugins/opencv.pyr 0 s
zOpenCVPlugin.__init__)index
colorspaceflags)r" r# r$ r c
sL |dkr&t | j|}|dkr"dnd}|dkrHt j| j|d\}}d}n t j| j|d|d\}}d}|dkrtd| d | j d
|d jd krd }|pd } n,|d jd
dkrd}|pd} n d}|pd} t|t r| n0||
krd n |
} t t d| d| dk r0t
fdd|D }n
t
|}|rD|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 ZGRAY ZBGRAZRGBAZBGRZRGBZCOLOR_2c s g | ]}t | qS r )r cvtColor.0xZ cvt_spacer r!
s z%OpenCVPlugin.read..)r imcountr Z imreadmulti
ValueErrorr ndimshape
isinstanceintuppergetattrnpstack)
r r" r# r$ Zn_imagesretvalimgis_batchZ
in_colorspaceZout_colorspacer r- r! r ? s8 &
zOpenCVPlugin.read)r# r$ r c c s, t t| jD ]}| j|||dV qdS )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.iterF)ndimager; paramsr c C s t |trtj|dd}n |s&|d }|d jdkr:d}n|d jd }|dkr`dd |D }n&|d krxd
d |D }nd d |D }t| j||}|d krt d
| j
j t krt
| j S dS )a$ Save an ndimage in the ImageResource.
Parameters
----------
ndimage : ArrayLike, List[ArrayLike]
The image data that will be written to the file. It is either a
single image, a batch of images, or a list of images.
is_batch : bool
If True, the provided ndimage is a batch of images. If False (default), the
provided ndimage is a single image. If the provided ndimage is a list of images,
this parameter has no effect.
params : List[int]
A list of parameters that will be passed to OpenCVs imwrite or
imwritemulti functions. Possible values are documented in the
`OpenCV documentation
`_.
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 )Zaxis)N.r r% r& c S s g | ]}|qS r r r* r r r! r. s z&OpenCVPlugin.write..r' c S s g | ]}t |t jqS r )r r) ZCOLOR_RGBA2BGRAr* r r r! r. s c S s g | ]}t |t jqS r )r r) Z
COLOR_RGB2BGRr* r r r! r. s FzOpenCV failed to write.N)r3 listr7 r8 r1 r2 r Z imwritemultir IOErrorr r r
r
read_bytes)r r@ r; rA Z
n_channelsZ ndimage_cv2r9 r r r! r s"
zOpenCVPlugin.writer c C s& | j |||d}t|j|j|dkdS )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.
r< .)r2 dtyper; )r r
r2 rE )r r" r# r$ r: r r r!
properties s +zOpenCVPlugin.propertiesT)r" exclude_appliedr c 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" rG r r r! metadata s zOpenCVPlugin.metadata)FN)NT)__name__
__module__ __qualname__r r r Z IMREAD_COLORr4 r strr7 Zndarrayr r? r r boolr bytesr r
rF r r rL
__classcell__r r r r! r / sR
O
$ <
4
r )__doc__rH pathlibr typingr r r r r r Znumpyr7 corer Z core.requestr
r r Zcore.v3_plugin_apir
r r r r r r r! s !