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

:mod:`core`
===========
.. automodule:: dmipy.core

.. currentmodule:: dmipy.core
.. autosummary::


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

Module: :mod:`core.acquisition_scheme`
--------------------------------------
.. automodule:: dmipy.core.acquisition_scheme

.. currentmodule:: dmipy.core.acquisition_scheme
.. autosummary::

   DmipyAcquisitionScheme
   GradientTable
   RotationalHarmonicsAcquisitionScheme
   SphericalMeanAcquisitionScheme
   acquisition_scheme_from_bvalues
   acquisition_scheme_from_gradient_strengths
   acquisition_scheme_from_qvalues
   acquisition_scheme_from_schemefile
   b_from_g
   b_from_q
   calculate_shell_bvalues_and_indices
   check_acquisition_scheme
   fcluster
   g_from_b
   g_from_q
   get_sh_order_from_bval
   gradient_table
   gtab_dipy2mipy
   gtab_mipy2dipy
   linkage
   q_from_b
   q_from_g
   real_sym_rh_basis
   real_sym_sh_mrtrix
   unify_length_reference_delta_Delta
   warn

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

Module: :mod:`core.constants`
-----------------------------
.. automodule:: dmipy.core.constants

.. currentmodule:: dmipy.core.constants
.. autosummary::


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

Module: :mod:`core.fitted_modeling_framework`
---------------------------------------------
.. automodule:: dmipy.core.fitted_modeling_framework

.. currentmodule:: dmipy.core.fitted_modeling_framework
.. autosummary::

   FittedMultiCompartmentModel
   FittedMultiCompartmentSphericalMeanModel
   partial
   T1_tortuosity
   estimate_spherical_mean_multi_shell
   fractional_parameter
   get_sphere
   sh_to_sf_matrix
   unitsphere2cart_Nd

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

Module: :mod:`core.gradient_conversions`
----------------------------------------
.. automodule:: dmipy.core.gradient_conversions

.. currentmodule:: dmipy.core.gradient_conversions
.. autosummary::

   b_from_g
   b_from_q
   g_from_b
   g_from_q
   q_from_b
   q_from_g

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

Module: :mod:`core.modeling_framework`
--------------------------------------
.. automodule:: dmipy.core.modeling_framework

.. currentmodule:: dmipy.core.modeling_framework
.. autosummary::

   Brute2FineOptimizer
   FittedMultiCompartmentModel
   FittedMultiCompartmentSphericalMeanModel
   GlobalBruteOptimizer
   MixOptimizer
   ModelProperties
   MultiCompartmentModel
   MultiCompartmentModelProperties
   MultiCompartmentSphericalMeanModel
   OrderedDict
   ReturnFixedValue
   T1_tortuosity
   estimate_spherical_mean_multi_shell
   fractional_parameter
   homogenize_x0_to_data
   optional_package
   parameter_equality
   time


.. currentmodule:: dmipy.core


.. currentmodule:: dmipy.core.acquisition_scheme


:class:`DmipyAcquisitionScheme`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`GradientTable`
~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`RotationalHarmonicsAcquisitionScheme`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`SphericalMeanAcquisitionScheme`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__

acquisition_scheme_from_bvalues
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: acquisition_scheme_from_bvalues

acquisition_scheme_from_gradient_strengths
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: acquisition_scheme_from_gradient_strengths

acquisition_scheme_from_qvalues
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: acquisition_scheme_from_qvalues

acquisition_scheme_from_schemefile
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: acquisition_scheme_from_schemefile

b_from_g
~~~~~~~~

.. autofunction:: b_from_g

b_from_q
~~~~~~~~

.. autofunction:: b_from_q

calculate_shell_bvalues_and_indices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: calculate_shell_bvalues_and_indices

check_acquisition_scheme
~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: check_acquisition_scheme

fcluster
~~~~~~~~

.. autofunction:: fcluster

g_from_b
~~~~~~~~

.. autofunction:: g_from_b

g_from_q
~~~~~~~~

.. autofunction:: g_from_q

get_sh_order_from_bval
~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: get_sh_order_from_bval

gradient_table
~~~~~~~~~~~~~~

.. autofunction:: gradient_table

gtab_dipy2mipy
~~~~~~~~~~~~~~

.. autofunction:: gtab_dipy2mipy

gtab_mipy2dipy
~~~~~~~~~~~~~~

.. autofunction:: gtab_mipy2dipy

linkage
~~~~~~~

.. autofunction:: linkage

q_from_b
~~~~~~~~

.. autofunction:: q_from_b

q_from_g
~~~~~~~~

.. autofunction:: q_from_g

real_sym_rh_basis
~~~~~~~~~~~~~~~~~

.. autofunction:: real_sym_rh_basis

real_sym_sh_mrtrix
~~~~~~~~~~~~~~~~~~

.. autofunction:: real_sym_sh_mrtrix

unify_length_reference_delta_Delta
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: unify_length_reference_delta_Delta

warn
~~~~

.. autofunction:: warn


.. currentmodule:: dmipy.core.constants


.. currentmodule:: dmipy.core.fitted_modeling_framework


:class:`FittedMultiCompartmentModel`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`FittedMultiCompartmentSphericalMeanModel`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`partial`
~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__

T1_tortuosity
~~~~~~~~~~~~~

.. autofunction:: T1_tortuosity

estimate_spherical_mean_multi_shell
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: estimate_spherical_mean_multi_shell

fractional_parameter
~~~~~~~~~~~~~~~~~~~~

.. autofunction:: fractional_parameter

get_sphere
~~~~~~~~~~

.. autofunction:: get_sphere

sh_to_sf_matrix
~~~~~~~~~~~~~~~

.. autofunction:: sh_to_sf_matrix

unitsphere2cart_Nd
~~~~~~~~~~~~~~~~~~

.. autofunction:: unitsphere2cart_Nd


.. currentmodule:: dmipy.core.gradient_conversions

b_from_g
~~~~~~~~

.. autofunction:: b_from_g

b_from_q
~~~~~~~~

.. autofunction:: b_from_q

g_from_b
~~~~~~~~

.. autofunction:: g_from_b

g_from_q
~~~~~~~~

.. autofunction:: g_from_q

q_from_b
~~~~~~~~

.. autofunction:: q_from_b

q_from_g
~~~~~~~~

.. autofunction:: q_from_g


.. currentmodule:: dmipy.core.modeling_framework


:class:`Brute2FineOptimizer`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`FittedMultiCompartmentModel`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`FittedMultiCompartmentSphericalMeanModel`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`GlobalBruteOptimizer`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`MixOptimizer`
~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


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


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

  .. automethod:: __init__


:class:`MultiCompartmentModel`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`MultiCompartmentModelProperties`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`MultiCompartmentSphericalMeanModel`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`OrderedDict`
~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__


:class:`ReturnFixedValue`
~~~~~~~~~~~~~~~~~~~~~~~~~


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

  .. automethod:: __init__

T1_tortuosity
~~~~~~~~~~~~~

.. autofunction:: T1_tortuosity

estimate_spherical_mean_multi_shell
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: estimate_spherical_mean_multi_shell

fractional_parameter
~~~~~~~~~~~~~~~~~~~~

.. autofunction:: fractional_parameter

homogenize_x0_to_data
~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: homogenize_x0_to_data

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

.. autofunction:: optional_package

parameter_equality
~~~~~~~~~~~~~~~~~~

.. autofunction:: parameter_equality

time
~~~~

.. autofunction:: time