Commit 94ed8cf2 authored by Pierre Paleo's avatar Pierre Paleo
Browse files

Add API doc

parent 50f53931
nabu
====
.. toctree::
:maxdepth: 4
nabu
setup
nabu.cuda package
=================
Subpackages
-----------
.. toctree::
nabu.cuda.tests
Submodules
----------
nabu.cuda.convolution module
----------------------------
.. automodule:: nabu.cuda.convolution
:members:
:undoc-members:
:show-inheritance:
nabu.cuda.kernel module
-----------------------
.. automodule:: nabu.cuda.kernel
:members:
:undoc-members:
:show-inheritance:
nabu.cuda.medfilt module
------------------------
.. automodule:: nabu.cuda.medfilt
:members:
:undoc-members:
:show-inheritance:
nabu.cuda.processing module
---------------------------
.. automodule:: nabu.cuda.processing
:members:
:undoc-members:
:show-inheritance:
nabu.cuda.utils module
----------------------
.. automodule:: nabu.cuda.utils
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.cuda
:members:
:undoc-members:
:show-inheritance:
nabu.cuda.tests package
=======================
Submodules
----------
nabu.cuda.tests.test\_medfilt module
------------------------------------
.. automodule:: nabu.cuda.tests.test_medfilt
:members:
:undoc-members:
:show-inheritance:
nabu.cuda.tests.test\_padding module
------------------------------------
.. automodule:: nabu.cuda.tests.test_padding
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.cuda.tests
:members:
:undoc-members:
:show-inheritance:
nabu.distributed package
========================
Module contents
---------------
.. automodule:: nabu.distributed
:members:
:undoc-members:
:show-inheritance:
nabu.external package
=====================
Module contents
---------------
.. automodule:: nabu.external
:members:
:undoc-members:
:show-inheritance:
nabu.imgproc package
====================
Module contents
---------------
.. automodule:: nabu.imgproc
:members:
:undoc-members:
:show-inheritance:
nabu.interfaces package
=======================
Module contents
---------------
.. automodule:: nabu.interfaces
:members:
:undoc-members:
:show-inheritance:
nabu.io package
===============
Submodules
----------
nabu.io.config module
---------------------
.. automodule:: nabu.io.config
:members:
:undoc-members:
:show-inheritance:
nabu.io.reader module
---------------------
.. automodule:: nabu.io.reader
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.io
:members:
:undoc-members:
:show-inheritance:
nabu.misc package
=================
Subpackages
-----------
.. toctree::
nabu.misc.tests
Submodules
----------
nabu.misc.unsharp module
------------------------
.. automodule:: nabu.misc.unsharp
:members:
:undoc-members:
:show-inheritance:
nabu.misc.unsharp\_cuda module
------------------------------
.. automodule:: nabu.misc.unsharp_cuda
:members:
:undoc-members:
:show-inheritance:
nabu.misc.unsharp\_opencl module
--------------------------------
.. automodule:: nabu.misc.unsharp_opencl
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.misc
:members:
:undoc-members:
:show-inheritance:
nabu.misc.tests package
=======================
Submodules
----------
nabu.misc.tests.test\_unsharp module
------------------------------------
.. automodule:: nabu.misc.tests.test_unsharp
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.misc.tests
:members:
:undoc-members:
:show-inheritance:
nabu.opencl package
===================
Module contents
---------------
.. automodule:: nabu.opencl
:members:
:undoc-members:
:show-inheritance:
nabu.preproc package
====================
Subpackages
-----------
.. toctree::
nabu.preproc.tests
Submodules
----------
nabu.preproc.ccd module
-----------------------
.. automodule:: nabu.preproc.ccd
:members:
:undoc-members:
:show-inheritance:
nabu.preproc.ccd\_cuda module
-----------------------------
.. automodule:: nabu.preproc.ccd_cuda
:members:
:undoc-members:
:show-inheritance:
nabu.preproc.phase module
-------------------------
.. automodule:: nabu.preproc.phase
:members:
:undoc-members:
:show-inheritance:
nabu.preproc.phase\_cuda module
-------------------------------
.. automodule:: nabu.preproc.phase_cuda
:members:
:undoc-members:
:show-inheritance:
nabu.preproc.sinogram module
----------------------------
.. automodule:: nabu.preproc.sinogram
:members:
:undoc-members:
:show-inheritance:
nabu.preproc.sinogram\_cuda module
----------------------------------
.. automodule:: nabu.preproc.sinogram_cuda
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.preproc
:members:
:undoc-members:
:show-inheritance:
nabu.preproc.tests package
==========================
Submodules
----------
nabu.preproc.tests.test\_ccd\_corr module
-----------------------------------------
.. automodule:: nabu.preproc.tests.test_ccd_corr
:members:
:undoc-members:
:show-inheritance:
nabu.preproc.tests.test\_flatfield module
-----------------------------------------
.. automodule:: nabu.preproc.tests.test_flatfield
:members:
:undoc-members:
:show-inheritance:
nabu.preproc.tests.test\_paganin module
---------------------------------------
.. automodule:: nabu.preproc.tests.test_paganin
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.preproc.tests
:members:
:undoc-members:
:show-inheritance:
nabu.reconstruction package
===========================
Subpackages
-----------
.. toctree::
nabu.reconstruction.tests
Submodules
----------
nabu.reconstruction.fbp module
------------------------------
.. automodule:: nabu.reconstruction.fbp
:members:
:undoc-members:
:show-inheritance:
nabu.reconstruction.filtering module
------------------------------------
.. automodule:: nabu.reconstruction.filtering
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.reconstruction
:members:
:undoc-members:
:show-inheritance:
nabu.reconstruction.tests package
=================================
Submodules
----------
nabu.reconstruction.tests.test\_fbp module
------------------------------------------
.. automodule:: nabu.reconstruction.tests.test_fbp
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.reconstruction.tests
:members:
:undoc-members:
:show-inheritance:
nabu.resources.cli package
==========================
Submodules
----------
nabu.resources.cli.bootstrap module
-----------------------------------
.. automodule:: nabu.resources.cli.bootstrap
:members:
:undoc-members:
:show-inheritance:
nabu.resources.cli.conf\_bootstrap module
-----------------------------------------
.. automodule:: nabu.resources.cli.conf_bootstrap
:members:
:undoc-members:
:show-inheritance:
nabu.resources.cli.utils module
-------------------------------
.. automodule:: nabu.resources.cli.utils
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.resources.cli
:members:
:undoc-members:
:show-inheritance:
nabu.resources package
======================
Subpackages
-----------
.. toctree::
nabu.resources.cli
Submodules
----------
nabu.resources.dataset\_analyzer module
---------------------------------------
.. automodule:: nabu.resources.dataset_analyzer
:members:
:undoc-members:
:show-inheritance:
nabu.resources.dataset\_validator module
----------------------------------------
.. automodule:: nabu.resources.dataset_validator
:members:
:undoc-members:
:show-inheritance:
nabu.resources.nabu\_config module
----------------------------------
.. automodule:: nabu.resources.nabu_config
:members:
:undoc-members:
:show-inheritance:
nabu.resources.utils module
---------------------------
.. automodule:: nabu.resources.utils
:members:
:undoc-members:
:show-inheritance:
nabu.resources.validators module
--------------------------------
.. automodule:: nabu.resources.validators
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.resources
:members:
:undoc-members:
:show-inheritance:
nabu API reference
==================
Subpackages
-----------
.. toctree::
nabu.cuda
nabu.distributed
nabu.external
nabu.imgproc
nabu.interfaces
nabu.io
nabu.misc
nabu.opencl
nabu.preproc
nabu.reconstruction
nabu.resources
nabu.thirdparty
Submodules
----------
nabu.tests module
-----------------
.. automodule:: nabu.tests
:members:
:undoc-members:
:show-inheritance:
nabu.testutils module
---------------------
.. automodule:: nabu.testutils
:members:
:undoc-members:
:show-inheritance:
nabu.utils module
-----------------
.. automodule:: nabu.utils
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu
:members:
:undoc-members:
:show-inheritance:
nabu.thirdparty package
=======================
Submodules
----------
nabu.thirdparty.tomopy\_phase module
------------------------------------
.. automodule:: nabu.thirdparty.tomopy_phase
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: nabu.thirdparty
:members:
:undoc-members:
:show-inheritance:
setup module
============
.. automodule:: setup
:members:
:undoc-members:
:show-inheritance:
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment