imageio.plugins.tifffile_v3.TifffilePlugin.write#

TifffilePlugin.write(ndimage: Union[_Buffer, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[bool | int | float | complex | str | bytes]], *, is_batch: bool = False, **kwargs) → Optional[bytes][source]#

Save a ndimage as TIFF.

Parameters:

ndimageArrayLike: The ndimage to encode and write to the ImageResource.
is_batchbool: If True, the first dimension of the given ndimage is treated as a batch dimension and each element will create a new series.
kwargsAny: Additional kwargs are forwarded to TiffWriter’s write method.

Returns:

encoded_imagebytes: If the ImageResource is "<bytes>", return the encoded bytes. Otherwise write returns None.

Notes

Incremental writing is supported. Subsequent calls to write will create new series unless contiguous=True is used, in which case the call to write will append to the current series.

When photometric / planarconfig are omitted, ImageIO sets defaults for common RGB layouts so tifffile does not emit deprecation warnings about ambiguous channel-axis interpretation:

channel-last arrays (shape (..., 3) or (..., 4)): photometric="rgb"
channel-first arrays (shape (3, ...) or (4, ...) on the third-to-last axis): photometric="rgb" and planarconfig="separate"