.. AUTO-GENERATED FILE -- DO NOT EDIT!

:mod:`signal_models`
====================
.. automodule:: dmipy.signal_models

.. currentmodule:: dmipy.signal_models
.. autosummary::


.. AUTO-GENERATED FILE -- DO NOT EDIT!

Module: :mod:`signal_models.capped_cylinder_models`
---------------------------------------------------
.. automodule:: dmipy.signal_models.capped_cylinder_models

.. currentmodule:: dmipy.signal_models.capped_cylinder_models
.. autosummary::

   CC2CappedCylinderStejskalTannerApproximation
   CC3CappedCylinderCallaghanApproximation
   ModelProperties

.. AUTO-GENERATED FILE -- DO NOT EDIT!

Module: :mod:`signal_models.cylinder_models`
--------------------------------------------
.. automodule:: dmipy.signal_models.cylinder_models

.. currentmodule:: dmipy.signal_models.cylinder_models
.. autosummary::

   C1Stick
   C2CylinderStejskalTannerApproximation
   C3CylinderCallaghanApproximation
   C4CylinderGaussianPhaseApproximation
   ModelProperties
   optional_package

.. AUTO-GENERATED FILE -- DO NOT EDIT!

Module: :mod:`signal_models.gaussian_models`
--------------------------------------------
.. automodule:: dmipy.signal_models.gaussian_models

.. currentmodule:: dmipy.signal_models.gaussian_models
.. autosummary::

   G1Ball
   G2Zeppelin
   G3TemporalZeppelin
   ModelProperties
   optional_package

.. AUTO-GENERATED FILE -- DO NOT EDIT!

Module: :mod:`signal_models.plane_models`
-----------------------------------------
.. automodule:: dmipy.signal_models.plane_models

.. currentmodule:: dmipy.signal_models.plane_models
.. autosummary::

   ModelProperties
   P2PlaneStejskalTannerApproximation
   P3PlaneCallaghanApproximation

.. AUTO-GENERATED FILE -- DO NOT EDIT!

Module: :mod:`signal_models.sphere_models`
------------------------------------------
.. automodule:: dmipy.signal_models.sphere_models

.. currentmodule:: dmipy.signal_models.sphere_models
.. autosummary::

   ModelProperties
   S1Dot
   S2SphereStejskalTannerApproximation
   S4SphereGaussianPhaseApproximation


.. currentmodule:: dmipy.signal_models


.. currentmodule:: dmipy.signal_models.capped_cylinder_models


:class:`CC2CappedCylinderStejskalTannerApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: CC2CappedCylinderStejskalTannerApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`CC3CappedCylinderCallaghanApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: CC3CappedCylinderCallaghanApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`ModelProperties`
~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: ModelProperties
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


.. currentmodule:: dmipy.signal_models.cylinder_models


:class:`C1Stick`
~~~~~~~~~~~~~~~~


.. autoclass:: C1Stick
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`C2CylinderStejskalTannerApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: C2CylinderStejskalTannerApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`C3CylinderCallaghanApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: C3CylinderCallaghanApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`C4CylinderGaussianPhaseApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: C4CylinderGaussianPhaseApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`ModelProperties`
~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: ModelProperties
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__

optional_package
~~~~~~~~~~~~~~~~

.. autofunction:: optional_package


.. currentmodule:: dmipy.signal_models.gaussian_models


:class:`G1Ball`
~~~~~~~~~~~~~~~


.. autoclass:: G1Ball
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`G2Zeppelin`
~~~~~~~~~~~~~~~~~~~


.. autoclass:: G2Zeppelin
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`G3TemporalZeppelin`
~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: G3TemporalZeppelin
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`ModelProperties`
~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: ModelProperties
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__

optional_package
~~~~~~~~~~~~~~~~

.. autofunction:: optional_package


.. currentmodule:: dmipy.signal_models.plane_models


:class:`ModelProperties`
~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: ModelProperties
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`P2PlaneStejskalTannerApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: P2PlaneStejskalTannerApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`P3PlaneCallaghanApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: P3PlaneCallaghanApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


.. currentmodule:: dmipy.signal_models.sphere_models


:class:`ModelProperties`
~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: ModelProperties
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`S1Dot`
~~~~~~~~~~~~~~


.. autoclass:: S1Dot
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`S2SphereStejskalTannerApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: S2SphereStejskalTannerApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__


:class:`S4SphereGaussianPhaseApproximation`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autoclass:: S4SphereGaussianPhaseApproximation
  :members:
  :undoc-members:
  :show-inheritance:

  .. automethod:: __init__