Browse Source

Update README.md

master
Jim Rybarski 10 years ago
parent
commit
f3cefd7e7e
1 changed files with 5 additions and 4 deletions
  1. +5
    -4
      README.md

+ 5
- 4
README.md View File

@ -5,10 +5,11 @@ nd2reader
# About
.nd2 files contain hierarchical image data, which can be split along multiple axes: time, fields of view, focus, and filter channel. Maybe others as well?
This packages allows you to view how the data is organized, and to extract the image data from a particular set of the hierarchy.
`nd2reader` is a pure-Python package that reads images produced by Nikon microscopes. Though it more or less works, it is currently under development and is not quite ready for use by the general public. Version 1.0 should be released in early 2015.
Images are numpy arrays.
.nd2 files contain images and metadata, which can be split along multiple dimensions: time, fields of view (xy-axis), focus (z-axis), and filter channel. `nd2reader` allows you to view any subset of images based on any or all of these dimensions.
`nd2reader` holds data in numpy arrays, which makes it trivial to use with the image analysis packages `scikit-image` and `OpenCV`.
# Dependencies
@ -16,4 +17,4 @@ numpy
# Installation
I'll write this eventually.
I'll write this eventually.

Loading…
Cancel
Save