ngff_zarr.from_ngff_zarr

Module Contents

Functions

from_ngff_zarr

Read an OME-Zarr NGFF Multiscales data structure from a Zarr store.

Data

API

ngff_zarr.from_ngff_zarr.zarr_version

‘parse(…)’

ngff_zarr.from_ngff_zarr.zarr_version_major

None

ngff_zarr.from_ngff_zarr.from_ngff_zarr(
store: ngff_zarr._zarr_types.StoreLike,
validate: bool = False,
version: Optional[str] = None,
storage_options: Optional[dict] = None,
) ngff_zarr.to_multiscales.Multiscales

Read an OME-Zarr NGFF Multiscales data structure from a Zarr store.

store : StoreLike Store or path to directory in file system. Can be a string URL (e.g., ‘s3://bucket/path’) for remote storage. For .ozx files, provide the path to the .ozx file.

validate : bool If True, validate the NGFF metadata against the schema.

version : string, optional OME-Zarr version, if known. For .ozx files, the version will be read from the ZIP comment if not provided.

storage_options : dict, optional Storage options to pass to the store if store is a string URL. For S3 URLs, this can include authentication credentials and other options for the underlying filesystem.

Returns

multiscales: multiscale ngff image with dask-chunked arrays for data