Skip to content

Parser

virtual_tiff.VirtualTIFF

__init__

__init__(
    ifd: int | None = None, ifd_layout: Literal["flat", "nested"] = "flat"
) -> None

Configure VirtualTIFF parser.

Parameters:

  • ifd

    IFD within the TIFF file to virtualize. Defaults to None, meaning that all IFDs will be virtualized as Zarr groups.

  • ifd_layout

    How to map TIFF IFDs to Zarr groups/arrays. In all cases, an IFD is mapped to a Zarr array. Choose "flat" for all arrays to be contained in a single group. Choose "nested" for each array to be contained in a different group. "nested" is compatible with Xarray's DataTree model, because each node in the DataTree needs to be a Dataset (i.e., group) rather than Dataarray (i.e., array). Default is "flat".

__call__

__call__(url: str, registry: ObjectStoreRegistry) -> ManifestStore

Produce a ManifestStore from a file path and object store instance.

Parameters:

  • url

    URL to the TIFF.

  • registry

    ObjectStoreRegistry to use for reading the TIFF.

Returns:

  • ms ( ManifestStore ) –

    ManifestStore containing ChunkManifests and Array metadata for the specified IFDs, along with an ObjectStore instance for loading any data.