ZarrFileSequenceStore

final class tifffile.ZarrFileSequenceStore(filesequence, /, *, fillvalue=None, chunkmode=None, chunkshape=None, chunkdtype=None, dtype=None, axestiled=None, zattrs=None, imreadargs=None, **kwargs)

Zarr store interface to image array in FileSequence.

Parameters:
  • filesequence (FileSequence) – FileSequence instance to wrap as Zarr store. Files in containers are not supported.

  • fillvalue (int | float | None) – Value to use for missing chunks. The default is 0.

  • chunkmode (CHUNKMODE | int | str | None) – Currently only one chunk per file is supported.

  • chunkshape (Sequence[int] | None) – Shape of chunk in each file. Must match FileSequence.imread(file, **imreadargs).shape.

  • chunkdtype (DTypeLike | None) – Data type of chunk in each file. Must match FileSequence.imread(file, **imreadargs).dtype.

  • axestiled (dict[int, int] | Sequence[tuple[int, int]] | None) – Axes to be tiled. Map stacked sequence axis to chunk axis.

  • zattrs (dict[str, Any] | None) – Additional attributes to store in .zattrs.

  • imreadargs (dict[str, Any] | None) – Arguments passed to FileSequence.imread.

  • **kwargs (Any) – Arguments passed to FileSequence.imread`in addition to `imreadargs.

  • dtype (DTypeLike | None)

Notes

If chunkshape or chunkdtype are None (default), their values are determined by reading the first file with FileSequence.imread(arg.files[0], **imreadargs).

imread: Callable[..., NDArray[Any]]

Function to read image array from single file.

write_fsspec(jsonfile, /, url, *, quote=None, groupname=None, templatename=None, codec_id=None, version=None, _append=False, _close=True)

Write fsspec ReferenceFileSystem as JSON to file.

Parameters:
  • jsonfile (str | os.PathLike[Any] | TextIO) – Name or open file handle of output JSON file.

  • url (str) – Remote location of TIFF file(s) without file name(s).

  • quote (bool | None) – Quote file names, that is, replace ‘ ‘ with ‘%20’. The default is True.

  • groupname (str | None) – Zarr group name.

  • templatename (str | None) – Version 1 URL template name. The default is ‘u’.

  • codec_id (str | None) – Name of Numcodecs codec to decode files or chunks.

  • version (int | None) – Version of fsspec file to write. The default is 0.

  • _append (bool) – Experimental API.

  • _close (bool) – Experimental API.

Return type:

None

References