imageio.v3.imiter#

imageio.v3.imiter(uri, *, plugin=None, extension=None, format_hint=None, **kwargs)[source]#

Read a sequence of ndimages from a URI.

Returns an iterable that yields ndimages from the given URI. The exact behavior depends on both, the file type and plugin used to open the file. To learn about the exact behavior, check the documentation of the relevant plugin.

Parameters:
uri{str, pathlib.Path, bytes, file}

The resource to load the image from, e.g. a filename, pathlib.Path, http address or file object, see the docs for more info.

plugin{str, None}

The plugin to use. If set to None (default) imiter will perform a search for a matching plugin. If not None, this takes priority over the provided format hint (if present).

extensionstr

If not None, treat the provided ImageResource as if it had the given extension. This affects the order in which backends are considered.

format_hintstr

A format hint to help optimize plugin selection given as the format’s extension, e.g. “.png”. This can speed up the selection process for ImageResources that don’t have an explicit extension, e.g. streams, or for ImageResources where the extension does not match the resource’s content. If the ImageResource lacks an explicit extension, it will be set to this format.

**kwargs

Additional keyword arguments will be passed to the plugin’s iter call.

Yields:
imagendimage

The next ndimage located at the given URI.