Skip to content

Commit 2f95dea

Browse files
committed
doc(readme): updates README about new and updated functionality
* metadata types * format and backends * cropping tool see #39
1 parent 3a465df commit 2f95dea

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

README.md

+29-10
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,37 @@ BigDataViewer-based tool for visualizing [N5](https://github.com/saalfeldlab/n5)
33

44
### Usage
55

6-
The plugin will be available soon through the [N5 update site](https://imagej.net/N5) in Fiji as *Plugins -> BigDataViewer -> N5 Viewer*.
6+
The plugin will be available in Fiji as *Plugins -> BigDataViewer -> HDF5/N5/Zarr/OME-NGFF Viewer*,
77
See also the [N5 Fiji plugin](https://github.com/saalfeldlab/n5-ij).
88

99
#### Storage options
10-
The plugin supports multiple storage options:
11-
* Filesystem (local/network drives)
12-
* Zarr (local drives)
13-
* HDF5
10+
The plugin supports multiple storage formats:
11+
* HDF5 (local file only)
12+
* N5 (local and cloud)
13+
* Zarr (local and cloud)
14+
15+
and multiple storage backends:
16+
* Filesystem
1417
* Amazon Web Services S3
1518
* Google Cloud Storage
1619

17-
#### Container structure
18-
The plugin allows to select which datasets to open from the N5 container tree. While almost any dataset can be opened as a BigDataViewer source, the plugin also tries to read the metadata from the corresponding `attributes.json` to determine the additional transformations, or treat a group as a multiscale source.
20+
#### Metadata and container
21+
22+
The plugin allows to select which datasets to open from the container tree. While almost any dataset can be opened as a BigDataViewer source, the
23+
plugin also tries to read the metadata from the storage format to determine the additional transformations, or treat a group as a multiscale source.
24+
Supported metadata formats include:
25+
26+
* [OME-NGFF v0.4](https://ngff.openmicroscopy.org/0.4/)
27+
* "N5 Viewer" described below.
28+
* [COSEM](https://github.com/janelia-cellmap/schemas/blob/master/multiscale.md#contemporary-new-proposed-cosem-style-ie-elaborated-ome-zarr-spec)
29+
30+
31+
#### "N5 Viewer" Metadata
32+
33+
Early versions of this plugin developed the following naming and metadata specification we call the "N5 Viewer" metadata.
34+
This plugin supports visualization of this format, and the [N5 Fiji plugins](https://github.com/saalfeldlab/n5-ij) support
35+
reading and writing of this metadata format.
1936

20-
Currently, the plugin supports the following naming and metadata specification (compatible with the previous version of the plugin):
2137
```
2238
└─ group
2339
├─── s0 {}
@@ -61,6 +77,9 @@ The local user credentials can be initialized as follows:
6177

6278
The application has a built-in cropping tool for extracing parts of the dataset as a ImageJ image (can be converted to commonly supported formats such as TIFF series).
6379

64-
Place the mouse pointer at the desired center position of the extracted image and hit `SPACE`. The dialog will pop up where you can specify the dimensions of the extracted image.
80+
Press `SPACE` or select the `Tools > Extract to ImageJ` menu options. A dialog will appear where you can specify the field of view and dimensions of the image you would like to extract.
81+
The field of view can be edited by clicking and draggging corners of the displayed bounding box, moving the sliders in the new dialog, or manually editing their values.
82+
If the image is multiscale, you can select which scale level to export using the drop down menu. If multiple channels or images are open, you can export either the current image only,
83+
or all visible images, using the "Images to export" drop down.
6584

66-
The image is cropped <i>without</i> respect to the camera orientation, so the cropped image will always contain Z-slices.
85+
The image is cropped <i>without</i> respect to the camera orientation, so slices of the cropped image will always be the `Z` dimension.

0 commit comments

Comments
 (0)