Skip to content

Commit 5799b81

Browse files
committed
Add tile source documentation for OME-Zarr
1 parent 6ed6944 commit 5799b81

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

sphinx-doc/source/tile_sources.rst

+23
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,29 @@ Tile source types are listed by the enumeration integer ID referenced by
433433

434434
https://www.googleapis.com/storage/v1/b/neuroglancer/o/pinky100_v0%2Fson_of_alignment_v15_rechunked%2Finfo?alt=media
435435

436+
437+
438+
15. OME-Zarr image blocks
439+
*************************
440+
441+
This type supports loading **image blocks** from
442+
`OME-Zarr v0.5 format <https://ngff.openmicroscopy.org/0.5/index.html>`_ served over HTTP.
443+
444+
The ``sourceBaseUrl`` should point to the OME-Zarr dataset where the `zarr.json` is located
445+
(without trailing slash). The specification of the dataset dimension and voxel resolution should
446+
correspond to the first array in the `multiscales` field, corresponding the scale level 0.
447+
448+
The assumption is that the arrays in the `multiscales` field are mapped to the CATMAID scale levels
449+
where the first element is the array at the highest resolution, and the last element the last downscaled
450+
version of the dataset.
451+
452+
An OME-Zarr array can contain axes that are not spatial. For display in CATMAID, the OME-Zarr metadata
453+
is parsed to extract the space axes labeled `x, y, and z` to slice into the array.
454+
455+
Please refer to the `NGFF documentation <https://ngff.openmicroscopy.org/>`_ to learn about tools,
456+
datasets, etc. to work with OME-Zarr datasets.
457+
458+
436459
Backend Representation
437460
----------------------
438461

0 commit comments

Comments
 (0)