Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
- add some instructions on how to use the plugins
  • Loading branch information
fmeyenhofer committed Mar 28, 2019
1 parent 8aff526 commit 54b3a5c
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NanoZoomer-J

NanoZoomer-J is a collection of [ImageJ][imagej] plugins to deal with the
NanoZoomer-J is a small collection of [ImageJ][imagej] plugins to deal with the
NDPI image file format.
The "NDPI 2 OME-TIF" converter uses [Bio-Formats][bf] to convert the proprietary
file format to the open ome-tif without loading the entire file into memory,
Expand All @@ -12,6 +12,21 @@ The packaged binaries can be found on the [release-page][release]. To install th
in ImageJ, the downloaded jar-file can be dragged and dropped on the ImageJ main UI, or via the
main menu: Plugins > Install PlugIn...


# Usage

Once the jar has been added to ImageJ, the plugins can be run via the menu:
`Plugins > NanoZooomer NDPI > ...`

## Batch Converter

The batch converter takes an input directory, searches it for NDPI files and then lets you choose the
channels and the pixel size to convert. Once the directory has been selected, it takes a short moment
to read the meta data from the first NDPI file. The order of the channels can be chosen by
sequentially clicking on them in the selection table. All the channels are then merged into
a single multi-channel OME-TIF.


[imagej]: http://imagej.net
[bf]: http://www.openmicroscopy.org/site/products/bio-form…
[release]: https://github.com/Meyenhofer/NanoZoomer-J/releases
[release]: https://github.com/fmeyenhofer/NanoZoomer-J/releases

0 comments on commit 54b3a5c

Please sign in to comment.