Skip to content

Commit b46561b

Browse files
committed
DOC: Document reading an OME-Zarr
1 parent 4ef8972 commit b46561b

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

docs/python.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,13 +152,22 @@ chunksize=(64, 64), chunktype=numpy.ndarray>,
152152
)
153153
```
154154

155-
The `Multiscales` dataclass stores all the images and their metadata for each
155+
The [`Multiscales`] dataclass stores all the images and their metadata for each
156156
scale according the OME-Zarr data model. Note that the correct `scale` and
157157
`translation` for each scale are automatically computed.
158158

159-
## Write to Zarr
159+
## Read an OME-Zarr
160160

161-
To write the multiscales to Zarr, use [`to_ngff_zarr`].
161+
To read an OME-Zarr file, use [`from_ngff_zarr`], which returns the
162+
[`Multiscales`] dataclass.
163+
164+
```python
165+
>>> multiscales = nz.from_ngff_zarr('cthead1.ome.zarr')
166+
```
167+
168+
## Write an OME-Zarr
169+
170+
To write the multiscales to OME-Zarr, use [`to_ngff_zarr`].
162171

163172
```python
164173
nz.to_ngff_zarr('cthead1.ome.zarr', multiscales)
@@ -177,7 +186,9 @@ The multiscales will be computed and written out-of-core, limiting memory usage.
177186
[Dask arrays]: https://docs.dask.org/en/stable/array.html
178187
[Python Array API Standard]: https://data-apis.org/array-api/latest/
179188
[UDUNITS-2 identifiers]: https://ngff.openmicroscopy.org/latest/#axes-md
189+
[`Multiscales`]: ./apidocs/ngff_zarr/ngff_zarr.multiscales.md
180190
[`NgffImage`]: ./apidocs/ngff_zarr/ngff_zarr.ngff_image.md
181191
[`to_ngff_zarr`]: ./apidocs/ngff_zarr/ngff_zarr.to_ngff_zarr.md
182192
[`to_ngff_image`]: ./apidocs/ngff_zarr/ngff_zarr.to_ngff_image.md
183193
[`to_multiscales`]: ./apidocs/ngff_zarr/ngff_zarr.to_multiscales.md
194+
[`from_ngff_zarr`]: ./apidocs/ngff_zarr/ngff_zarr.from_ngff_zarr.md

0 commit comments

Comments
 (0)