.. nx2img documentation master file, created by
   sphinx-quickstart on Thu Oct 15 22:55:21 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===============================================
Welcome to the NeXus image tools documentation!
===============================================

The NeXus image tools are command line programs to work with image data 
stored in NeXus files or which should be stored in NeXus files.
The programms provided by this package cover two use cases 

* moving images, stored in individual files, to a NeXus file
* extracting images from a stack stored in a NeXus files to individual 
  image files.

.. Figure:: _static/use_case.png

The former use case describes the situation where data from a detector, not 
capable of writing NeXus files, should be stored in a NeXus files.
The latter situation occurs typically when programs for data analysis should be
use which are not aware of the NeXus file format.


Currently the following programs are available:

.. toctree::
   :maxdepth: 1
 
   nx2img
   img2nx 
   qnx2img
   developer_documentation