|
.. nd2reader documentation master file, created by
|
|
sphinx-quickstart on Mon Mar 6 21:17:58 2017.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
``nd2reader``: a pure-Python package for reading Nikon .nd2 files
|
|
=================================================================
|
|
|
|
`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 <https://github.com/soft-matter/pims>`_ framework, enabling easy access to multidimensional files, lazy slicing, and nice display in IPython. To get started, see the quick start tutorial.
|
|
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
:caption: Contents:
|
|
|
|
nd2reader quick start tutorial <tutorial>
|
|
nd2reader API reference <nd2reader>
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|