From f3cefd7e7eaa329a7904ecd96e8bfc0a50091847 Mon Sep 17 00:00:00 2001 From: Jim Rybarski Date: Sun, 21 Dec 2014 18:19:37 -0600 Subject: [PATCH] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 39c1db0..8d3f555 100644 --- a/README.md +++ b/README.md @@ -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.