imageio.v3.improps#
- imageio.v3.improps(uri, *, index: Optional[int] = 0, plugin: Optional[str] = None, **kwargs) imageio.core.v3_plugin_api.ImageProperties#
Read standardized metadata.
Opens the given URI and reads the properties of an ndimage from it. The properties represent standardized metadata. This means that they will have the same name regardless of the format being read or plugin/backend being used. Further, any field will be, where possible, populated with a sensible default (may be None) if the ImageResource does not declare a value in its metadata.
- Parameters
- indexint
The index of the ndimage for which to return properties. If the index is out of bounds a
ValueErroris raised. IfNone, return the properties for the ndimage stack. If this is impossible, e.g., due to shape missmatch, an exception will be raised.- plugin{str, None}
The plugin to be used. If None, performs a search for a matching plugin.
- **kwargs
Additional keyword arguments will be passed to the plugin’s
propertiescall.
- Returns
- propertiesImageProperties
A dataclass filled with standardized image metadata.
Notes
Where possible, this will avoid loading pixel data.