Metadata-Version: 2.1
Name: ODTbrain
Version: 0.4.10
Summary: Algorithms for diffraction tomography
Author: Paul Müller
Maintainer-email: Paul Müller <dev@craban.de>
License: Copyright (c) 2015, Paul Müller
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of ODTbrain nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
        
Project-URL: source, https://github.com/RI-imaging/ODTbrain
Project-URL: tracker, https://github.com/RI-imaging/ODTbrain/Issues
Keywords: odt,opt,diffraction,born,rytov,radon,backprojection,backpropagation,inverse problem,Fourier diffraction theorem,Fourier slice theorem
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Intended Audience :: Science/Research
Requires-Python: <4,>=3.5
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numexpr
Requires-Dist: numpy>=1.7.0
Requires-Dist: pyfftw<1,>=0.9.2
Requires-Dist: scikit-image<1,>=0.21.0
Requires-Dist: scipy<2,>=1.4.0

ODTbrain
========

|PyPI Version| |Tests Status| |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 ODTbrain in editable mode::

    pip install -e .
    
Running an example::

    python examples/backprop_from_fdtd_2d.py
   
Running tests::

    pip install pytest
    pytest tests


.. |PyPI Version| image:: https://img.shields.io/pypi/v/odtbrain.svg
   :target: https://pypi.python.org/pypi/odtbrain
.. |Tests Status| image:: https://img.shields.io/github/actions/workflow/status/RI-Imaging/ODTbrain/check.yml
   :target: https://github.com/RI-Imaging/ODTbrain/actions?query=workflow%3AChecks
.. |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/
