zolfa
/
nd2reader
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
334 Commits
3 Branches
333 MiB
 
 
 
Tree: 09b6b80a0a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '09b6b80a0a'
${ noResults }
 ZIP  TAR.GZ
Ruben Verweij 09b6b80a0a Create index.md 8 years ago
docs Create index.md 8 years ago
nd2reader Correctly parse experiment data for NDAqcuisition and add get_timesteps function to reader 8 years ago
tests Fix path to test files 8 years ago
.codeclimate.yml Add codeclimate integration 8 years ago
.gitignore Fix gitignore file 8 years ago
.travis.yml Speedup numpy installation on travis 8 years ago
CONTRIBUTING.md Start porting to PIMS framework, cleanup unnecessary files 8 years ago
CONTRIBUTORS.txt Rebranding in anticipation of better metadata support (mainly for FRAP experiments). 8 years ago
LICENSE.txt license and attribution 10 years ago
README.md Add codeclimate integration 8 years ago
requirements.txt Start porting to PIMS framework, cleanup unnecessary files 8 years ago
setup.cfg resolves #26 10 years ago
setup.py Fix old leftover in setup 8 years ago
test.py Add code coverage info 8 years ago

README.md

nd2reader

Build Status Test Coverage Code Climate

About

nd2reader is a pure-Python package that reads images produced by NIS Elements 4.0+. It has only been definitively tested on NIS Elements 4.30.02 Build 1053. Support for older versions is being actively worked on. The reader is written in the pims framework, enabling easy access to multidimensional files, lazy slicing, and nice display in IPython.

Installation

If you don't already have the packages numpy, pims, six and xmltodict, they will be installed automatically if you use the setup.py script. nd2reader is an order of magnitude faster in Python 3. I recommend using it unless you have no other choice. Python 2.7 and Python >= 3.4 are supported.

ND2s

nd2reader follows the pims framework. To open a file:

from nd2reader import ND2Reader
images = ND2Reader('my_directory/example.nd2')

After opening the file, all pims features are supported. Please refer to the documentation.

Contributing

If you'd like to help with the development of nd2reader or just have an idea for improvement, please see the contributing page for more information.

Bug Reports and Features

If this fails to work exactly as expected, please open an issue. If you get an unhandled exception, please paste the entire stack trace into the issue as well.

Acknowledgments

PIMS modified version by Ruben Verweij.

Original version by Jim Rybarski. Support for the development of this package was partially provided by the Finkelstein Laboratory.