ngff_zarr.multiscales

Module Contents

Classes

NgffMultiscales

Data

Multiscales

API

class ngff_zarr.multiscales.NgffMultiscales

images: list[ngff_zarr.ngff_image.NgffImage]

None

metadata: ngff_zarr.v04.zarr_metadata.Metadata | ngff_zarr.v05.zarr_metadata.Metadata | ngff_zarr.v06.zarr_metadata.Metadata | ngff_zarr.v09.zarr_metadata.Metadata

None

scale_factors: collections.abc.Sequence[dict[str, int] | int] | None

None

method: ngff_zarr.methods.Methods | None

None

chunks: int | tuple[int, ...] | tuple[tuple[int, ...], ...] | collections.abc.Mapping[Any, int | tuple[int, ...] | None] | None

None

generated_data_keys: list[str] | None

‘field(…)’

Dask graph key of each level as :func:to_multiscales produced it.

The writer re-derives a level from the level written before it only while the level still carries the key recorded here; a level whose data has been replaced is written as given.

root_attributes: dict[str, Any] | None

None

Root attributes beside the OME metadata of the store.

Func:

from_ome_zarr fills them with every root key the OME-Zarr writer does not own, and :func:to_ome_zarr writes them back beside the OME keys, so application metadata such as provenance follows the image through a round trip.

to_ome_zarr(

store: ngff_zarr._store_types.StoreLike,

**kwargs: Any,

) → None

Write this multiscale image to an OME-Zarr store.

Convenience method that delegates to :func:ngff_zarr.to_ome_zarr. See that function for full parameter documentation.

classmethod from_ome_zarr(

store: ngff_zarr._store_types.StoreLike,

**kwargs: Any,

) → ngff_zarr.multiscales.NgffMultiscales

Read an OME-Zarr store into a NgffMultiscales object.

Convenience classmethod that delegates to :func:ngff_zarr.from_ome_zarr. See that function for full parameter documentation.

ngff_zarr.multiscales.Multiscales

None