Metadata-Version: 2.1
Name: odtbrain
Version: 0.3.0
Summary: Algorithms for diffraction tomography
Home-page: https://github.com/RI-imaging/ODTbrain
Author: Paul Müller
Author-email: dev@craban.de
License: BSD (3 clause)
Keywords: odt,opt,diffraction,born,rytov,radon,backprojection,backpropagation,inverse problem,Fourier diffraction theorem,Fourier slice theorem
Platform: ALL
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.4, <4
Requires-Dist: numexpr
Requires-Dist: numpy (>=1.7.0)
Requires-Dist: pyfftw (>=0.9.2)
Requires-Dist: scikit-image (>=0.11.0)
Requires-Dist: scipy (>=0.10.0)

ODTbrain
========

|PyPI Version| |Tests Status Linux| |Tests Status Win| |Coverage Status| |Docs Status|


**ODTbrain** provides image reconstruction algorithms for **O**\ ptical **D**\ iffraction **T**\ omography with a **B**\ orn and **R**\ ytov
**A**\ pproximation-based **I**\ nversion to compute the refractive index (**n**\ ) in 2D and in 3D.


Documentation
-------------

The documentation, including the reference and examples, is available at `odtbrain.readthedocs.io <https://odtbrain.readthedocs.io/en/stable/>`__.


Installation
------------
::

    pip install odtbrain



Testing
-------

After cloning into odtbrain, create a virtual environment

::

    virtualenv --system-site-packages env
    source env/bin/activate

Install all dependencies

::

    pip install -e .

Running an example

::

    python examples/backprop_from_fdtd_2d.py

Running tests

::

    python setup.py test



.. |PyPI Version| image:: https://img.shields.io/pypi/v/odtbrain.svg
   :target: https://pypi.python.org/pypi/odtbrain
.. |Tests Status Linux| image:: https://img.shields.io/travis/RI-imaging/ODTbrain.svg?label=tests_linux
   :target: https://travis-ci.org/RI-imaging/ODTbrain
.. |Tests Status Win| image:: https://img.shields.io/appveyor/ci/paulmueller/odtbrain/master.svg?label=tests_win
   :target: https://ci.appveyor.com/project/paulmueller/odtbrain
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/RI-imaging/ODTbrain/master.svg
   :target: https://codecov.io/gh/RI-imaging/ODTbrain
.. |Docs Status| image:: https://readthedocs.org/projects/odtbrain/badge/?version=latest
   :target: https://readthedocs.org/projects/odtbrain/builds/


