sdkagent

imageio API reference

177 public APIs from imageio (imageio/imageio) — 63 classes, 21 functions, 93 methods. Signatures extracted by static analysis of the actual source.

Repository: imageio/imageio

KindCount
Classes63
Functions21
Methods93

API list

funcimageio.__main__.remove_bin_main()
Argument-parsing wrapper for `remove_bin`
methodimageio.core.format.Format.description()
A short description of this format.
methodimageio.core.format.Format.name()
The name of this format.
classimageio.core.format.FormatManager
The FormatManager is a singleton plugin factory.
funcimageio.core.imopen.imopen(uri, io_mode, *plugin=None, *extension=None, *format_hint=None, *legacy_mode=False, **kwargs)
Open an ImageResource.
methodimageio.core.legacy_plugin_wrapper.LegacyPlugin.metadata(index=None, exclude_applied:bool=True)
Format-Specific ndimage metadata.
methodimageio.core.legacy_plugin_wrapper.LegacyPlugin.properties(index=None)
Standardized ndimage metadata.
classimageio.core.request.InitializationError
The plugin could not initialize from the given request.
classimageio.core.request.Request
ImageResource handling utility.
methodimageio.core.request.Request.extension() -> str
The (lowercase) extension of the requested filename.
methodimageio.core.request.Request.filename()
Name of the ImageResource.
methodimageio.core.request.Request.finish() -> None
Wrap up this request.
methodimageio.core.request.Request.firstbytes()
The first 256 bytes of the file.
methodimageio.core.request.Request.get_result()
For internal use.
methodimageio.core.request.Request.mode()
The mode of the request.
methodimageio.core.util.Array.meta()
The dict with the meta data of this image.
funcimageio.core.util.asarray(a)
Pypy-safe version of np.asarray.
classimageio.core.v3_plugin_api.PluginV3
A ImageIO Plugin.
methodimageio.core.v3_plugin_api.PluginV3.close() -> None
Close the ImageResource.
methodimageio.core.v3_plugin_api.PluginV3.iter() -> Iterator[np.ndarray]
Iterate the ImageResource.
methodimageio.core.v3_plugin_api.PluginV3.metadata(index:int=0, exclude_applied:bool=True) -> Dict[str, Any]
Format-Specific ndimage metadata.
methodimageio.core.v3_plugin_api.PluginV3.properties(index:int=0) -> ImageProperties
Standardized ndimage metadata.
methodimageio.core.v3_plugin_api.PluginV3.read(*index:int=0) -> np.ndarray
Read a ndimage.
methodimageio.core.v3_plugin_api.PluginV3.write(ndimage:Union[ArrayLike, List[ArrayLike]]) -> Optional[bytes]
Write a ndimage to a ImageResource.
classimageio.plugins._bsdf.BaseStream
Base class for streams.
methodimageio.plugins._bsdf.BaseStream.mode()
The mode of this stream: 'r' or 'w'.
classimageio.plugins._bsdf.Blob
Object to represent a blob of bytes.
methodimageio.plugins._bsdf.Blob.get_bytes()
Get the contents of the blob as bytes.
methodimageio.plugins._bsdf.Blob.read(n)
Read n bytes from the blob.
methodimageio.plugins._bsdf.Blob.update_checksum()
Reset the blob's checksum if present.
methodimageio.plugins._bsdf.Blob.write(bb)
Write bytes to the blob.
classimageio.plugins._bsdf.BsdfSerializer
Instances of this class represent a BSDF encoder/decoder.
methodimageio.plugins._bsdf.BsdfSerializer.encode(ob)
Save the given object to bytes.
classimageio.plugins._bsdf.Extension
Base class to implement BSDF extensions for special data types.
classimageio.plugins._bsdf.ListStream
A streamable list object used for writing or reading.
methodimageio.plugins._bsdf.ListStream.append(item)
Append an item to the streaming list.
funcimageio.plugins._bsdf.lendecode(f)
Decode an unsigned integer from a file.
classimageio.plugins._dicom.SimpleDicomReader
This class provides reading of pixel data from DICOM files.
classimageio.plugins._freeimage.FIBitmap
Wrapper for the FI bitmap object.
classimageio.plugins._freeimage.FIMultipageBitmap
Wrapper for the multipage FI bitmap object.
classimageio.plugins._freeimage.Freeimage
Class to represent an interface to the FreeImage library.
classimageio.plugins._swf.SetBackgroundTag
Set the color in 0-255, or 0-1 (if floats given).
methodimageio.plugins._swf.Tag.get_tag()
Calls processTag and attaches the header.
methodimageio.plugins._swf.Tag.process_tag()
Implement this to create the tag.
classimageio.plugins._tifffile.FileHandle
Binary file handle.
methodimageio.plugins._tifffile.FileHandle.close()
Close file.
methodimageio.plugins._tifffile.FileHandle.flush()
Flush write buffers if applicable.
methodimageio.plugins._tifffile.FileHandle.open()
Open or re-open file.
methodimageio.plugins._tifffile.FileHandle.seek(offset, whence=0)
Set file's current position.
methodimageio.plugins._tifffile.FileHandle.tell()
Return file's current position.
methodimageio.plugins._tifffile.FileHandle.write(bytestring)
Write bytestring to file.
methodimageio.plugins._tifffile.FileHandle.write_array(data)
Write numpy array to binary file.
methodimageio.plugins._tifffile.FileHandle.write_empty(size)
Append size bytes to file.
classimageio.plugins._tifffile.NullContext
Null context manager.
classimageio.plugins._tifffile.OpenFileCache
Keep files open.
methodimageio.plugins._tifffile.OpenFileCache.open(filehandle)
Re-open file if necessary.
classimageio.plugins._tifffile.TIFF
Namespace for module constants.
classimageio.plugins._tifffile.TIFF.Compressors
Delay import compressor functions.
classimageio.plugins._tifffile.TIFF.Decompressors
Delay import decompressor functions.
classimageio.plugins._tifffile.TiffFile
Read image and metadata from TIFF file.
methodimageio.plugins._tifffile.TiffFile.andor_metadata()
Return Andor tags as dict.
methodimageio.plugins._tifffile.TiffFile.close()
Close open file handle(s).
methodimageio.plugins._tifffile.TiffFile.filehandle()
Return file handle.
methodimageio.plugins._tifffile.TiffFile.filename()
Return name of file handle.
methodimageio.plugins._tifffile.TiffFile.flags()
Return set of file flags.
methodimageio.plugins._tifffile.TiffFile.is_mdgel()
File has MD Gel format.
methodimageio.plugins._tifffile.TiffFile.is_movie()
Return if file is a movie.
methodimageio.plugins._tifffile.TiffFile.ome_metadata()
Return OME XML as dict.
methodimageio.plugins._tifffile.TiffFile.tvips_metadata()
Return TVIPS tag as dict.
classimageio.plugins._tifffile.TiffFrame
Lightweight TIFF image file directory (IFD).
methodimageio.plugins._tifffile.TiffFrame.aspage()
Return TiffPage from file.
classimageio.plugins._tifffile.TiffPage
TIFF image file directory (IFD).
methodimageio.plugins._tifffile.TiffPage.flags()
Return set of flags.
methodimageio.plugins._tifffile.TiffPage.is_andor()
Page contains Andor Technology tags.
methodimageio.plugins._tifffile.TiffPage.is_fei()
Page contains SFEG or HELIOS metadata.
methodimageio.plugins._tifffile.TiffPage.is_fluoview()
Page contains FluoView MM_STAMP tag.
methodimageio.plugins._tifffile.TiffPage.is_geotiff()
Page contains GeoTIFF metadata.
methodimageio.plugins._tifffile.TiffPage.is_lsm()
Page contains CZ_LSMINFO tag.
methodimageio.plugins._tifffile.TiffPage.is_mdgel()
Page contains MDFileTag tag.
methodimageio.plugins._tifffile.TiffPage.is_nih()
Page contains NIH image header.
methodimageio.plugins._tifffile.TiffPage.is_pilatus()
Page contains Pilatus tags.
methodimageio.plugins._tifffile.TiffPage.is_scanimage()
Page contains ScanImage metadata.
methodimageio.plugins._tifffile.TiffPage.is_sem()
Page contains Zeiss SEM metadata.
methodimageio.plugins._tifffile.TiffPage.is_stk()
Page contains UIC2Tag tag.
methodimageio.plugins._tifffile.TiffPage.is_svs()
Page contains Aperio metadata.
methodimageio.plugins._tifffile.TiffPage.is_tiled()
Page contains tiled image.
methodimageio.plugins._tifffile.TiffPage.is_tvips()
Page contains TVIPS metadata.
methodimageio.plugins._tifffile.TiffPage.is_vista()
Software tag is 'ISS Vista'.
methodimageio.plugins._tifffile.TiffPage.ndim()
Return number of array dimensions.
methodimageio.plugins._tifffile.TiffPage.size()
Return number of elements in array.
classimageio.plugins._tifffile.TiffPageSeries
Series of TIFF pages with compatible shape and data type.
methodimageio.plugins._tifffile.TiffPageSeries.ndim()
Return number of array dimensions.
methodimageio.plugins._tifffile.TiffPageSeries.size()
Return number of elements in array.
classimageio.plugins._tifffile.TiffPages
Sequence of TIFF image file directories.
methodimageio.plugins._tifffile.TiffPages.clear(fully=True)
Delete all but first page from cache.
methodimageio.plugins._tifffile.TiffPages.keyframe()
Return index of current keyframe.
methodimageio.plugins._tifffile.TiffPages.load()
Read all remaining pages from file.
classimageio.plugins._tifffile.TiffSequence
Sequence of TIFF files.
classimageio.plugins._tifffile.TiffTag
TIFF tag structure.
classimageio.plugins._tifffile.TiffWriter
Write numpy arrays to TIFF file.
methodimageio.plugins._tifffile.TiffWriter.close()
Write remaining pages and close file handle.
funcimageio.plugins._tifffile.apply_colormap(image, colormap, contig=True)
Return palette-colored image.
funcimageio.plugins._tifffile.byte2int(b)
Return value of byte as int.
funcimageio.plugins._tifffile.bytes2str(b, encoding=None, errors=None)
Return string from bytes.
funcimageio.plugins._tifffile.enumarg(enum, arg)
Return enum member from its name or value.
funcimageio.plugins._tifffile.identityfunc(arg)
Single argument identity function.
classimageio.plugins._tifffile.lazyattr
Attribute whose value is computed on first access.
funcimageio.plugins._tifffile.main(argv=None)
Command line usage main function.
funcimageio.plugins._tifffile.natural_sorted(iterable)
Return human sorted list of strings.
funcimageio.plugins._tifffile.nullfunc(*args, **kwargs)
Null function.
funcimageio.plugins._tifffile.pformat_xml(xml)
Return pretty formatted XML.
funcimageio.plugins._tifffile.print_(*args, **kwargs)
Print function with flush support.
funcimageio.plugins._tifffile.product(iterable)
Return product of sequence of numbers.
funcimageio.plugins._tifffile.recarray2dict(recarray)
Return numpy.recarray as dict.
funcimageio.plugins._tifffile.reshape_axes(axes, shape, newshape, unknown='Q')
Return axes matching new shape.
funcimageio.plugins._tifffile.str2bytes(s, encoding=None)
Return bytes from string.
funcimageio.plugins._tifffile.xml2dict(xml, sanitize=True, prefix=None)
Return XML as dict.
classimageio.plugins.bsdf.Image
Class in which we wrap the array and meta data.
classimageio.plugins.bsdf.NDArrayExtension
Copy of BSDF's NDArrayExtension but deal with lazy blobs.
classimageio.plugins.dicom.DicomFormat
See :mod:`imageio.plugins.dicom`
classimageio.plugins.example.DummyFormat
The dummy format is an example format that does nothing.
classimageio.plugins.feisem.FEISEMFormat
See :mod:`imageio.plugins.feisem`
classimageio.plugins.ffmpeg.FfmpegFormat
Read/Write ImageResources using FFMPEG.
methodimageio.plugins.ffmpeg.FfmpegFormat.Reader.count_frames()
Count the number of frames.
classimageio.plugins.ffmpeg.FrameCatcher
Thread to keep reading the frame data from stdout.
classimageio.plugins.fits.FitsFormat
See :mod:`imageio.plugins.fits`
classimageio.plugins.freeimage.FreeimageBmpFormat
A BMP format based on the Freeimage library.
classimageio.plugins.freeimage.FreeimageFormat
See :mod:`imageio.plugins.freeimage`
classimageio.plugins.freeimage.FreeimageJpegFormat
A JPEG format based on the Freeimage library.
classimageio.plugins.freeimage.FreeimagePngFormat
A PNG format based on the Freeimage library.
classimageio.plugins.freeimage.FreeimagePnmFormat
A PNM format based on the Freeimage library.
classimageio.plugins.freeimagemulti.FreeimageMulti
Base class for freeimage formats that support multiple images.
classimageio.plugins.freeimagemulti.IcoFormat
An ICO format based on the Freeimage library.
classimageio.plugins.freeimagemulti.MngFormat
An Mng format based on the Freeimage library.
classimageio.plugins.gdal.GdalFormat
See :mod:`imageio.plugins.gdal`
classimageio.plugins.grab.BaseGrabFormat
Base format for grab formats.
classimageio.plugins.lytro.LytroFormat
Base class for Lytro format.
classimageio.plugins.lytro.LytroIllumRawFormat
This is the Lytro Illum RAW format.
classimageio.plugins.lytro.LytroLfpFormat
This is the Lytro Illum LFP format.
classimageio.plugins.lytro.LytroLfrFormat
This is the Lytro Illum LFR format.
classimageio.plugins.npz.NpzFormat
See :mod:`imageio.plugins.npz`
classimageio.plugins.pillow_legacy.JPEG2000Format
See :mod:`imageio.plugins.pillow_legacy`
classimageio.plugins.pillow_legacy.JPEGFormat
See :mod:`imageio.plugins.pillow_legacy`
classimageio.plugins.pillow_legacy.PNGFormat
See :mod:`imageio.plugins.pillow_legacy`
classimageio.plugins.pillow_legacy.PillowFormat
Base format class for Pillow formats.
methodimageio.plugins.pillow_legacy.PillowFormat.plugin_id()
The PIL plugin id.
classimageio.plugins.pillowmulti.GIFFormat
See :mod:`imageio.plugins.pillow_legacy`
classimageio.plugins.pillowmulti.GifWriter
Class that for helping write the animated GIF file.
methodimageio.plugins.pillowmulti.GifWriter.getAppExt(loop)
Application extension.
methodimageio.plugins.pillowmulti.GifWriter.getGraphicsControlExt(duration=0.1, dispose=2)
Graphics Control Extension.
methodimageio.plugins.pillowmulti.GifWriter.getheaderAnim(im)
Get animation header.
classimageio.plugins.pyav.PyAVPlugin
Support for pyAV as backend.
methodimageio.plugins.pyav.PyAVPlugin.close() -> None
Close the Video.
methodimageio.plugins.pyav.PyAVPlugin.container_metadata()
Container-specific metadata.
methodimageio.plugins.pyav.PyAVPlugin.init_video_stream(codec:str, *fps:float=24, *pixel_format:str=None, *max_keyframe_interval:int=None, *force_keyframes:bool=None) -> None
Initialize a new video stream.
methodimageio.plugins.pyav.PyAVPlugin.iter(*format:str='rgb24', *filter_sequence:List[Tuple[str, Union[str, dict]]]=None, *filter_graph:Tuple[dict, List]=None, *thread_count:int=0, *thread_type:str=None) -> np.ndarray
Yield frames from the video.
methodimageio.plugins.pyav.PyAVPlugin.metadata(index:int=..., exclude_applied:bool=True, constant_framerate:bool=None) -> Dict[str, Any]
Format-specific metadata.
methodimageio.plugins.pyav.PyAVPlugin.properties(index:int=..., *format:str='rgb24') -> ImageProperties
Standardized ndimage metadata.
methodimageio.plugins.pyav.PyAVPlugin.set_video_filter(filter_sequence:List[Tuple[str, Union[str, dict]]]=None, filter_graph:Tuple[dict, List]=None) -> None
Set the filter(s) to use.
methodimageio.plugins.pyav.PyAVPlugin.video_stream_metadata()
Stream-specific metadata.
methodimageio.plugins.pyav.PyAVPlugin.write_frame(frame:np.ndarray, *pixel_format:str='rgb24') -> None
Add a frame to the video stream.
classimageio.plugins.rawpy.RawPyPlugin
A class representing the rawpy plugin.
methodimageio.plugins.rawpy.RawPyPlugin.iter() -> Iterator[np.ndarray]
Load the image.
methodimageio.plugins.rawpy.RawPyPlugin.metadata(index:int=None, exclude_applied:bool=True) -> Dict[str, Any]
Read ndimage metadata.
methodimageio.plugins.rawpy.RawPyPlugin.read(*index:int=0, **kwargs) -> np.ndarray
Read Raw Image.
methodimageio.plugins.rawpy.RawPyPlugin.write(ndimage:Union[ArrayLike, List[ArrayLike]]) -> Optional[bytes]
RawPy does not support writing.
classimageio.plugins.simpleitk.ItkFormat
See :mod:`imageio.plugins.simpleitk`
classimageio.plugins.swf.SWFFormat
See :mod:`imageio.plugins.swf`
classimageio.plugins.tifffile_v3.TifffilePlugin
Support for tifffile as backend.
methodimageio.plugins.tifffile_v3.TifffilePlugin.iter(**kwargs) -> np.ndarray
Yield ndimages from the TIFF.
methodimageio.plugins.tifffile_v3.TifffilePlugin.iter_pages(index=..., **kwargs)
Yield pages from a TIFF file.
methodimageio.plugins.tifffile_v3.TifffilePlugin.metadata(*index:int=Ellipsis, *page:int=None, *exclude_applied:bool=True) -> Dict[str, Any]
Format-Specific TIFF metadata.
methodimageio.plugins.tifffile_v3.TifffilePlugin.properties(*index:int=None, *page:int=None) -> ImageProperties
Standardized metadata.
methodimageio.plugins.tifffile_v3.TifffilePlugin.read(*index:int=None, *page:int=None, **kwargs) -> np.ndarray
Read a ndimage or page.
methodimageio.plugins.tifffile_v3.TifffilePlugin.write(ndimage:ArrayLike, *is_batch:bool=False, **kwargs) -> Optional[bytes]
Save a ndimage as TIFF.
funcimageio.v3.improps(uri, *index=None, *plugin=None, *extension=None, **kwargs)
Read standardized metadata.
funcimageio.v3.imread(uri, *index=None, *plugin=None, *extension=None, *format_hint=None, **kwargs)
Read an ndimage from a URI.

About this data

These signatures were extracted from the public source of imageio/imageio using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries