
:mod:`pyFAI` Package
--------------------

.. automodule:: pyFAI.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`average` Module
---------------------

.. automodule:: pyFAI.average
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`azimuthalIntegrator` Module
---------------------------------

.. automodule:: pyFAI.azimuthalIntegrator
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`multi_geometry` Module
----------------------------

.. automodule:: pyFAI.multi_geometry
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`integrate_widget` Module
------------------------------

.. automodule:: pyFAI.integrate_widget
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`geometry` Module
----------------------

.. automodule:: pyFAI.geometry
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`geometryRefinement` Module
--------------------------------

.. automodule:: pyFAI.geometryRefinement
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`goniometer` Module
------------------------

.. automodule:: pyFAI.goniometer
    :members:
    :undoc-members:
    :show-inheritance:



:mod:`detectors` Module
-----------------------

.. automodule:: pyFAI.detectors
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`spline` Module
--------------------

.. automodule:: pyFAI.spline
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`io` Module
----------------

.. automodule:: pyFAI.io
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`calibration` Module
-------------------------

.. automodule:: pyFAI.calibration
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`control_points` Module
----------------------------

.. automodule:: pyFAI.control_points
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`peak_picker` Module
-------------------------

.. automodule:: pyFAI.peak_picker
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`massif` Module
--------------------

.. automodule:: pyFAI.massif
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`blob_detection` Module
----------------------------

.. automodule:: pyFAI.blob_detection
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`calibrant` Module
-----------------------

.. automodule:: pyFAI.calibrant
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`distortion` Module
------------------------

.. automodule:: pyFAI.distortion
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`worker` Module
--------------------

.. automodule:: pyFAI.worker
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`units` Module
-------------------

.. automodule:: pyFAI.units
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`utils.__init__` Module
----------------------------

Sub module with miscelaneous tools

.. automodule:: pyFAI.utils.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`utils.bayes` Module
.........................

Tool for bayesian filtering-out of positive peaks

.. automodule:: pyFAI.utils.bayes
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`utils.shell` Module
.........................

Contains the progress-bar in the shell command line

.. automodule:: pyFAI.utils.shell
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`utils.stringutil` Module
..............................

Enhanced string formatter

.. automodule:: pyFAI.utils.stringutil
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`opencl.__init__` Module
-----------------------------

Contains all OpenCL implementation.

.. automodule:: pyFAI.opencl
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`opencl.common` Module
...........................

.. automodule:: pyFAI.opencl.common
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`opencl.processing` Module
...............................

.. automodule:: pyFAI.opencl.processing
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`opencl.preproc` Module
............................

.. automodule:: pyFAI.opencl.preproc
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`opencl.azim_hist` Module
..............................

.. automodule:: pyFAI.opencl.azim_hist
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`opencl.azim_lut` Module
.............................

.. automodule:: pyFAI.opencl.azim_lut
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`opencl.azim_csr` Module
.............................

.. automodule:: pyFAI.opencl.azim_csr
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`gui.__init__` Module
--------------------------

.. automodule:: pyFAI.gui.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`gui.matplotlib` Module
............................

Initialize properly Matplotlib

.. automodule:: pyFAI.gui.matplotlib
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`gui.qt` Module
....................


.. automodule:: pyFAI.gui.qt
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`gui.utils` Module
.......................

.. automodule:: pyFAI.gui.utils
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext.__init__` Module
--------------------------
Sub-module with all Cython binary extensions

.. automodule:: pyFAI.ext.__init__
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`ext.bilinear` Module
..........................

This extension makes a discrete 2D-array appear like a continuous function thanks
to bilinear interpolations.

.. automodule:: pyFAI.ext.bilinear
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext._bispev` Module
.........................

This extension is a re-implementation of bi-cubic spline evaluation from scipy

.. automodule:: pyFAI.ext._bispev
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext._blob` Module
.......................

Blob detection is used to find peaks in images by performing subsequent blurs

.. automodule:: pyFAI.ext._blob
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext._convolution` Module
..............................

Convolutions in real space are used to blurs images, used in blob-detection algorithm

.. automodule:: pyFAI.ext._convolution
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext._distortion` Module
.............................

Distortion correction are correction are applied by Look-up table (or CSR)

.. automodule:: pyFAI.ext._distortion
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext._geometry` Module
...........................

This extension is a fast-implementation for calculating the geometry, i.e. where
every pixel of an array stays in space (x,y,z) or its (r, \chi) coordinates.

.. automodule:: pyFAI.ext._geometry
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext.histogram` Module
...........................

Re-implementation of the numpy.histogram, optimized for azimuthal integration.
Deprecated, will be replaced by silx.math.histogramnd

.. automodule:: pyFAI.ext.histogram
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext.morphology` Module
............................

The morphology extension provides a couple of binary morphology operations on images.
They are also implemented in scipy.ndimage in the general case, but not as fast.

.. automodule:: pyFAI.ext.morphology
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext.reconstruct` Module
.............................

Very simple inpainting module for reconstructing the missing part of an image (masked)
to be able to use more common algorithms.

.. automodule:: pyFAI.ext.reconstruct
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext.relabel` Module
.........................

Relabel regions, used to flag from largest regions to the smallest

.. automodule:: pyFAI.ext.relabel
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext.preproc` Module
.........................

Contains a preprocessing function in charge of the dark-current subtraction,
flat-field normalization, ... taking care of masked values and normalization.

.. automodule:: pyFAI.ext.preproc
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext._tree` Module
.......................

The tree is used in file hierarchy tree for the diff_map graphical user interface.

.. automodule:: pyFAI.ext._tree
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`ext.watershed` Module
...........................

Peak peaking via inverse watershed for connecting region of high intensity

.. automodule:: pyFAI.ext.watershed
    :members:
    :undoc-members:
    :show-inheritance:
