Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ngff tools table #139

Closed
wants to merge 30 commits into from
Closed
Changes from 25 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
628e8ef
Initial ngff-tools.md page
will-moore Sep 29, 2022
62b5cb5
Simplify link
will-moore Sep 29, 2022
6b66321
reformat html to fewer lines
will-moore Sep 29, 2022
2580a2f
Add bioformats2raw row to table
will-moore Sep 29, 2022
fc3bc0d
Try table with different orientation
will-moore Sep 29, 2022
b8f4ae7
Fix table
will-moore Sep 29, 2022
8325055
Update tables
will-moore Oct 5, 2022
36f376d
Add itkwidgets and webknosses
will-moore Oct 6, 2022
563d5b9
Add back URL (not s3) to last table
will-moore Oct 6, 2022
512d2f7
Fix links
will-moore Oct 6, 2022
577331a
Adding more features to last table
will-moore Oct 13, 2022
ec89a03
Add sample data column
will-moore Oct 13, 2022
cd77dd2
Add v0.4 axes
will-moore Oct 13, 2022
9031d57
Multi-C and Multi-T as separate rows on table
will-moore Oct 14, 2022
3145685
Remove URL (not s3) row of table. Not needed
will-moore Oct 14, 2022
dd907b9
Add sample links for plate, bioformats2raw.layout and transforms
will-moore Oct 14, 2022
d56abf3
Fix y -> n for bioformats2raw.layout for napari
will-moore Oct 19, 2022
4e4cae0
Remove markdown table and older html table
will-moore Oct 19, 2022
c092d8c
tweak features with v0.4 etc, fix y (scale) values
will-moore Oct 20, 2022
2393e95
Test red X for no
will-moore Oct 20, 2022
9ae1e39
Add OMERO to table
will-moore Oct 20, 2022
848e80d
reformat viewer type
will-moore Oct 20, 2022
96b9665
reformat coordinateTransforms
will-moore Oct 20, 2022
0f74a61
Add versions for various tools
will-moore Oct 25, 2022
4d7c95a
Add sample image for scale not 2
will-moore Oct 25, 2022
7b420a7
Split coordinateTransformations row in two
will-moore Oct 27, 2022
4118fae
Add z-downsample link to table
will-moore Oct 27, 2022
f60d3bc
add 'translate onto'
will-moore Oct 27, 2022
6c390ad
Split multscales coordinateTransformations into 2 rows
will-moore Oct 27, 2022
36de81c
links to v0.4 spec for multiscales and coordinateTransformations
will-moore Oct 27, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 198 additions & 0 deletions ngff-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
# OME-NGFF tools

Various tools are available for viewing and working with OME-NGFF data.
The following tables document which features of the OME-NGFF spec are supported by which tools.

## Viewers

The following versions of each viewer were used in testing:

- <a href="https://napari.org">napari</a> 0.4.16 with plugin <a href="https://github.com/ome/napari-ome-zarr/">napari-ome-zarr</a>0.5.2 and <a href="https://github.com/ome/ome-zarr-py/">ome-zarr</a>0.6.0.
- <a href="https://github.com/hms-dbmi/vizarr/">vizarr</a> using <a href="https://hms-dbmi.github.io/vizarr">current viewer</a> October 2022. Open via URL - see <a href="https://hms-dbmi.github.io/vizarr/?source=https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.3/idr0079A/9836998.zarr">example</a>.
- <a href="https://github.com/mobie/mobie-viewer-fiji/">MoBIE</a> plugin for ImageJ/Fiji. Open with `Plugins > BigDataViewer > OME-Zarr > Open OME-Zarr From...`
- <a href="https://itkwidgets.readthedocs.io/en/latest">itkwidgets</a>. Use in a python notebook, or open via URL: See <a href="https://kitware.github.io/itk-vtk-viewer/app/?rotate=false&fileToLoad=https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0062A/6001240.zarr">example</a>.
- <a href="https://webknossos.org">webKnossos</a> version 19988.
- <a href="https://www.openmicroscopy.org/omero/">OMERO</a> with BioFormats <a href="https://github.com/ome/ZarrReader">ZarrReader</a> 0.2.0.

<table>
<thead>
<tr>
<th></th>
<th>Sample data</th>
<th>napari</th>
<th>vizarr</th>
<th>MoBIE</th>
<th>itkwidgets</th>
<th>webKnossos</th>
<th>OMERO</th>
</tr>
</thead>
<tbody>
<tr>
<td>Viewer type, language</td>
<td></td>
<td>desktop, Python</td>
<td>browser, JavaScript</td>
<td>desktop, Java</td>
<td>notebook, Python</td>
<td>browser client + server</td>
<td>various clients + server</td>
</tr>
<tr>
<td>Z-downsampling</td>
<td></td>
<td>y</td>
<td><a href="https://github.com/hms-dbmi/vizarr/pull/71">n</a></td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>n</td>
</tr>
<tr>
<td>omero info</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0062A/6001240.zarr">6001240.zarr</a></td>
<td>y</td>
<td>y</td>
<td>n</td>
<td><a href="https://github.com/InsightSoftwareConsortium/itkwidgets/issues/546">n</a></td>
<td>n</td>
<td>n?</td>
</tr>
<tr>
<td>multiscales factor not=2</td>
<td><a href="https://minio-dev.openmicroscopy.org/idr/v0.4/idr0082/9846318.zarr/0">9846318.zarr/0</a></td>
<td>y</td>
<td><a href="https://github.com/hms-dbmi/vizarr/issues/101">n</a></td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>y?</td>
</tr>
<tr>
<td>axes (v0.3)</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.3/idr0079A/9836998.zarr">9836998.zarr</a></td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>n</td>
<td>?</td>
</tr>
<tr>
<td>v0.4 axes (v0.4)</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0101A/13457227.zarr">13457227.zarr</a></td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>?</td>
</tr>
<tr>
<td>3D view</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0062A/6001240.zarr">6001240.zarr</a></td>
<td>y (1)</td>
<td>n</td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>n</td>
</tr>
<tr>
<td>labels</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0052A/5514375.zarr">5514375.zarr</a></td>
<td>y</td>
<td>n</td>
<td>y</td>
<td><a href="https://github.com/InsightSoftwareConsortium/itkwidgets/issues/547">n</a></td>
<td>y</td>
<td>?</td>
</tr>
<tr>
<td>HCS plate</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0001A/2551.zarr">idr0001</a></td>
<td>y</td>
<td>y</td>
<td>n</td>
<td>n</td>
<td>n</td>
<td>y</td>
</tr>
<tr>
<td>bioformats2raw.layout</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.2/idr0070A/9838562.zarr">9838562.zarr</a></td>
<td><a href="https://github.com/ome/napari-ome-zarr/issues/71">n</a></td>
<td><a href="https://github.com/hms-dbmi/vizarr/issues/149">n</a></td>
<td><span style="color: red">X</span></td>
<td>n</td>
<td>n</td>
<td>y</td>
</tr>
<tr>
<td>multiple 'multiscales'</td>
<td></td>
<td>n</td>
<td>n</td>
<td>n</td>
<td>n</td>
<td>n</td>
<td>n</td>
</tr>
<tr>
<td>datasets coordinateTransformations (v0.4)</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0101A/13457537.zarr">13457537.zarr</a>
translate onto <a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0101A/13457227.zarr">13457227.zarr</a></td>
<td>y (scale, translate)</td>
<td>n</td>
<td>?</td>
<td>y (scale)</td>
<td>y (scale)</td>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line, which says webknossos opens ? should say something like

errors for the first image (with scale and transform)
opens for the second image (with only scale)

This invites a split of this line into the first image (scale & transform) and the second image (scale).

We also need a better expression for the n which at present means "does not support the feature which the particular image is trying to highlight, it opens the image but ignores the feature".

<td>?</td>
</tr>
<tr>
<td>multiscales coordinateTransformations (v0.4)</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0101A/13457539.zarr">13457539.zarr</a></td>
<td>n</td>
<td>n</td>
<td>?</td>
<td>?</td>
<td>?</td>
<td>?</td>
</tr>
<tr>
<td>overlay multiple images</td>
<td></td>
<td>y</td>
<td>n</td>
<td>?</td>
<td>?</td>
<td>y</td>
<td>n</td>
</tr>
<tr>
<td>multiple Channels</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0101A/13457227.zarr">13457227.zarr</a></td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>n</td>
<td>y</td>
<td>y</td>
</tr>
<tr>
<td>multiple Time-points</td>
<td><a href="https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0101A/13457227.zarr">13457227.zarr</a></td>
<td>y</td>
<td>y</td>
<td>y</td>
<td>n</td>
<td>n</td>
<td>y</td>
</tr>
</tbody>
</table>



1. napari 3D view only supported for lowest level of multiscales pyramid