diff --git a/main/.buildinfo b/main/.buildinfo index 89aca569..daaff665 100644 --- a/main/.buildinfo +++ b/main/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 8a3cc5e1efb5ec4e0e581a4f93a38205 +config: 683bd27dbab8e1c400d11468dda3fdfa tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/_modules/eddymotion/cli/parser.html b/main/_modules/eddymotion/cli/parser.html index 950ec81d..15774456 100644 --- a/main/_modules/eddymotion/cli/parser.html +++ b/main/_modules/eddymotion/cli/parser.html @@ -5,7 +5,7 @@ - eddymotion.cli.parser - eddymotion 24.0.0.dev65 documentation + eddymotion.cli.parser - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
-
eddymotion 24.0.0.dev65 documentation
+
eddymotion 24.0.0.dev67 documentation
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/cli/run.html b/main/_modules/eddymotion/cli/run.html index 01230199..d07ece6f 100644 --- a/main/_modules/eddymotion/cli/run.html +++ b/main/_modules/eddymotion/cli/run.html @@ -5,7 +5,7 @@ - eddymotion.cli.run - eddymotion 24.0.0.dev65 documentation + eddymotion.cli.run - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
-
eddymotion 24.0.0.dev65 documentation
+
eddymotion 24.0.0.dev67 documentation
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/data/dmri.html b/main/_modules/eddymotion/data/dmri.html index cba7648c..ffd474de 100644 --- a/main/_modules/eddymotion/data/dmri.html +++ b/main/_modules/eddymotion/data/dmri.html @@ -5,7 +5,7 @@ - eddymotion.data.dmri - eddymotion 24.0.0.dev65 documentation + eddymotion.data.dmri - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/data/filtering.html b/main/_modules/eddymotion/data/filtering.html index f6a1ec8e..f2011a64 100644 --- a/main/_modules/eddymotion/data/filtering.html +++ b/main/_modules/eddymotion/data/filtering.html @@ -5,7 +5,7 @@ - eddymotion.data.filtering - eddymotion 24.0.0.dev65 documentation + eddymotion.data.filtering - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/data/pet.html b/main/_modules/eddymotion/data/pet.html index e7e5b712..3fd17301 100644 --- a/main/_modules/eddymotion/data/pet.html +++ b/main/_modules/eddymotion/data/pet.html @@ -5,7 +5,7 @@ - eddymotion.data.pet - eddymotion 24.0.0.dev65 documentation + eddymotion.data.pet - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/data/splitting.html b/main/_modules/eddymotion/data/splitting.html index bbff6178..96f26b3c 100644 --- a/main/_modules/eddymotion/data/splitting.html +++ b/main/_modules/eddymotion/data/splitting.html @@ -5,7 +5,7 @@ - eddymotion.data.splitting - eddymotion 24.0.0.dev65 documentation + eddymotion.data.splitting - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/data/utils.html b/main/_modules/eddymotion/data/utils.html index 540e4de1..38cb083a 100644 --- a/main/_modules/eddymotion/data/utils.html +++ b/main/_modules/eddymotion/data/utils.html @@ -5,7 +5,7 @@ - eddymotion.data.utils - eddymotion 24.0.0.dev65 documentation + eddymotion.data.utils - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/estimator.html b/main/_modules/eddymotion/estimator.html index bb09b2ab..2e937898 100644 --- a/main/_modules/eddymotion/estimator.html +++ b/main/_modules/eddymotion/estimator.html @@ -5,7 +5,7 @@ - eddymotion.estimator - eddymotion 24.0.0.dev65 documentation + eddymotion.estimator - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/exceptions.html b/main/_modules/eddymotion/exceptions.html index 5dbbcbca..3d5c8fd7 100644 --- a/main/_modules/eddymotion/exceptions.html +++ b/main/_modules/eddymotion/exceptions.html @@ -5,7 +5,7 @@ - eddymotion.exceptions - eddymotion 24.0.0.dev65 documentation + eddymotion.exceptions - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/math/utils.html b/main/_modules/eddymotion/math/utils.html index 3990e83b..91e37ba9 100644 --- a/main/_modules/eddymotion/math/utils.html +++ b/main/_modules/eddymotion/math/utils.html @@ -5,7 +5,7 @@ - eddymotion.math.utils - eddymotion 24.0.0.dev65 documentation + eddymotion.math.utils - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/model/base.html b/main/_modules/eddymotion/model/base.html index 9d18bf3e..8dd574f6 100644 --- a/main/_modules/eddymotion/model/base.html +++ b/main/_modules/eddymotion/model/base.html @@ -5,7 +5,7 @@ - eddymotion.model.base - eddymotion 24.0.0.dev65 documentation + eddymotion.model.base - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/model/dmri_covariance.html b/main/_modules/eddymotion/model/dmri_covariance.html new file mode 100644 index 00000000..67a4dcd7 --- /dev/null +++ b/main/_modules/eddymotion/model/dmri_covariance.html @@ -0,0 +1,421 @@ + + + + + + + + eddymotion.model.dmri_covariance - eddymotion 24.0.0.dev67 documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + Auto light/dark, in light mode + + + + + + + + + + + + + + + Auto light/dark, in dark mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Skip to content + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+
+ +
+ +
+
+

Source code for eddymotion.model.dmri_covariance

+# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
+# vi: set ft=python sts=4 ts=4 sw=4 et:
+#
+# Copyright 2024 The NiPreps Developers <nipreps@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# We support and encourage derived works from this project, please read
+# about our expectations at
+#
+#     https://www.nipreps.org/community/licensing/
+#
+import numpy as np
+
+
+def _ensure_positive_scale(a):
+    if a <= 0:
+        raise ValueError(f"a must be strictly positive. Provided: {a}")
+
+
+
+[docs] +def compute_exponential_covariance(theta, a): + r"""Compute the exponential covariance matrix following eq. 9 in [Andersson15]_. + + .. math:: + + C(\theta) = \exp(- \frac{\theta}{a}) + + Parameters + ---------- + theta : :obj:`~numpy.ndarray` + Pairwise angles across diffusion gradient encoding directions. + a : :obj:`float` + Positive scale parameter that here determines the "distance" at which θ + the covariance goes to zero. + + Returns + ------- + :obj:`~numpy.ndarray` + Exponential covariance function values. + """ + + _ensure_positive_scale(a) + + return np.exp(-theta / a)
+ + + +
+[docs] +def compute_spherical_covariance(theta, a): + r"""Compute the spherical covariance matrix following eq. 10 in [Andersson15]_. + + .. math:: + + C(\theta) = \begin{cases} + 1 - \frac{3 \theta}{2 a} + \frac{\theta^3}{2 a^3} & \textnormal{if} \; \theta \leq a \\ + 0 & \textnormal{if} \; \theta > a + \end{cases} + + Parameters + ---------- + theta : :obj:`~numpy.ndarray` + Pairwise angles across diffusion gradient encoding directions. + a : :obj:`float` + Positive scale parameter that here determines the "distance" at which θ + the covariance goes to zero. + + Returns + ------- + :obj:`~numpy.ndarray` + Spherical covariance matrix. + """ + + _ensure_positive_scale(a) + + return np.where(theta <= a, 1 - 3 * (theta / a) ** 2 + 2 * (theta / a) ** 3, 0)
+ +
+
+
+
+ + +
+
+ + Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/main/_modules/eddymotion/model/dmri_utils.html b/main/_modules/eddymotion/model/dmri_utils.html index 8a5aa637..f41c44fc 100644 --- a/main/_modules/eddymotion/model/dmri_utils.html +++ b/main/_modules/eddymotion/model/dmri_utils.html @@ -5,7 +5,7 @@ - eddymotion.model.dmri_utils - eddymotion 24.0.0.dev65 documentation + eddymotion.model.dmri_utils - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/model/gradient_utils.html b/main/_modules/eddymotion/model/gradient_utils.html index 3f2f4fea..8e88d683 100644 --- a/main/_modules/eddymotion/model/gradient_utils.html +++ b/main/_modules/eddymotion/model/gradient_utils.html @@ -5,7 +5,7 @@ - eddymotion.model.gradient_utils - eddymotion 24.0.0.dev65 documentation + eddymotion.model.gradient_utils - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/eddymotion/utils.html b/main/_modules/eddymotion/utils.html index 27b8a637..6d17d058 100644 --- a/main/_modules/eddymotion/utils.html +++ b/main/_modules/eddymotion/utils.html @@ -5,7 +5,7 @@ - eddymotion.utils - eddymotion 24.0.0.dev65 documentation + eddymotion.utils - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ diff --git a/main/_modules/index.html b/main/_modules/index.html index 8ca00ca1..00f2d456 100644 --- a/main/_modules/index.html +++ b/main/_modules/index.html @@ -5,7 +5,7 @@ - Overview: module code - eddymotion 24.0.0.dev65 documentation + Overview: module code - eddymotion 24.0.0.dev67 documentation @@ -179,7 +179,7 @@
@@ -202,14 +202,14 @@ +
diff --git a/main/_sources/api/eddymotion.model.dmri_covariance.rst.txt b/main/_sources/api/eddymotion.model.dmri_covariance.rst.txt new file mode 100644 index 00000000..36898c05 --- /dev/null +++ b/main/_sources/api/eddymotion.model.dmri_covariance.rst.txt @@ -0,0 +1,7 @@ +eddymotion.model.dmri\_covariance module +======================================== + +.. automodule:: eddymotion.model.dmri_covariance + :members: + :undoc-members: + :show-inheritance: diff --git a/main/_sources/api/eddymotion.model.rst.txt b/main/_sources/api/eddymotion.model.rst.txt index fb122cbe..499e7158 100644 --- a/main/_sources/api/eddymotion.model.rst.txt +++ b/main/_sources/api/eddymotion.model.rst.txt @@ -13,5 +13,6 @@ Submodules :maxdepth: 1 eddymotion.model.base + eddymotion.model.dmri_covariance eddymotion.model.dmri_utils eddymotion.model.gradient_utils diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js index 367eb334..c2a54489 100644 --- a/main/_static/documentation_options.js +++ b/main/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '24.0.0.dev65', + VERSION: '24.0.0.dev67', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/main/api/eddymotion.cli.html b/main/api/eddymotion.cli.html index 46a17e48..9fde9b2c 100644 --- a/main/api/eddymotion.cli.html +++ b/main/api/eddymotion.cli.html @@ -6,7 +6,7 @@ - eddymotion.cli package - eddymotion 24.0.0.dev65 documentation + eddymotion.cli package - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.cli.run.html b/main/api/eddymotion.cli.run.html index 3a374396..80afb5ed 100644 --- a/main/api/eddymotion.cli.run.html +++ b/main/api/eddymotion.cli.run.html @@ -6,7 +6,7 @@ - eddymotion.cli.run module - eddymotion 24.0.0.dev65 documentation + eddymotion.cli.run module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.data.dmri.html b/main/api/eddymotion.data.dmri.html index 3e4b8b08..ec7fd2d2 100644 --- a/main/api/eddymotion.data.dmri.html +++ b/main/api/eddymotion.data.dmri.html @@ -6,7 +6,7 @@ - eddymotion.data.dmri module - eddymotion 24.0.0.dev65 documentation + eddymotion.data.dmri module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.data.filtering.html b/main/api/eddymotion.data.filtering.html index f4194061..60c5c8e7 100644 --- a/main/api/eddymotion.data.filtering.html +++ b/main/api/eddymotion.data.filtering.html @@ -6,7 +6,7 @@ - eddymotion.data.filtering module - eddymotion 24.0.0.dev65 documentation + eddymotion.data.filtering module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.data.html b/main/api/eddymotion.data.html index 3c6e1a80..dc13843c 100644 --- a/main/api/eddymotion.data.html +++ b/main/api/eddymotion.data.html @@ -6,7 +6,7 @@ - eddymotion.data package - eddymotion 24.0.0.dev65 documentation + eddymotion.data package - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.data.splitting.html b/main/api/eddymotion.data.splitting.html index 0ade6004..91850bc5 100644 --- a/main/api/eddymotion.data.splitting.html +++ b/main/api/eddymotion.data.splitting.html @@ -6,7 +6,7 @@ - eddymotion.data.splitting module - eddymotion 24.0.0.dev65 documentation + eddymotion.data.splitting module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.data.utils.html b/main/api/eddymotion.data.utils.html index 9b0d9736..9154a283 100644 --- a/main/api/eddymotion.data.utils.html +++ b/main/api/eddymotion.data.utils.html @@ -6,7 +6,7 @@ - eddymotion.data.utils module - eddymotion 24.0.0.dev65 documentation + eddymotion.data.utils module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.estimator.html b/main/api/eddymotion.estimator.html index 252c5526..f534274b 100644 --- a/main/api/eddymotion.estimator.html +++ b/main/api/eddymotion.estimator.html @@ -6,7 +6,7 @@ - eddymotion.estimator module - eddymotion 24.0.0.dev65 documentation + eddymotion.estimator module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.exceptions.html b/main/api/eddymotion.exceptions.html index d152fbfa..e99b4805 100644 --- a/main/api/eddymotion.exceptions.html +++ b/main/api/eddymotion.exceptions.html @@ -6,7 +6,7 @@ - eddymotion.exceptions module - eddymotion 24.0.0.dev65 documentation + eddymotion.exceptions module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.math.html b/main/api/eddymotion.math.html index f5ea98ee..9646a579 100644 --- a/main/api/eddymotion.math.html +++ b/main/api/eddymotion.math.html @@ -6,7 +6,7 @@ - eddymotion.math package - eddymotion 24.0.0.dev65 documentation + eddymotion.math package - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.model.base.html b/main/api/eddymotion.model.base.html index fa1c3bdb..af7befc6 100644 --- a/main/api/eddymotion.model.base.html +++ b/main/api/eddymotion.model.base.html @@ -3,10 +3,10 @@ - + - eddymotion.model.base module - eddymotion 24.0.0.dev65 documentation + eddymotion.model.base module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ diff --git a/main/api/eddymotion.model.dmri_covariance.html b/main/api/eddymotion.model.dmri_covariance.html new file mode 100644 index 00000000..2d0f391d --- /dev/null +++ b/main/api/eddymotion.model.dmri_covariance.html @@ -0,0 +1,433 @@ + + + + + + + + + eddymotion.model.dmri_covariance module - eddymotion 24.0.0.dev67 documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + Auto light/dark, in light mode + + + + + + + + + + + + + + + Auto light/dark, in dark mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Skip to content + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+ +
+
+
+

eddymotion.model.dmri_covariance module

+
+
+eddymotion.model.dmri_covariance.compute_exponential_covariance(theta, a)[source]
+

Compute the exponential covariance matrix following eq. 9 in [Andersson15].

+
+
+\[C(\theta) = \exp(- \frac{\theta}{a})\]
+
+
+
Parameters:
+
    +
  • theta (ndarray) – Pairwise angles across diffusion gradient encoding directions.

  • +
  • a (float) – Positive scale parameter that here determines the “distance” at which θ +the covariance goes to zero.

  • +
+
+
Returns:
+

Exponential covariance function values.

+
+
Return type:
+

ndarray

+
+
+
+ +
+
+eddymotion.model.dmri_covariance.compute_spherical_covariance(theta, a)[source]
+

Compute the spherical covariance matrix following eq. 10 in [Andersson15].

+
+
+\[\begin{split}C(\theta) = \begin{cases} + 1 - \frac{3 \theta}{2 a} + \frac{\theta^3}{2 a^3} & \textnormal{if} \; \theta \leq a \\ + 0 & \textnormal{if} \; \theta > a +\end{cases}\end{split}\]
+
+
+
Parameters:
+
    +
  • theta (ndarray) – Pairwise angles across diffusion gradient encoding directions.

  • +
  • a (float) – Positive scale parameter that here determines the “distance” at which θ +the covariance goes to zero.

  • +
+
+
Returns:
+

Spherical covariance matrix.

+
+
Return type:
+

ndarray

+
+
+
+ +
+ +
+
+ +
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/main/api/eddymotion.model.dmri_utils.html b/main/api/eddymotion.model.dmri_utils.html index 647114fb..b27c8077 100644 --- a/main/api/eddymotion.model.dmri_utils.html +++ b/main/api/eddymotion.model.dmri_utils.html @@ -3,10 +3,10 @@ - + - eddymotion.model.dmri_utils module - eddymotion 24.0.0.dev65 documentation + eddymotion.model.dmri_utils module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ -
+
diff --git a/main/api/eddymotion.model.gradient_utils.html b/main/api/eddymotion.model.gradient_utils.html index 6ff019bc..9c02c8e0 100644 --- a/main/api/eddymotion.model.gradient_utils.html +++ b/main/api/eddymotion.model.gradient_utils.html @@ -6,7 +6,7 @@ - eddymotion.model.gradient_utils module - eddymotion 24.0.0.dev65 documentation + eddymotion.model.gradient_utils module - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/api/eddymotion.model.html b/main/api/eddymotion.model.html index 1384ccfc..f651f0d4 100644 --- a/main/api/eddymotion.model.html +++ b/main/api/eddymotion.model.html @@ -6,7 +6,7 @@ - eddymotion.model package - eddymotion 24.0.0.dev65 documentation + eddymotion.model package - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/changes.html b/main/changes.html index 2460241a..1d5e46d3 100644 --- a/main/changes.html +++ b/main/changes.html @@ -6,7 +6,7 @@ - What’s new? - eddymotion 24.0.0.dev65 documentation + What’s new? - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@
@@ -203,14 +203,14 @@
diff --git a/main/index.html b/main/index.html index e62700f0..dfec86c7 100644 --- a/main/index.html +++ b/main/index.html @@ -6,7 +6,7 @@ - eddymotion 24.0.0.dev65 documentation + eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/objects.inv b/main/objects.inv index d9c958d2..60a7f213 100644 Binary files a/main/objects.inv and b/main/objects.inv differ diff --git a/main/py-modindex.html b/main/py-modindex.html index c9106d14..ad5c719b 100644 --- a/main/py-modindex.html +++ b/main/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - eddymotion 24.0.0.dev65 documentation + Python Module Index - eddymotion 24.0.0.dev67 documentation @@ -178,7 +178,7 @@
@@ -201,14 +201,14 @@ +
diff --git a/main/running.html b/main/running.html index 8057c073..d4aeb394 100644 --- a/main/running.html +++ b/main/running.html @@ -6,7 +6,7 @@ - Running Eddymotion - eddymotion 24.0.0.dev65 documentation + Running Eddymotion - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@
@@ -203,14 +203,14 @@ +
diff --git a/main/searchindex.js b/main/searchindex.js index a6d59605..9ab46f64 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"0.1.15 (mai 13, 2024)": [[18, "mai-13-2024"]], "0.1.4 (April 12, 2021)": [[18, "april-12-2021"]], "Command line interface": [[23, "command-line-interface"]], "Contents": [[20, "contents"]], "Contributing": [[19, "contributing"]], "Documentation": [[19, "documentation"]], "Eddymotion": [[20, "eddymotion"]], "External Dependencies": [[21, "external-dependencies"]], "For developers": [[19, "for-developers"]], "How to Use": [[24, "how-to-use"]], "Incorporating Eddymotion into a Python module or script": [[24, "incorporating-eddymotion-into-a-python-module-or-script"]], "Installation": [[21, "id1"]], "Library API (application program interface)": [[19, "library-api-application-program-interface"]], "Named Arguments": [[23, "named-arguments"]], "Positional Arguments": [[23, "positional-arguments"]], "Running Eddymotion": [[23, "running-eddymotion"]], "Submodules": [[0, "submodules"], [3, "submodules"], [11, "submodules"], [13, "submodules"]], "What\u2019s new?": [[18, "what-s-new"]], "eddymotion.cli package": [[0, "module-eddymotion.cli"]], "eddymotion.cli.parser module": [[1, "module-eddymotion.cli.parser"]], "eddymotion.cli.run module": [[2, "module-eddymotion.cli.run"]], "eddymotion.data package": [[3, "module-eddymotion.data"]], "eddymotion.data.dmri module": [[4, "module-eddymotion.data.dmri"]], "eddymotion.data.filtering module": [[5, "module-eddymotion.data.filtering"]], "eddymotion.data.pet module": [[6, "module-eddymotion.data.pet"]], "eddymotion.data.splitting module": [[7, "module-eddymotion.data.splitting"]], "eddymotion.data.utils module": [[8, "module-eddymotion.data.utils"]], "eddymotion.estimator module": [[9, "module-eddymotion.estimator"]], "eddymotion.exceptions module": [[10, "module-eddymotion.exceptions"]], "eddymotion.math package": [[11, "module-eddymotion.math"]], "eddymotion.math.utils module": [[12, "module-eddymotion.math.utils"]], "eddymotion.model package": [[13, "module-eddymotion.model"]], "eddymotion.model.base module": [[14, "module-eddymotion.model.base"]], "eddymotion.model.dmri_utils module": [[15, "module-eddymotion.model.dmri_utils"]], "eddymotion.model.gradient_utils module": [[16, "module-eddymotion.model.gradient_utils"]], "eddymotion.utils module": [[17, "module-eddymotion.utils"]]}, "docnames": ["api/eddymotion.cli", "api/eddymotion.cli.parser", "api/eddymotion.cli.run", "api/eddymotion.data", "api/eddymotion.data.dmri", "api/eddymotion.data.filtering", "api/eddymotion.data.pet", "api/eddymotion.data.splitting", "api/eddymotion.data.utils", "api/eddymotion.estimator", "api/eddymotion.exceptions", "api/eddymotion.math", "api/eddymotion.math.utils", "api/eddymotion.model", "api/eddymotion.model.base", "api/eddymotion.model.dmri_utils", "api/eddymotion.model.gradient_utils", "api/eddymotion.utils", "changes", "developers", "index", "installation", "links", "running", "usage"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1}, "filenames": ["api/eddymotion.cli.rst", "api/eddymotion.cli.parser.rst", "api/eddymotion.cli.run.rst", "api/eddymotion.data.rst", "api/eddymotion.data.dmri.rst", "api/eddymotion.data.filtering.rst", "api/eddymotion.data.pet.rst", "api/eddymotion.data.splitting.rst", "api/eddymotion.data.utils.rst", "api/eddymotion.estimator.rst", "api/eddymotion.exceptions.rst", "api/eddymotion.math.rst", "api/eddymotion.math.utils.rst", "api/eddymotion.model.rst", "api/eddymotion.model.base.rst", "api/eddymotion.model.dmri_utils.rst", "api/eddymotion.model.gradient_utils.rst", "api/eddymotion.utils.rst", "changes.rst", "developers.rst", "index.rst", "installation.rst", "links.rst", "running.rst", "usage.rst"], "indexentries": {"advanced_clip() (in module eddymotion.data.filtering)": [[5, "eddymotion.data.filtering.advanced_clip", false]], "affine (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.affine", false]], "affine (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.affine", false]], "apply_affines() (in module eddymotion.data.utils)": [[8, "eddymotion.data.utils.apply_affines", false]], "averagedwmodel (class in eddymotion.model)": [[13, "eddymotion.model.AverageDWModel", false]], "averagedwmodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.AverageDWModel", false]], "basedwimodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.BaseDWIModel", false]], "basemodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.BaseModel", false]], "brainmask (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.brainmask", false]], "brainmask (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.brainmask", false]], "bvalue_iterator() (in module eddymotion.utils)": [[17, "eddymotion.utils.bvalue_iterator", false]], "bzero (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.bzero", false]], "centralsym_iterator() (in module eddymotion.utils)": [[17, "eddymotion.utils.centralsym_iterator", false]], "compute_angle() (in module eddymotion.math.utils)": [[12, "eddymotion.math.utils.compute_angle", false]], "compute_pairwise_angles() (in module eddymotion.model.gradient_utils)": [[16, "eddymotion.model.gradient_utils.compute_pairwise_angles", false]], "dataobj (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.dataobj", false]], "dataobj (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.dataobj", false]], "default_clip_percentile (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_CLIP_PERCENTILE", false]], "default_dtype (in module eddymotion.data.filtering)": [[5, "eddymotion.data.filtering.DEFAULT_DTYPE", false]], "default_highb_threshold (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_HIGHB_THRESHOLD", false]], "default_lowb_threshold (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_LOWB_THRESHOLD", false]], "default_max_bval (in module eddymotion.model.dmri_utils)": [[15, "eddymotion.model.dmri_utils.DEFAULT_MAX_BVAL", false]], "default_max_bvalue (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_MAX_BVALUE", false]], "default_max_s0 (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_MAX_S0", false]], "default_min_s0 (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_MIN_S0", false]], "default_multishell_bin_count_thr (in module eddymotion.model.dmri_utils)": [[15, "eddymotion.model.dmri_utils.DEFAULT_MULTISHELL_BIN_COUNT_THR", false]], "default_num_bins (in module eddymotion.model.dmri_utils)": [[15, "eddymotion.model.dmri_utils.DEFAULT_NUM_BINS", false]], "default_timeframe_midpoint_tol (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_TIMEFRAME_MIDPOINT_TOL", false]], "dkimodel (class in eddymotion.model)": [[13, "eddymotion.model.DKIModel", false]], "dkimodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.DKIModel", false]], "dtimodel (class in eddymotion.model)": [[13, "eddymotion.model.DTIModel", false]], "dtimodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.DTIModel", false]], "dwi (class in eddymotion.data.dmri)": [[4, "eddymotion.data.dmri.DWI", false]], "eddymotion.cli": [[0, "module-eddymotion.cli", false]], "eddymotion.cli.parser": [[1, "module-eddymotion.cli.parser", false]], "eddymotion.cli.run": [[2, "module-eddymotion.cli.run", false]], "eddymotion.data": [[3, "module-eddymotion.data", false]], "eddymotion.data.dmri": [[4, "module-eddymotion.data.dmri", false]], "eddymotion.data.filtering": [[5, "module-eddymotion.data.filtering", false]], "eddymotion.data.pet": [[6, "module-eddymotion.data.pet", false]], "eddymotion.data.splitting": [[7, "module-eddymotion.data.splitting", false]], "eddymotion.data.utils": [[8, "module-eddymotion.data.utils", false]], "eddymotion.estimator": [[9, "module-eddymotion.estimator", false]], "eddymotion.exceptions": [[10, "module-eddymotion.exceptions", false]], "eddymotion.math": [[11, "module-eddymotion.math", false]], "eddymotion.math.utils": [[12, "module-eddymotion.math.utils", false]], "eddymotion.model": [[13, "module-eddymotion.model", false]], "eddymotion.model.base": [[14, "module-eddymotion.model.base", false]], "eddymotion.model.dmri_utils": [[15, "module-eddymotion.model.dmri_utils", false]], "eddymotion.model.gradient_utils": [[16, "module-eddymotion.model.gradient_utils", false]], "eddymotion.utils": [[17, "module-eddymotion.utils", false]], "eddymotionestimator (class in eddymotion.estimator)": [[9, "eddymotion.estimator.EddyMotionEstimator", false]], "em_affines (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.em_affines", false]], "em_affines (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.em_affines", false]], "estimate() (eddymotion.estimator.eddymotionestimator static method)": [[9, "eddymotion.estimator.EddyMotionEstimator.estimate", false]], "fieldmap (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.fieldmap", false]], "find_shelling_scheme() (in module eddymotion.model.dmri_utils)": [[15, "eddymotion.model.dmri_utils.find_shelling_scheme", false]], "fit() (eddymotion.model.averagedwmodel method)": [[13, "eddymotion.model.AverageDWModel.fit", false]], "fit() (eddymotion.model.base.averagedwmodel method)": [[14, "eddymotion.model.base.AverageDWModel.fit", false]], "fit() (eddymotion.model.base.basedwimodel method)": [[14, "eddymotion.model.base.BaseDWIModel.fit", false]], "fit() (eddymotion.model.base.basemodel method)": [[14, "eddymotion.model.base.BaseModel.fit", false]], "fit() (eddymotion.model.base.petmodel method)": [[14, "eddymotion.model.base.PETModel.fit", false]], "fit() (eddymotion.model.base.trivialb0model method)": [[14, "eddymotion.model.base.TrivialB0Model.fit", false]], "fit() (eddymotion.model.petmodel method)": [[13, "eddymotion.model.PETModel.fit", false]], "fit() (eddymotion.model.trivialb0model method)": [[13, "eddymotion.model.TrivialB0Model.fit", false]], "frame_time (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.frame_time", false]], "from_filename() (eddymotion.data.dmri.dwi class method)": [[4, "eddymotion.data.dmri.DWI.from_filename", false]], "from_filename() (eddymotion.data.pet.pet class method)": [[6, "eddymotion.data.pet.PET.from_filename", false]], "get_filename() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.get_filename", false]], "gradients (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.gradients", false]], "init() (eddymotion.model.base.modelfactory static method)": [[14, "eddymotion.model.base.ModelFactory.init", false]], "init() (eddymotion.model.modelfactory static method)": [[13, "eddymotion.model.ModelFactory.init", false]], "is_fitted (eddymotion.model.base.basemodel property)": [[14, "eddymotion.model.base.BaseModel.is_fitted", false]], "is_fitted (eddymotion.model.base.petmodel property)": [[14, "eddymotion.model.base.PETModel.is_fitted", false]], "is_fitted (eddymotion.model.base.trivialb0model property)": [[14, "eddymotion.model.base.TrivialB0Model.is_fitted", false]], "is_fitted (eddymotion.model.petmodel property)": [[13, "eddymotion.model.PETModel.is_fitted", false]], "is_fitted (eddymotion.model.trivialb0model property)": [[13, "eddymotion.model.TrivialB0Model.is_fitted", false]], "is_positive_definite() (in module eddymotion.math.utils)": [[12, "eddymotion.math.utils.is_positive_definite", false]], "linear_iterator() (in module eddymotion.utils)": [[17, "eddymotion.utils.linear_iterator", false]], "load() (in module eddymotion.data.dmri)": [[4, "eddymotion.data.dmri.load", false]], "load() (in module eddymotion.data.pet)": [[6, "eddymotion.data.pet.load", false]], "lovo_split() (in module eddymotion.data.splitting)": [[7, "eddymotion.data.splitting.lovo_split", false]], "main() (in module eddymotion.cli.run)": [[2, "eddymotion.cli.run.main", false]], "modelfactory (class in eddymotion.model)": [[13, "eddymotion.model.ModelFactory", false]], "modelfactory (class in eddymotion.model.base)": [[14, "eddymotion.model.base.ModelFactory", false]], "modelnotfittederror": [[10, "eddymotion.exceptions.ModelNotFittedError", false]], "module": [[0, "module-eddymotion.cli", false], [1, "module-eddymotion.cli.parser", false], [2, "module-eddymotion.cli.run", false], [3, "module-eddymotion.data", false], [4, "module-eddymotion.data.dmri", false], [5, "module-eddymotion.data.filtering", false], [6, "module-eddymotion.data.pet", false], [7, "module-eddymotion.data.splitting", false], [8, "module-eddymotion.data.utils", false], [9, "module-eddymotion.estimator", false], [10, "module-eddymotion.exceptions", false], [11, "module-eddymotion.math", false], [12, "module-eddymotion.math.utils", false], [13, "module-eddymotion.model", false], [14, "module-eddymotion.model.base", false], [15, "module-eddymotion.model.dmri_utils", false], [16, "module-eddymotion.model.gradient_utils", false], [17, "module-eddymotion.utils", false]], "parse_args() (in module eddymotion.cli.parser)": [[1, "eddymotion.cli.parser.parse_args", false]], "pet (class in eddymotion.data.pet)": [[6, "eddymotion.data.pet.PET", false]], "petmodel (class in eddymotion.model)": [[13, "eddymotion.model.PETModel", false]], "petmodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.PETModel", false]], "plot_gradients() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.plot_gradients", false]], "plot_mosaic() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.plot_mosaic", false]], "predict() (eddymotion.model.averagedwmodel method)": [[13, "eddymotion.model.AverageDWModel.predict", false]], "predict() (eddymotion.model.base.averagedwmodel method)": [[14, "eddymotion.model.base.AverageDWModel.predict", false]], "predict() (eddymotion.model.base.basedwimodel method)": [[14, "eddymotion.model.base.BaseDWIModel.predict", false]], "predict() (eddymotion.model.base.basemodel method)": [[14, "eddymotion.model.base.BaseModel.predict", false]], "predict() (eddymotion.model.base.petmodel method)": [[14, "eddymotion.model.base.PETModel.predict", false]], "predict() (eddymotion.model.base.trivialb0model method)": [[14, "eddymotion.model.base.TrivialB0Model.predict", false]], "predict() (eddymotion.model.petmodel method)": [[13, "eddymotion.model.PETModel.predict", false]], "predict() (eddymotion.model.trivialb0model method)": [[13, "eddymotion.model.TrivialB0Model.predict", false]], "random_iterator() (in module eddymotion.utils)": [[17, "eddymotion.utils.random_iterator", false]], "set_transform() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.set_transform", false]], "set_transform() (eddymotion.data.pet.pet method)": [[6, "eddymotion.data.pet.PET.set_transform", false]], "to_filename() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.to_filename", false]], "to_filename() (eddymotion.data.pet.pet method)": [[6, "eddymotion.data.pet.PET.to_filename", false]], "to_nifti() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.to_nifti", false]], "to_nifti() (eddymotion.data.pet.pet method)": [[6, "eddymotion.data.pet.PET.to_nifti", false]], "total_duration (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.total_duration", false]], "trivialb0model (class in eddymotion.model)": [[13, "eddymotion.model.TrivialB0Model", false]], "trivialb0model (class in eddymotion.model.base)": [[14, "eddymotion.model.base.TrivialB0Model", false]]}, "objects": {"eddymotion": [[0, 0, 0, "-", "cli"], [3, 0, 0, "-", "data"], [9, 0, 0, "-", "estimator"], [10, 0, 0, "-", "exceptions"], [11, 0, 0, "-", "math"], [13, 0, 0, "-", "model"], [17, 0, 0, "-", "utils"]], "eddymotion.cli": [[1, 0, 0, "-", "parser"], [2, 0, 0, "-", "run"]], "eddymotion.cli.parser": [[1, 1, 1, "", "parse_args"]], "eddymotion.cli.run": [[2, 1, 1, "", "main"]], "eddymotion.data": [[4, 0, 0, "-", "dmri"], [5, 0, 0, "-", "filtering"], [6, 0, 0, "-", "pet"], [7, 0, 0, "-", "splitting"], [8, 0, 0, "-", "utils"]], "eddymotion.data.dmri": [[4, 2, 1, "", "DWI"], [4, 1, 1, "", "load"]], "eddymotion.data.dmri.DWI": [[4, 3, 1, "", "affine"], [4, 3, 1, "", "brainmask"], [4, 3, 1, "", "bzero"], [4, 3, 1, "", "dataobj"], [4, 3, 1, "", "em_affines"], [4, 3, 1, "", "fieldmap"], [4, 4, 1, "", "from_filename"], [4, 4, 1, "", "get_filename"], [4, 3, 1, "", "gradients"], [4, 4, 1, "", "plot_gradients"], [4, 4, 1, "", "plot_mosaic"], [4, 4, 1, "", "set_transform"], [4, 4, 1, "", "to_filename"], [4, 4, 1, "", "to_nifti"]], "eddymotion.data.filtering": [[5, 5, 1, "", "DEFAULT_DTYPE"], [5, 1, 1, "", "advanced_clip"]], "eddymotion.data.pet": [[6, 2, 1, "", "PET"], [6, 1, 1, "", "load"]], "eddymotion.data.pet.PET": [[6, 3, 1, "", "affine"], [6, 3, 1, "", "brainmask"], [6, 3, 1, "", "dataobj"], [6, 3, 1, "", "em_affines"], [6, 3, 1, "", "frame_time"], [6, 4, 1, "", "from_filename"], [6, 4, 1, "", "set_transform"], [6, 4, 1, "", "to_filename"], [6, 4, 1, "", "to_nifti"], [6, 3, 1, "", "total_duration"]], "eddymotion.data.splitting": [[7, 1, 1, "", "lovo_split"]], "eddymotion.data.utils": [[8, 1, 1, "", "apply_affines"]], "eddymotion.estimator": [[9, 2, 1, "", "EddyMotionEstimator"]], "eddymotion.estimator.EddyMotionEstimator": [[9, 4, 1, "", "estimate"]], "eddymotion.exceptions": [[10, 6, 1, "", "ModelNotFittedError"]], "eddymotion.math": [[12, 0, 0, "-", "utils"]], "eddymotion.math.utils": [[12, 1, 1, "", "compute_angle"], [12, 1, 1, "", "is_positive_definite"]], "eddymotion.model": [[13, 2, 1, "", "AverageDWModel"], [13, 2, 1, "", "DKIModel"], [13, 2, 1, "", "DTIModel"], [13, 2, 1, "", "ModelFactory"], [13, 2, 1, "", "PETModel"], [13, 2, 1, "", "TrivialB0Model"], [14, 0, 0, "-", "base"], [15, 0, 0, "-", "dmri_utils"], [16, 0, 0, "-", "gradient_utils"]], "eddymotion.model.AverageDWModel": [[13, 4, 1, "", "fit"], [13, 4, 1, "", "predict"]], "eddymotion.model.ModelFactory": [[13, 4, 1, "", "init"]], "eddymotion.model.PETModel": [[13, 4, 1, "", "fit"], [13, 7, 1, "", "is_fitted"], [13, 4, 1, "", "predict"]], "eddymotion.model.TrivialB0Model": [[13, 4, 1, "", "fit"], [13, 7, 1, "", "is_fitted"], [13, 4, 1, "", "predict"]], "eddymotion.model.base": [[14, 2, 1, "", "AverageDWModel"], [14, 2, 1, "", "BaseDWIModel"], [14, 2, 1, "", "BaseModel"], [14, 5, 1, "", "DEFAULT_CLIP_PERCENTILE"], [14, 5, 1, "", "DEFAULT_HIGHB_THRESHOLD"], [14, 5, 1, "", "DEFAULT_LOWB_THRESHOLD"], [14, 5, 1, "", "DEFAULT_MAX_BVALUE"], [14, 5, 1, "", "DEFAULT_MAX_S0"], [14, 5, 1, "", "DEFAULT_MIN_S0"], [14, 5, 1, "", "DEFAULT_TIMEFRAME_MIDPOINT_TOL"], [14, 2, 1, "", "DKIModel"], [14, 2, 1, "", "DTIModel"], [14, 2, 1, "", "ModelFactory"], [14, 2, 1, "", "PETModel"], [14, 2, 1, "", "TrivialB0Model"]], "eddymotion.model.base.AverageDWModel": [[14, 4, 1, "", "fit"], [14, 4, 1, "", "predict"]], "eddymotion.model.base.BaseDWIModel": [[14, 4, 1, "", "fit"], [14, 4, 1, "", "predict"]], "eddymotion.model.base.BaseModel": [[14, 4, 1, "", "fit"], [14, 7, 1, "", "is_fitted"], [14, 4, 1, "", "predict"]], "eddymotion.model.base.ModelFactory": [[14, 4, 1, "", "init"]], "eddymotion.model.base.PETModel": [[14, 4, 1, "", "fit"], [14, 7, 1, "", "is_fitted"], [14, 4, 1, "", "predict"]], "eddymotion.model.base.TrivialB0Model": [[14, 4, 1, "", "fit"], [14, 7, 1, "", "is_fitted"], [14, 4, 1, "", "predict"]], "eddymotion.model.dmri_utils": [[15, 5, 1, "", "DEFAULT_MAX_BVAL"], [15, 5, 1, "", "DEFAULT_MULTISHELL_BIN_COUNT_THR"], [15, 5, 1, "", "DEFAULT_NUM_BINS"], [15, 1, 1, "", "find_shelling_scheme"]], "eddymotion.model.gradient_utils": [[16, 1, 1, "", "compute_pairwise_angles"]], "eddymotion.utils": [[17, 1, 1, "", "bvalue_iterator"], [17, 1, 1, "", "centralsym_iterator"], [17, 1, 1, "", "linear_iterator"], [17, 1, 1, "", "random_iterator"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"], "5": ["py", "data", "Python data"], "6": ["py", "exception", "Python exception"], "7": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method", "5": "py:data", "6": "py:exception", "7": "py:property"}, "terms": {"": [5, 9, 13, 14, 17, 20, 24], "0": [4, 5, 6, 12, 13, 14, 16, 17, 19, 20, 24], "01": 14, "05": 14, "1": [4, 5, 6, 12, 14, 16, 17, 19, 20], "10": 17, "100": 18, "1000": [14, 17, 20], "10000": 14, "102": 18, "103": 18, "104": 18, "105": 18, "106": 18, "1063": [16, 20], "1078": [16, 20], "109": 18, "11": 17, "112": 18, "115": 18, "119": 18, "12": [17, 20], "120": 18, "121": 18, "122": 18, "123": 18, "124": 18, "125": [16, 20], "128": 18, "13": [17, 20], "130": 18, "131": 18, "132": 18, "133": 18, "134": 18, "135": 18, "136": 18, "137": 18, "138": 18, "139": 18, "1396": 20, "14": 17, "141": 18, "1415": [12, 16], "143": 18, "144": 18, "147": 18, "149": 18, "15": [15, 17, 20], "154": 18, "157": 18, "158": 18, "159": 18, "160": 18, "162": 18, "164": 18, "167": 18, "1694": 20, "17": 20, "1702": 20, "172": 18, "173": 18, "175": 18, "177": 18, "179": 18, "18": 20, "182": 18, "183": 18, "185": 18, "190": 18, "1d": 6, "1e": 14, "2": [15, 17, 18, 19, 20], "2000": 17, "2009": 20, "2012": 20, "2014": 20, "2016": [16, 20], "2021": 20, "20210324": 17, "2024": 20, "27": 18, "2d": 4, "3": [4, 6, 12, 13, 14, 16, 17, 18, 20, 21], "30": 18, "32": 18, "33": 18, "35": 5, "3d": [4, 7], "3mnvp9": 14, "4": [9, 17, 20, 24], "42": [17, 24], "4d": [17, 23], "5": [17, 20], "50": [4, 14], "518": 18, "6": [17, 19], "67": 20, "7": [15, 17, 20, 21], "700": 17, "75": 14, "775": 20, "778": 20, "8": [17, 18, 20], "8000": 15, "82": 18, "83": 18, "84": 18, "85": 18, "87": 18, "88": 18, "9": [17, 18], "91": 18, "92": 18, "96": 18, "97": 18, "98": [5, 18], "99": 5, "A": [4, 6, 9, 13, 14, 18, 23, 24], "For": [20, 24], "If": [4, 5, 17, 24], "In": 19, "It": [5, 24], "On": 21, "One": 24, "The": [5, 7, 9, 12, 14, 17, 18, 19, 23, 24], "To": [5, 19, 24], "With": 19, "_": [6, 13, 14], "__init__": 18, "__version__": 21, "_version": 19, "ab": 16, "abov": [5, 21], "abstract": 14, "accept": 24, "accord": 15, "acquir": 20, "acquisit": [6, 20], "across": [16, 18], "action": [18, 19], "ad": 18, "adapt": 14, "add": 18, "address": 20, "adopt": 18, "advanced_clip": [5, 19], "advantag": 20, "affin": [4, 6, 8, 9, 18, 19, 24], "after": 5, "al": [16, 20], "algorithm": [9, 23], "align": [4, 6, 24], "align_config": 23, "align_kwarg": [9, 24], "all": [17, 19, 21], "allow": [9, 14, 18], "alongsid": 18, "also": 4, "alternatingli": 17, "alwai": [13, 14], "amitai": 20, "an": [1, 4, 6, 9, 13, 14, 16, 20, 23, 24], "analysi": 20, "andersson": [16, 20], "andersson15": 16, "anew": 18, "angl": [12, 16], "ani": 12, "ant": [18, 21], "antsregistr": 18, "api": 20, "appli": [5, 8], "applic": 20, "apply_affin": [8, 19], "approach": [16, 20], "approxim": [13, 14], "april": 20, "ar": [5, 15, 19, 21, 24], "arcco": 16, "archiv": 19, "arg": [1, 14], "argument": [1, 18, 20, 24], "argv": 2, "arrai": [4, 5, 6, 8, 12, 15, 24], "ascend": 17, "asynchron": 14, "asyncio": 18, "attribut": 18, "attributeerror": 10, "author": 18, "autom": 18, "automat": 19, "avail": [20, 24], "averag": [4, 13, 14], "averagedw": [13, 14], "averagedwmodel": [13, 14, 19], "avoid": 18, "b": [4, 6, 7, 9, 13, 14, 15, 17, 20, 24], "b0": [9, 18, 24], "b0_file": 4, "b0_thre": 4, "b_0": 4, "b_max": [13, 14], "bad": 18, "badg": 18, "base": [4, 6, 9, 10, 13, 18, 19, 20, 23], "basedwimodel": [13, 14, 19], "basemodel": [13, 14, 19], "befor": [5, 10, 19], "below": [5, 15], "ben": 20, "besid": 20, "best": [4, 6], "between": [12, 16, 20], "bin": 15, "bodi": [9, 24], "bool": [5, 12, 16, 17], "boolean": [4, 6], "both": [5, 10, 12, 20], "bound": 14, "brain": 23, "brainmask": [4, 6, 19], "brainmask_fil": [4, 6], "branch": 19, "bring": [4, 6], "build": [18, 19, 20], "built": 24, "bump": 18, "bval": [15, 17], "bval_cap": 15, "bval_estim": 15, "bval_fil": 4, "bval_group": 15, "bvalu": 17, "bvalue_iter": [17, 19], "bvec": 16, "bvec_fil": 4, "bzero": [4, 19], "c": [19, 21], "cach": 18, "calcul": [5, 13, 14], "call": 18, "can": [12, 18, 21], "cap": [14, 15], "carpet_plot": 18, "cast": 5, "caus": 9, "cd": 19, "center": 17, "centralsym_iter": [17, 19], "cfg": 18, "chang": 18, "check": [1, 12, 18, 21], "choleski": 12, "chunk": 14, "ci": 18, "cieslak": 20, "circleci": 18, "class": [4, 6, 9, 10, 13, 14, 18, 19, 24], "classifi": [15, 18], "classmethod": [4, 6], "cli": [18, 19, 20], "clip": [5, 14], "closest_polar": [12, 16], "code": [18, 19], "column": 24, "com": 14, "come": 7, "command": [1, 20, 21], "commit": 19, "commun": 19, "complet": 18, "compliant": [13, 14], "complic": 18, "compon": 24, "compress": [4, 6], "compression_opt": [4, 6], "comput": [12, 15, 16], "compute_angl": [12, 19], "compute_pairwise_angl": [16, 19], "conda": 18, "config": 18, "configur": [9, 18, 23, 24], "conjug": 12, "consid": [5, 12, 14, 15, 16], "consist": 18, "contact": 18, "contain": [4, 6, 9, 19, 23, 24], "context": 18, "contrib": 18, "contribut": 20, "contributor": 18, "convers": [4, 6], "coordin": [4, 6], "correct": [13, 14, 16, 20], "correspond": [4, 6, 7, 9, 17], "count": 15, "creat": 24, "credit": 18, "cross": [12, 16], "current": [9, 20, 23, 24], "cycl": 18, "data": [9, 13, 14, 18, 19, 20, 23, 24], "dataobj": [4, 6, 19], "dataset": [4, 7, 9, 17, 20, 24], "decompos": 12, "decomposit": 12, "default": [1, 5, 14, 15, 17, 23], "default_clip_percentil": [14, 19], "default_dtyp": [5, 19], "default_highb_threshold": [14, 19], "default_lowb_threshold": [14, 19], "default_max_bv": [15, 19], "default_max_bvalu": [14, 19], "default_max_s0": [14, 19], "default_min_s0": [14, 19], "default_multishell_bin_count_thr": [15, 19], "default_num_bin": [15, 19], "default_timeframe_midpoint_tol": [14, 19], "defin": [14, 18], "definit": 12, "deform": [9, 20, 24], "delv": 19, "depend": [15, 18, 20], "deploy": 18, "deriv": [9, 20], "desir": 5, "determinist": [23, 24], "develop": 20, "dict": 9, "diffus": [4, 9, 13, 14, 16, 20, 23, 24], "diffusionkurtosismodel": [13, 14], "dimension": [5, 20], "dipi": [13, 14, 20, 21], "direct": [4, 16, 24], "directori": 23, "disk": [4, 6], "displac": 4, "distort": [4, 9, 20, 24], "distribut": 5, "dki": [13, 14, 18], "dkimodel": [13, 14, 19], "dmri": [3, 7, 9, 14, 19, 20, 24], "dmri_util": [13, 19], "do": [13, 14, 18, 19], "doc": [18, 19], "docker": 18, "docstr": 18, "document": [18, 20], "download": 24, "dpy": 18, "drop": 18, "dsi": 15, "dti": [13, 14, 18, 20], "dtimodel": [13, 14, 19], "dtype": 5, "due": [20, 24], "durat": 6, "dw": [14, 20], "dwdata": 9, "dwi": [4, 7, 9, 14, 17, 18, 19, 20, 23, 24], "dwi_data": 24, "dwi_ful": 24, "e": [4, 5, 16, 19, 20], "each": [6, 9, 15, 16, 24], "earliest": 20, "easier": 14, "eddi": [9, 20, 24], "eddymot": [18, 19, 21], "eddymotioncorrect": 18, "eddymotionestim": [9, 18, 19, 24], "effect": [16, 20], "either": 24, "em_affin": [4, 6, 8, 9, 18, 19], "emploi": 24, "encapsul": 24, "encod": [9, 16, 24], "end": 5, "enforc": 5, "enh": 18, "enhanc": 18, "ensur": 24, "entri": 2, "environ": [19, 21], "equal": 18, "error": 18, "estim": [15, 18, 19, 20, 23, 24], "estimated_affin": 24, "et": [16, 20], "everi": [18, 19], "exampl": [12, 16, 17, 24], "except": [19, 20], "execut": 18, "extern": 20, "factori": [13, 14, 18], "fals": [5, 7, 12, 16, 17], "field": 4, "fieldmap": [4, 19], "file": [4, 6, 18, 23, 24], "filenam": [4, 6], "filepath": [4, 6, 8], "filter": [3, 19], "find": [15, 24], "find_shelling_schem": [15, 19], "first": [5, 12, 18, 19, 24], "fit": [5, 10, 13, 14, 18, 19, 24], "fix": 18, "fixtur": 18, "flake8": 18, "float": [5, 6, 12], "fmap_fil": 4, "fold": 7, "folder": 19, "follow": [14, 16, 18, 21, 24], "format": [4, 16, 18, 24], "formatt": 18, "found": 19, "frame": 14, "frame_dur": 6, "frame_tim": [6, 19], "framework": 20, "from": [4, 5, 6, 7, 9, 10, 12, 14, 16, 17, 18, 20, 21, 24], "from_filenam": [4, 6, 19, 24], "front": 20, "fsl": [16, 20], "fulldkimodel": 18, "function": [5, 18, 19, 21, 24], "further": 1, "fyi": 18, "g": [5, 16], "garyfallidi": 20, "gaussian": 20, "gener": [9, 17, 18, 19, 20, 23, 24], "get": 4, "get_filenam": [4, 19], "gh": 19, "gha": 18, "git": 19, "github": [18, 19], "given": [12, 15, 17], "go": 9, "gradient": [4, 6, 7, 9, 14, 16, 18, 19, 24], "gradient_fil": 24, "gradient_util": [13, 19], "gradients_fil": [4, 24], "grammar": 18, "group": 15, "grow": 17, "gtab": [13, 14], "guidelin": 19, "gz": 24, "h": 23, "h5": [18, 24], "ha": 20, "habitu": 21, "handl": 10, "hard": 4, "harmon": 20, "have": [18, 19, 23, 24], "hdf5": [4, 6, 23, 24], "head": [9, 20, 24], "header": [4, 6], "help": 10, "helper": 7, "hglc": 14, "high": 20, "histogram": 15, "hold": 1, "honor": 18, "housekeep": 18, "how": 20, "html": 19, "http": [14, 19], "i": [4, 9, 10, 12, 14, 16, 17, 19, 20, 24], "ii": 20, "imag": [5, 9, 13, 14, 16, 17, 18, 20, 23, 24], "img": 18, "implement": [14, 18, 20], "implicitli": 20, "import": [21, 24], "improv": 18, "includ": 24, "incorpor": 20, "index": [4, 6, 7, 13, 14, 17, 24], "indic": 24, "individu": [9, 23, 24], "inform": [18, 19, 24], "inherit": [10, 14], "init": [13, 14, 19], "initi": [17, 18], "input": [5, 23], "input_fil": 23, "instal": [18, 19, 20], "instanc": [17, 18, 24], "instanti": [13, 14, 24], "instead": 14, "int": [7, 9, 15, 17], "int16": 5, "integr": [16, 18, 20], "intens": [5, 14], "interfac": [13, 14, 20], "intern": [9, 24], "interpol": [13, 14], "intl": 20, "invert": 5, "is_fit": [13, 14, 19], "is_positive_definit": [12, 19], "issu": 20, "iter": [9, 17, 18, 24], "iter_kwarg": 9, "its": [9, 12, 18], "j": [16, 18, 20], "job": [9, 18, 23, 24], "joblib": 18, "just": 18, "keyword": 9, "kwarg": [4, 9, 13, 14, 17], "l": [16, 20], "langl": 16, "last": 24, "later": 20, "latest": 19, "leav": [7, 18, 20, 24], "left": 7, "length": 18, "less": 20, "level": 18, "librari": 20, "licens": 18, "like": 18, "line": [1, 12, 16, 20, 21], "linear": [4, 6], "linear_iter": [17, 19], "link": 18, "linter": 18, "list": [1, 4, 6, 9, 15, 17, 24], "load": [4, 6, 19, 24], "loader": 18, "local": [18, 19], "lovo": [7, 24], "lovo_split": [7, 19], "low": 15, "lower": [5, 12, 14], "m": [19, 20, 21], "mag": 20, "magnet": 20, "mai": [9, 20, 23, 24], "main": [2, 18, 19], "maint": 18, "maintain": [14, 19], "mainten": 18, "major": 19, "make": [18, 19, 21], "manag": 18, "manual": 19, "map": [4, 7, 9, 13, 14, 18, 24], "mask": 14, "match": 18, "math": [19, 20], "mathbf": 16, "matric": [9, 24], "matrix": [12, 18], "maximum": [9, 14, 15, 23, 24], "med": 20, "median": [5, 15], "medicin": 20, "member": 14, "memori": 4, "merg": 19, "method": [14, 18, 19, 20, 24], "midpoint": 6, "migrat": 18, "minimum": 14, "minor": [18, 19], "miscelan": 18, "miscellan": 18, "miss": 18, "mix": 18, "mm2": 20, "mm\u00b2": 24, "model": [9, 10, 18, 19, 20, 23, 24], "modelfactori": [9, 13, 14, 18, 19], "modelnotfittederror": [10, 19], "modul": [0, 3, 11, 13, 19, 20], "more": [5, 18, 20], "motion": [9, 20, 24], "movement": [16, 20], "mr": [16, 20], "mri": [20, 24], "multi": [15, 20], "multipl": 20, "multishel": 15, "multishell_nonempty_bin_count_thr": 15, "myself": 18, "n": 5, "n_ctrl": [13, 14], "n_iter": 9, "n_job": [9, 14, 24], "name": [18, 20], "namespac": 1, "natur": 20, "ndarrai": [4, 5, 6, 8, 9, 12, 15, 16], "necessari": 24, "need": [19, 20], "neg": 5, "neuroimag": [16, 20], "neuroinformat": 20, "new": 20, "nice": 18, "nifti": [4, 6, 24], "nifti1imag": 8, "nii": [8, 24], "nii_t_img": 8, "niprep": [18, 19], "nitransform": [4, 6], "njob": 23, "node": 18, "non": 5, "none": [1, 2, 4, 6, 8, 9, 13, 14, 17], "nonempti": 15, "nonneg": 5, "noth": [4, 6, 13, 14], "np": 12, "nthread": 23, "num_bin": 15, "number": [6, 9, 15, 17, 23, 24], "numpi": [4, 6, 9, 18], "nx4x4": [8, 24], "object": [1, 4, 6, 7, 9, 13, 14, 18, 24], "obtain": 4, "off": [16, 20], "offer": 19, "omp_nthread": [9, 24], "onc": 24, "one": [4, 7, 18, 20, 24], "onli": [5, 19], "onlin": 19, "open": 20, "option": [1, 5, 8, 13, 14, 15], "order": [4, 6, 13, 14, 17], "org": [18, 19], "orient": [7, 9, 14, 17], "origin": [7, 23], "oscil": 20, "osf": 24, "other": 19, "otherwis": [12, 15], "out": [7, 18, 20, 24], "outlier": 5, "output": [5, 23, 24], "output_dir": 23, "output_filenam": [8, 24], "outsourc": 18, "overli": 18, "ozarslan": 20, "p_max": 5, "p_min": 5, "packag": [18, 19, 20, 24], "page": [19, 24], "pair": 16, "pairwis": 16, "parallel": [9, 18, 23, 24], "paramet": [1, 5, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 23, 24], "pars": 1, "parse_arg": [1, 19], "parser": [0, 18, 19], "particular": 9, "pass": 17, "patch": 19, "path": [18, 23, 24], "pep517": 18, "per": 24, "percentil": [5, 14], "perform": 12, "pet": [3, 13, 14, 18, 19], "petmodel": [13, 14, 19], "pin": 18, "pip": 21, "place": 9, "plai": 18, "platform": 20, "pleas": 19, "plot": [18, 24], "plot_gradi": [4, 18, 19, 24], "plot_mosa": [4, 19, 24], "point": [2, 18], "posit": [12, 20], "post": 19, "prealloc": 18, "predict": [13, 14, 19, 20], "prefer": [4, 24], "preprocess": 20, "principl": 14, "print": 21, "proc": 20, "process": [9, 18, 20, 23, 24], "produc": 7, "product": 12, "program": 20, "progress": 17, "project": [18, 19], "properli": 18, "properti": [9, 13, 14], "propos": 20, "prototyp": 18, "provid": 24, "purpos": [18, 20], "py": 19, "pypi": 18, "pytest": 18, "python": [17, 18, 19, 20, 21], "q": 20, "qsiprep": 20, "r": [16, 20, 24], "ra": [4, 6], "radian": 12, "rais": 10, "random": [17, 18, 23, 24], "random_iter": [17, 19], "randomli": 17, "randomst": 18, "rangl": 16, "read": [4, 6, 14, 19], "readm": 18, "realign": [9, 13, 14, 23, 24], "recent": 20, "reconst": [13, 14], "reconstmodel": [13, 14], "reconstruct": 20, "reduc": 18, "refactor": 18, "refer": [4, 16, 18], "regist": 20, "registr": [5, 9, 18, 20, 23, 24], "relat": 18, "releas": [18, 19], "remaind": 20, "remov": [5, 18], "renam": 18, "repeat": 9, "replac": [18, 20], "repositori": 19, "repres": [1, 4, 6, 9, 24], "represent": [4, 6], "requir": [18, 21, 24], "reson": [16, 20], "result": [12, 16, 24], "retrospect": 20, "return": [1, 2, 5, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 24], "revers": [12, 16], "revis": 18, "rigid": [9, 24], "robustli": 5, "rotat": [9, 18], "row": 24, "ruff": 18, "run": [0, 1, 19, 20, 24], "runner": 2, "s0": [13, 14], "s_": 14, "same": [20, 23], "sampl": [6, 24], "save": [8, 24], "scale": 5, "scan": 20, "scheme": [15, 20], "script": [18, 20], "second": [12, 14], "secret": 18, "see": [9, 14, 24], "seed": [17, 18, 23, 24], "select": [9, 23], "seri": 19, "set": [4, 5, 6, 17, 18, 20], "set_transform": [4, 6, 19], "setup": 18, "setuptools_scm": 19, "sever": 24, "shell": [15, 20], "shield": 18, "shore": 20, "shorelin": 20, "should": [4, 24], "side": 17, "signal": 14, "signatur": 14, "similar": 20, "simpl": 20, "simplifi": 18, "simul": 20, "singl": [15, 20], "size": 17, "smallest": [12, 16], "smart": 4, "so": [14, 18], "soc": 20, "some": 4, "sort": 17, "sotiropoulo": 20, "sourc": [1, 2, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19], "space": 20, "specif": [19, 24], "specifi": [5, 8, 19, 24], "spectrum": 20, "sphinx": 18, "spline": [13, 14], "split": [3, 19, 24], "splitter": 18, "src": 19, "start": [17, 24], "static": [9, 13, 14], "statu": 18, "step": 24, "stop": 18, "store": 19, "str": [1, 5, 8, 13, 14, 15, 17], "strategi": 9, "strength": 24, "string": [1, 8], "structur": [4, 6, 18], "sty": 18, "style": 18, "stylist": 18, "subject": [16, 20], "submodul": 19, "suggest": 18, "suppli": 8, "support": [5, 18], "sure": [19, 21], "suscept": 4, "system": 18, "tabl": [4, 24], "tag": 19, "target": [9, 20, 23, 24], "task": 18, "techniqu": 24, "temporari": 18, "tensormodel": [13, 14], "test": [7, 18, 24], "test_data": 7, "test_gradi": 7, "thei": 15, "theta": 16, "thi": [4, 5, 7, 9, 10, 14, 19, 20, 24], "thread": [9, 23, 24], "threadpoolexecutor": 18, "three": [20, 24], "threshold": [5, 14], "time": [6, 9, 14, 24], "timepoint": [6, 9, 13, 14], "tmp_path": 18, "tmpdir": 18, "to_filenam": [4, 6, 19, 24], "to_nifti": [4, 6, 19, 24], "toler": 14, "toml": 19, "too": 19, "tool": [9, 20, 24], "total": 6, "total_dur": [6, 19], "train": 7, "train_data": 7, "train_gradi": 7, "transform": [8, 24], "transpos": 12, "travers": [9, 17], "tree": 19, "triangular": 12, "trivial": [13, 14, 18], "trivialb0model": [13, 14, 19], "true": [5, 12, 16, 17], "tupl": 7, "two": [12, 16], "txt": 18, "type": [1, 2, 5, 8, 9, 12, 13, 14, 16, 17, 18, 24], "typo": 18, "uint8": 5, "under": 19, "unit": 24, "unnam": 18, "unnecessari": 18, "unus": 18, "unwarp": 4, "up": [18, 20], "updat": [4, 6, 7, 18, 19, 24], "upon": 20, "upper": [5, 14], "upstream": 18, "uptak": 18, "us": [5, 9, 10, 13, 14, 18, 20, 21, 23], "usag": [23, 24], "util": [3, 11, 18, 19, 20, 24], "v": 14, "v1": 12, "v2": 12, "valu": [5, 7, 14, 15, 17, 20], "valueerror": 10, "variabl": 18, "vector": [7, 9, 12, 16], "version": [18, 19], "visual": [4, 24], "vol": 20, "volum": [4, 6, 7, 13, 14, 17, 24], "voxel": [4, 6], "wa": 20, "warn": 18, "watch": 14, "we": 19, "weight": [20, 24], "well": 9, "what": 20, "when": [5, 14], "whether": 12, "which": [8, 19, 24], "while": 20, "wide": 20, "with_b0": 7, "within": [5, 9, 19, 20, 24], "without": [4, 6, 20], "word": 19, "work": 20, "workflow": 18, "wrapper": [13, 14], "write": [4, 6], "www": [14, 19], "x": 19, "xlim": [13, 14], "yaml": 23, "you": 19, "your": [19, 21, 24], "youtub": 14, "zip": 18}, "titles": ["eddymotion.cli package", "eddymotion.cli.parser module", "eddymotion.cli.run module", "eddymotion.data package", "eddymotion.data.dmri module", "eddymotion.data.filtering module", "eddymotion.data.pet module", "eddymotion.data.splitting module", "eddymotion.data.utils module", "eddymotion.estimator module", "eddymotion.exceptions module", "eddymotion.math package", "eddymotion.math.utils module", "eddymotion.model package", "eddymotion.model.base module", "eddymotion.model.dmri_utils module", "eddymotion.model.gradient_utils module", "eddymotion.utils module", "What\u2019s new?", "For developers", "Eddymotion", "Installation", "<no title>", "Running Eddymotion", "How to Use"], "titleterms": {"": 18, "0": 18, "1": 18, "12": 18, "13": 18, "15": 18, "2021": 18, "2024": 18, "4": 18, "For": 19, "api": 19, "applic": 19, "april": 18, "argument": 23, "base": 14, "cli": [0, 1, 2], "command": 23, "content": 20, "contribut": 19, "data": [3, 4, 5, 6, 7, 8], "depend": 21, "develop": 19, "dmri": 4, "dmri_util": 15, "document": 19, "eddymot": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 20, 23, 24], "estim": 9, "except": 10, "extern": 21, "filter": 5, "gradient_util": 16, "how": 24, "incorpor": 24, "instal": 21, "interfac": [19, 23], "librari": 19, "line": 23, "mai": 18, "math": [11, 12], "model": [13, 14, 15, 16], "modul": [1, 2, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 24], "name": 23, "new": 18, "packag": [0, 3, 11, 13], "parser": 1, "pet": 6, "posit": 23, "program": 19, "python": 24, "run": [2, 23], "script": 24, "split": 7, "submodul": [0, 3, 11, 13], "us": 24, "util": [8, 12, 17], "what": 18}}) \ No newline at end of file +Search.setIndex({"alltitles": {"0.1.15 (mai 13, 2024)": [[19, "mai-13-2024"]], "0.1.4 (April 12, 2021)": [[19, "april-12-2021"]], "Command line interface": [[24, "command-line-interface"]], "Contents": [[21, "contents"]], "Contributing": [[20, "contributing"]], "Documentation": [[20, "documentation"]], "Eddymotion": [[21, "eddymotion"]], "External Dependencies": [[22, "external-dependencies"]], "For developers": [[20, "for-developers"]], "How to Use": [[25, "how-to-use"]], "Incorporating Eddymotion into a Python module or script": [[25, "incorporating-eddymotion-into-a-python-module-or-script"]], "Installation": [[22, "id1"]], "Library API (application program interface)": [[20, "library-api-application-program-interface"]], "Named Arguments": [[24, "named-arguments"]], "Positional Arguments": [[24, "positional-arguments"]], "Running Eddymotion": [[24, "running-eddymotion"]], "Submodules": [[0, "submodules"], [3, "submodules"], [11, "submodules"], [13, "submodules"]], "What\u2019s new?": [[19, "what-s-new"]], "eddymotion.cli package": [[0, "module-eddymotion.cli"]], "eddymotion.cli.parser module": [[1, "module-eddymotion.cli.parser"]], "eddymotion.cli.run module": [[2, "module-eddymotion.cli.run"]], "eddymotion.data package": [[3, "module-eddymotion.data"]], "eddymotion.data.dmri module": [[4, "module-eddymotion.data.dmri"]], "eddymotion.data.filtering module": [[5, "module-eddymotion.data.filtering"]], "eddymotion.data.pet module": [[6, "module-eddymotion.data.pet"]], "eddymotion.data.splitting module": [[7, "module-eddymotion.data.splitting"]], "eddymotion.data.utils module": [[8, "module-eddymotion.data.utils"]], "eddymotion.estimator module": [[9, "module-eddymotion.estimator"]], "eddymotion.exceptions module": [[10, "module-eddymotion.exceptions"]], "eddymotion.math package": [[11, "module-eddymotion.math"]], "eddymotion.math.utils module": [[12, "module-eddymotion.math.utils"]], "eddymotion.model package": [[13, "module-eddymotion.model"]], "eddymotion.model.base module": [[14, "module-eddymotion.model.base"]], "eddymotion.model.dmri_covariance module": [[15, "module-eddymotion.model.dmri_covariance"]], "eddymotion.model.dmri_utils module": [[16, "module-eddymotion.model.dmri_utils"]], "eddymotion.model.gradient_utils module": [[17, "module-eddymotion.model.gradient_utils"]], "eddymotion.utils module": [[18, "module-eddymotion.utils"]]}, "docnames": ["api/eddymotion.cli", "api/eddymotion.cli.parser", "api/eddymotion.cli.run", "api/eddymotion.data", "api/eddymotion.data.dmri", "api/eddymotion.data.filtering", "api/eddymotion.data.pet", "api/eddymotion.data.splitting", "api/eddymotion.data.utils", "api/eddymotion.estimator", "api/eddymotion.exceptions", "api/eddymotion.math", "api/eddymotion.math.utils", "api/eddymotion.model", "api/eddymotion.model.base", "api/eddymotion.model.dmri_covariance", "api/eddymotion.model.dmri_utils", "api/eddymotion.model.gradient_utils", "api/eddymotion.utils", "changes", "developers", "index", "installation", "links", "running", "usage"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1}, "filenames": ["api/eddymotion.cli.rst", "api/eddymotion.cli.parser.rst", "api/eddymotion.cli.run.rst", "api/eddymotion.data.rst", "api/eddymotion.data.dmri.rst", "api/eddymotion.data.filtering.rst", "api/eddymotion.data.pet.rst", "api/eddymotion.data.splitting.rst", "api/eddymotion.data.utils.rst", "api/eddymotion.estimator.rst", "api/eddymotion.exceptions.rst", "api/eddymotion.math.rst", "api/eddymotion.math.utils.rst", "api/eddymotion.model.rst", "api/eddymotion.model.base.rst", "api/eddymotion.model.dmri_covariance.rst", "api/eddymotion.model.dmri_utils.rst", "api/eddymotion.model.gradient_utils.rst", "api/eddymotion.utils.rst", "changes.rst", "developers.rst", "index.rst", "installation.rst", "links.rst", "running.rst", "usage.rst"], "indexentries": {"advanced_clip() (in module eddymotion.data.filtering)": [[5, "eddymotion.data.filtering.advanced_clip", false]], "affine (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.affine", false]], "affine (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.affine", false]], "apply_affines() (in module eddymotion.data.utils)": [[8, "eddymotion.data.utils.apply_affines", false]], "averagedwmodel (class in eddymotion.model)": [[13, "eddymotion.model.AverageDWModel", false]], "averagedwmodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.AverageDWModel", false]], "basedwimodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.BaseDWIModel", false]], "basemodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.BaseModel", false]], "brainmask (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.brainmask", false]], "brainmask (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.brainmask", false]], "bvalue_iterator() (in module eddymotion.utils)": [[18, "eddymotion.utils.bvalue_iterator", false]], "bzero (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.bzero", false]], "centralsym_iterator() (in module eddymotion.utils)": [[18, "eddymotion.utils.centralsym_iterator", false]], "compute_angle() (in module eddymotion.math.utils)": [[12, "eddymotion.math.utils.compute_angle", false]], "compute_exponential_covariance() (in module eddymotion.model.dmri_covariance)": [[15, "eddymotion.model.dmri_covariance.compute_exponential_covariance", false]], "compute_pairwise_angles() (in module eddymotion.model.gradient_utils)": [[17, "eddymotion.model.gradient_utils.compute_pairwise_angles", false]], "compute_spherical_covariance() (in module eddymotion.model.dmri_covariance)": [[15, "eddymotion.model.dmri_covariance.compute_spherical_covariance", false]], "dataobj (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.dataobj", false]], "dataobj (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.dataobj", false]], "default_clip_percentile (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_CLIP_PERCENTILE", false]], "default_dtype (in module eddymotion.data.filtering)": [[5, "eddymotion.data.filtering.DEFAULT_DTYPE", false]], "default_highb_threshold (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_HIGHB_THRESHOLD", false]], "default_lowb_threshold (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_LOWB_THRESHOLD", false]], "default_max_bval (in module eddymotion.model.dmri_utils)": [[16, "eddymotion.model.dmri_utils.DEFAULT_MAX_BVAL", false]], "default_max_bvalue (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_MAX_BVALUE", false]], "default_max_s0 (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_MAX_S0", false]], "default_min_s0 (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_MIN_S0", false]], "default_multishell_bin_count_thr (in module eddymotion.model.dmri_utils)": [[16, "eddymotion.model.dmri_utils.DEFAULT_MULTISHELL_BIN_COUNT_THR", false]], "default_num_bins (in module eddymotion.model.dmri_utils)": [[16, "eddymotion.model.dmri_utils.DEFAULT_NUM_BINS", false]], "default_timeframe_midpoint_tol (in module eddymotion.model.base)": [[14, "eddymotion.model.base.DEFAULT_TIMEFRAME_MIDPOINT_TOL", false]], "dkimodel (class in eddymotion.model)": [[13, "eddymotion.model.DKIModel", false]], "dkimodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.DKIModel", false]], "dtimodel (class in eddymotion.model)": [[13, "eddymotion.model.DTIModel", false]], "dtimodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.DTIModel", false]], "dwi (class in eddymotion.data.dmri)": [[4, "eddymotion.data.dmri.DWI", false]], "eddymotion.cli": [[0, "module-eddymotion.cli", false]], "eddymotion.cli.parser": [[1, "module-eddymotion.cli.parser", false]], "eddymotion.cli.run": [[2, "module-eddymotion.cli.run", false]], "eddymotion.data": [[3, "module-eddymotion.data", false]], "eddymotion.data.dmri": [[4, "module-eddymotion.data.dmri", false]], "eddymotion.data.filtering": [[5, "module-eddymotion.data.filtering", false]], "eddymotion.data.pet": [[6, "module-eddymotion.data.pet", false]], "eddymotion.data.splitting": [[7, "module-eddymotion.data.splitting", false]], "eddymotion.data.utils": [[8, "module-eddymotion.data.utils", false]], "eddymotion.estimator": [[9, "module-eddymotion.estimator", false]], "eddymotion.exceptions": [[10, "module-eddymotion.exceptions", false]], "eddymotion.math": [[11, "module-eddymotion.math", false]], "eddymotion.math.utils": [[12, "module-eddymotion.math.utils", false]], "eddymotion.model": [[13, "module-eddymotion.model", false]], "eddymotion.model.base": [[14, "module-eddymotion.model.base", false]], "eddymotion.model.dmri_covariance": [[15, "module-eddymotion.model.dmri_covariance", false]], "eddymotion.model.dmri_utils": [[16, "module-eddymotion.model.dmri_utils", false]], "eddymotion.model.gradient_utils": [[17, "module-eddymotion.model.gradient_utils", false]], "eddymotion.utils": [[18, "module-eddymotion.utils", false]], "eddymotionestimator (class in eddymotion.estimator)": [[9, "eddymotion.estimator.EddyMotionEstimator", false]], "em_affines (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.em_affines", false]], "em_affines (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.em_affines", false]], "estimate() (eddymotion.estimator.eddymotionestimator static method)": [[9, "eddymotion.estimator.EddyMotionEstimator.estimate", false]], "fieldmap (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.fieldmap", false]], "find_shelling_scheme() (in module eddymotion.model.dmri_utils)": [[16, "eddymotion.model.dmri_utils.find_shelling_scheme", false]], "fit() (eddymotion.model.averagedwmodel method)": [[13, "eddymotion.model.AverageDWModel.fit", false]], "fit() (eddymotion.model.base.averagedwmodel method)": [[14, "eddymotion.model.base.AverageDWModel.fit", false]], "fit() (eddymotion.model.base.basedwimodel method)": [[14, "eddymotion.model.base.BaseDWIModel.fit", false]], "fit() (eddymotion.model.base.basemodel method)": [[14, "eddymotion.model.base.BaseModel.fit", false]], "fit() (eddymotion.model.base.petmodel method)": [[14, "eddymotion.model.base.PETModel.fit", false]], "fit() (eddymotion.model.base.trivialb0model method)": [[14, "eddymotion.model.base.TrivialB0Model.fit", false]], "fit() (eddymotion.model.petmodel method)": [[13, "eddymotion.model.PETModel.fit", false]], "fit() (eddymotion.model.trivialb0model method)": [[13, "eddymotion.model.TrivialB0Model.fit", false]], "frame_time (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.frame_time", false]], "from_filename() (eddymotion.data.dmri.dwi class method)": [[4, "eddymotion.data.dmri.DWI.from_filename", false]], "from_filename() (eddymotion.data.pet.pet class method)": [[6, "eddymotion.data.pet.PET.from_filename", false]], "get_filename() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.get_filename", false]], "gradients (eddymotion.data.dmri.dwi attribute)": [[4, "eddymotion.data.dmri.DWI.gradients", false]], "init() (eddymotion.model.base.modelfactory static method)": [[14, "eddymotion.model.base.ModelFactory.init", false]], "init() (eddymotion.model.modelfactory static method)": [[13, "eddymotion.model.ModelFactory.init", false]], "is_fitted (eddymotion.model.base.basemodel property)": [[14, "eddymotion.model.base.BaseModel.is_fitted", false]], "is_fitted (eddymotion.model.base.petmodel property)": [[14, "eddymotion.model.base.PETModel.is_fitted", false]], "is_fitted (eddymotion.model.base.trivialb0model property)": [[14, "eddymotion.model.base.TrivialB0Model.is_fitted", false]], "is_fitted (eddymotion.model.petmodel property)": [[13, "eddymotion.model.PETModel.is_fitted", false]], "is_fitted (eddymotion.model.trivialb0model property)": [[13, "eddymotion.model.TrivialB0Model.is_fitted", false]], "is_positive_definite() (in module eddymotion.math.utils)": [[12, "eddymotion.math.utils.is_positive_definite", false]], "linear_iterator() (in module eddymotion.utils)": [[18, "eddymotion.utils.linear_iterator", false]], "load() (in module eddymotion.data.dmri)": [[4, "eddymotion.data.dmri.load", false]], "load() (in module eddymotion.data.pet)": [[6, "eddymotion.data.pet.load", false]], "lovo_split() (in module eddymotion.data.splitting)": [[7, "eddymotion.data.splitting.lovo_split", false]], "main() (in module eddymotion.cli.run)": [[2, "eddymotion.cli.run.main", false]], "modelfactory (class in eddymotion.model)": [[13, "eddymotion.model.ModelFactory", false]], "modelfactory (class in eddymotion.model.base)": [[14, "eddymotion.model.base.ModelFactory", false]], "modelnotfittederror": [[10, "eddymotion.exceptions.ModelNotFittedError", false]], "module": [[0, "module-eddymotion.cli", false], [1, "module-eddymotion.cli.parser", false], [2, "module-eddymotion.cli.run", false], [3, "module-eddymotion.data", false], [4, "module-eddymotion.data.dmri", false], [5, "module-eddymotion.data.filtering", false], [6, "module-eddymotion.data.pet", false], [7, "module-eddymotion.data.splitting", false], [8, "module-eddymotion.data.utils", false], [9, "module-eddymotion.estimator", false], [10, "module-eddymotion.exceptions", false], [11, "module-eddymotion.math", false], [12, "module-eddymotion.math.utils", false], [13, "module-eddymotion.model", false], [14, "module-eddymotion.model.base", false], [15, "module-eddymotion.model.dmri_covariance", false], [16, "module-eddymotion.model.dmri_utils", false], [17, "module-eddymotion.model.gradient_utils", false], [18, "module-eddymotion.utils", false]], "parse_args() (in module eddymotion.cli.parser)": [[1, "eddymotion.cli.parser.parse_args", false]], "pet (class in eddymotion.data.pet)": [[6, "eddymotion.data.pet.PET", false]], "petmodel (class in eddymotion.model)": [[13, "eddymotion.model.PETModel", false]], "petmodel (class in eddymotion.model.base)": [[14, "eddymotion.model.base.PETModel", false]], "plot_gradients() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.plot_gradients", false]], "plot_mosaic() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.plot_mosaic", false]], "predict() (eddymotion.model.averagedwmodel method)": [[13, "eddymotion.model.AverageDWModel.predict", false]], "predict() (eddymotion.model.base.averagedwmodel method)": [[14, "eddymotion.model.base.AverageDWModel.predict", false]], "predict() (eddymotion.model.base.basedwimodel method)": [[14, "eddymotion.model.base.BaseDWIModel.predict", false]], "predict() (eddymotion.model.base.basemodel method)": [[14, "eddymotion.model.base.BaseModel.predict", false]], "predict() (eddymotion.model.base.petmodel method)": [[14, "eddymotion.model.base.PETModel.predict", false]], "predict() (eddymotion.model.base.trivialb0model method)": [[14, "eddymotion.model.base.TrivialB0Model.predict", false]], "predict() (eddymotion.model.petmodel method)": [[13, "eddymotion.model.PETModel.predict", false]], "predict() (eddymotion.model.trivialb0model method)": [[13, "eddymotion.model.TrivialB0Model.predict", false]], "random_iterator() (in module eddymotion.utils)": [[18, "eddymotion.utils.random_iterator", false]], "set_transform() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.set_transform", false]], "set_transform() (eddymotion.data.pet.pet method)": [[6, "eddymotion.data.pet.PET.set_transform", false]], "to_filename() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.to_filename", false]], "to_filename() (eddymotion.data.pet.pet method)": [[6, "eddymotion.data.pet.PET.to_filename", false]], "to_nifti() (eddymotion.data.dmri.dwi method)": [[4, "eddymotion.data.dmri.DWI.to_nifti", false]], "to_nifti() (eddymotion.data.pet.pet method)": [[6, "eddymotion.data.pet.PET.to_nifti", false]], "total_duration (eddymotion.data.pet.pet attribute)": [[6, "eddymotion.data.pet.PET.total_duration", false]], "trivialb0model (class in eddymotion.model)": [[13, "eddymotion.model.TrivialB0Model", false]], "trivialb0model (class in eddymotion.model.base)": [[14, "eddymotion.model.base.TrivialB0Model", false]]}, "objects": {"eddymotion": [[0, 0, 0, "-", "cli"], [3, 0, 0, "-", "data"], [9, 0, 0, "-", "estimator"], [10, 0, 0, "-", "exceptions"], [11, 0, 0, "-", "math"], [13, 0, 0, "-", "model"], [18, 0, 0, "-", "utils"]], "eddymotion.cli": [[1, 0, 0, "-", "parser"], [2, 0, 0, "-", "run"]], "eddymotion.cli.parser": [[1, 1, 1, "", "parse_args"]], "eddymotion.cli.run": [[2, 1, 1, "", "main"]], "eddymotion.data": [[4, 0, 0, "-", "dmri"], [5, 0, 0, "-", "filtering"], [6, 0, 0, "-", "pet"], [7, 0, 0, "-", "splitting"], [8, 0, 0, "-", "utils"]], "eddymotion.data.dmri": [[4, 2, 1, "", "DWI"], [4, 1, 1, "", "load"]], "eddymotion.data.dmri.DWI": [[4, 3, 1, "", "affine"], [4, 3, 1, "", "brainmask"], [4, 3, 1, "", "bzero"], [4, 3, 1, "", "dataobj"], [4, 3, 1, "", "em_affines"], [4, 3, 1, "", "fieldmap"], [4, 4, 1, "", "from_filename"], [4, 4, 1, "", "get_filename"], [4, 3, 1, "", "gradients"], [4, 4, 1, "", "plot_gradients"], [4, 4, 1, "", "plot_mosaic"], [4, 4, 1, "", "set_transform"], [4, 4, 1, "", "to_filename"], [4, 4, 1, "", "to_nifti"]], "eddymotion.data.filtering": [[5, 5, 1, "", "DEFAULT_DTYPE"], [5, 1, 1, "", "advanced_clip"]], "eddymotion.data.pet": [[6, 2, 1, "", "PET"], [6, 1, 1, "", "load"]], "eddymotion.data.pet.PET": [[6, 3, 1, "", "affine"], [6, 3, 1, "", "brainmask"], [6, 3, 1, "", "dataobj"], [6, 3, 1, "", "em_affines"], [6, 3, 1, "", "frame_time"], [6, 4, 1, "", "from_filename"], [6, 4, 1, "", "set_transform"], [6, 4, 1, "", "to_filename"], [6, 4, 1, "", "to_nifti"], [6, 3, 1, "", "total_duration"]], "eddymotion.data.splitting": [[7, 1, 1, "", "lovo_split"]], "eddymotion.data.utils": [[8, 1, 1, "", "apply_affines"]], "eddymotion.estimator": [[9, 2, 1, "", "EddyMotionEstimator"]], "eddymotion.estimator.EddyMotionEstimator": [[9, 4, 1, "", "estimate"]], "eddymotion.exceptions": [[10, 6, 1, "", "ModelNotFittedError"]], "eddymotion.math": [[12, 0, 0, "-", "utils"]], "eddymotion.math.utils": [[12, 1, 1, "", "compute_angle"], [12, 1, 1, "", "is_positive_definite"]], "eddymotion.model": [[13, 2, 1, "", "AverageDWModel"], [13, 2, 1, "", "DKIModel"], [13, 2, 1, "", "DTIModel"], [13, 2, 1, "", "ModelFactory"], [13, 2, 1, "", "PETModel"], [13, 2, 1, "", "TrivialB0Model"], [14, 0, 0, "-", "base"], [15, 0, 0, "-", "dmri_covariance"], [16, 0, 0, "-", "dmri_utils"], [17, 0, 0, "-", "gradient_utils"]], "eddymotion.model.AverageDWModel": [[13, 4, 1, "", "fit"], [13, 4, 1, "", "predict"]], "eddymotion.model.ModelFactory": [[13, 4, 1, "", "init"]], "eddymotion.model.PETModel": [[13, 4, 1, "", "fit"], [13, 7, 1, "", "is_fitted"], [13, 4, 1, "", "predict"]], "eddymotion.model.TrivialB0Model": [[13, 4, 1, "", "fit"], [13, 7, 1, "", "is_fitted"], [13, 4, 1, "", "predict"]], "eddymotion.model.base": [[14, 2, 1, "", "AverageDWModel"], [14, 2, 1, "", "BaseDWIModel"], [14, 2, 1, "", "BaseModel"], [14, 5, 1, "", "DEFAULT_CLIP_PERCENTILE"], [14, 5, 1, "", "DEFAULT_HIGHB_THRESHOLD"], [14, 5, 1, "", "DEFAULT_LOWB_THRESHOLD"], [14, 5, 1, "", "DEFAULT_MAX_BVALUE"], [14, 5, 1, "", "DEFAULT_MAX_S0"], [14, 5, 1, "", "DEFAULT_MIN_S0"], [14, 5, 1, "", "DEFAULT_TIMEFRAME_MIDPOINT_TOL"], [14, 2, 1, "", "DKIModel"], [14, 2, 1, "", "DTIModel"], [14, 2, 1, "", "ModelFactory"], [14, 2, 1, "", "PETModel"], [14, 2, 1, "", "TrivialB0Model"]], "eddymotion.model.base.AverageDWModel": [[14, 4, 1, "", "fit"], [14, 4, 1, "", "predict"]], "eddymotion.model.base.BaseDWIModel": [[14, 4, 1, "", "fit"], [14, 4, 1, "", "predict"]], "eddymotion.model.base.BaseModel": [[14, 4, 1, "", "fit"], [14, 7, 1, "", "is_fitted"], [14, 4, 1, "", "predict"]], "eddymotion.model.base.ModelFactory": [[14, 4, 1, "", "init"]], "eddymotion.model.base.PETModel": [[14, 4, 1, "", "fit"], [14, 7, 1, "", "is_fitted"], [14, 4, 1, "", "predict"]], "eddymotion.model.base.TrivialB0Model": [[14, 4, 1, "", "fit"], [14, 7, 1, "", "is_fitted"], [14, 4, 1, "", "predict"]], "eddymotion.model.dmri_covariance": [[15, 1, 1, "", "compute_exponential_covariance"], [15, 1, 1, "", "compute_spherical_covariance"]], "eddymotion.model.dmri_utils": [[16, 5, 1, "", "DEFAULT_MAX_BVAL"], [16, 5, 1, "", "DEFAULT_MULTISHELL_BIN_COUNT_THR"], [16, 5, 1, "", "DEFAULT_NUM_BINS"], [16, 1, 1, "", "find_shelling_scheme"]], "eddymotion.model.gradient_utils": [[17, 1, 1, "", "compute_pairwise_angles"]], "eddymotion.utils": [[18, 1, 1, "", "bvalue_iterator"], [18, 1, 1, "", "centralsym_iterator"], [18, 1, 1, "", "linear_iterator"], [18, 1, 1, "", "random_iterator"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"], "5": ["py", "data", "Python data"], "6": ["py", "exception", "Python exception"], "7": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method", "5": "py:data", "6": "py:exception", "7": "py:property"}, "terms": {"": [5, 9, 13, 14, 18, 21, 25], "0": [4, 5, 6, 12, 13, 14, 15, 17, 18, 20, 21, 25], "01": 14, "05": 14, "1": [4, 5, 6, 12, 14, 15, 17, 18, 20, 21], "10": [15, 18], "100": 19, "1000": [14, 18, 21], "10000": 14, "102": 19, "103": 19, "104": 19, "105": 19, "106": 19, "1063": [17, 21], "1078": [17, 21], "109": 19, "11": 18, "112": 19, "115": 19, "119": 19, "12": [18, 21], "120": 19, "121": 19, "122": 19, "123": 19, "124": 19, "125": [17, 21], "128": 19, "13": [18, 21], "130": 19, "131": 19, "132": 19, "133": 19, "134": 19, "135": 19, "136": 19, "137": 19, "138": 19, "139": 19, "1396": 21, "14": 18, "141": 19, "1415": [12, 17], "143": 19, "144": 19, "147": 19, "149": 19, "15": [16, 18, 21], "154": 19, "157": 19, "158": 19, "159": 19, "160": 19, "162": 19, "164": 19, "167": 19, "1694": 21, "17": 21, "1702": 21, "172": 19, "173": 19, "175": 19, "177": 19, "179": 19, "18": 21, "182": 19, "183": 19, "185": 19, "190": 19, "1d": 6, "1e": 14, "2": [15, 16, 18, 19, 20, 21], "2000": 18, "2009": 21, "2012": 21, "2014": 21, "2016": [17, 21], "2021": 21, "20210324": 18, "2024": 21, "27": 19, "2d": 4, "3": [4, 6, 12, 13, 14, 15, 17, 18, 19, 21, 22], "30": 19, "32": 19, "33": 19, "35": 5, "3d": [4, 7], "3mnvp9": 14, "4": [9, 18, 21, 25], "42": [18, 25], "4d": [18, 24], "5": [18, 21], "50": [4, 14], "518": 19, "6": [18, 20], "67": 21, "7": [16, 18, 21, 22], "700": 18, "75": 14, "775": 21, "778": 21, "8": [18, 19, 21], "8000": 16, "82": 19, "83": 19, "84": 19, "85": 19, "87": 19, "88": 19, "9": [15, 18, 19], "91": 19, "92": 19, "96": 19, "97": 19, "98": [5, 19], "99": 5, "A": [4, 6, 9, 13, 14, 19, 24, 25], "For": [21, 25], "If": [4, 5, 18, 25], "In": 20, "It": [5, 25], "On": 22, "One": 25, "The": [5, 7, 9, 12, 14, 18, 19, 20, 24, 25], "To": [5, 20, 25], "With": 20, "_": [6, 13, 14], "__init__": 19, "__version__": 22, "_version": 20, "ab": 17, "abov": [5, 22], "abstract": 14, "accept": 25, "accord": 16, "acquir": 21, "acquisit": [6, 21], "across": [15, 17, 19], "action": [19, 20], "ad": 19, "adapt": 14, "add": 19, "address": 21, "adopt": 19, "advanced_clip": [5, 20], "advantag": 21, "affin": [4, 6, 8, 9, 19, 20, 25], "after": 5, "al": [17, 21], "algorithm": [9, 24], "align": [4, 6, 25], "align_config": 24, "align_kwarg": [9, 25], "all": [18, 20, 22], "allow": [9, 14, 19], "alongsid": 19, "also": 4, "alternatingli": 18, "alwai": [13, 14], "amitai": 21, "an": [1, 4, 6, 9, 13, 14, 17, 21, 24, 25], "analysi": 21, "andersson": [17, 21], "andersson15": [15, 17], "anew": 19, "angl": [12, 15, 17], "ani": 12, "ant": [19, 22], "antsregistr": 19, "api": 21, "appli": [5, 8], "applic": 21, "apply_affin": [8, 20], "approach": [17, 21], "approxim": [13, 14], "april": 21, "ar": [5, 16, 20, 22, 25], "arcco": 17, "archiv": 20, "arg": [1, 14], "argument": [1, 19, 21, 25], "argv": 2, "arrai": [4, 5, 6, 8, 12, 16, 25], "ascend": 18, "asynchron": 14, "asyncio": 19, "attribut": 19, "attributeerror": 10, "author": 19, "autom": 19, "automat": 20, "avail": [21, 25], "averag": [4, 13, 14], "averagedw": [13, 14], "averagedwmodel": [13, 14, 20], "avoid": 19, "b": [4, 6, 7, 9, 13, 14, 16, 18, 21, 25], "b0": [9, 19, 25], "b0_file": 4, "b0_thre": 4, "b_0": 4, "b_max": [13, 14], "bad": 19, "badg": 19, "base": [4, 6, 9, 10, 13, 19, 20, 21, 24], "basedwimodel": [13, 14, 20], "basemodel": [13, 14, 20], "befor": [5, 10, 20], "begin": 15, "below": [5, 16], "ben": 21, "besid": 21, "best": [4, 6], "between": [12, 17, 21], "bin": 16, "bodi": [9, 25], "bool": [5, 12, 17, 18], "boolean": [4, 6], "both": [5, 10, 12, 21], "bound": 14, "brain": 24, "brainmask": [4, 6, 20], "brainmask_fil": [4, 6], "branch": 20, "bring": [4, 6], "build": [19, 20, 21], "built": 25, "bump": 19, "bval": [16, 18], "bval_cap": 16, "bval_estim": 16, "bval_fil": 4, "bval_group": 16, "bvalu": 18, "bvalue_iter": [18, 20], "bvec": 17, "bvec_fil": 4, "bzero": [4, 20], "c": [15, 20, 22], "cach": 19, "calcul": [5, 13, 14], "call": 19, "can": [12, 19, 22], "cap": [14, 16], "carpet_plot": 19, "case": 15, "cast": 5, "caus": 9, "cd": 20, "center": 18, "centralsym_iter": [18, 20], "cfg": 19, "chang": 19, "check": [1, 12, 19, 22], "choleski": 12, "chunk": 14, "ci": 19, "cieslak": 21, "circleci": 19, "class": [4, 6, 9, 10, 13, 14, 19, 20, 25], "classifi": [16, 19], "classmethod": [4, 6], "cli": [19, 20, 21], "clip": [5, 14], "closest_polar": [12, 17], "code": [19, 20], "column": 25, "com": 14, "come": 7, "command": [1, 21, 22], "commit": 20, "commun": 20, "complet": 19, "compliant": [13, 14], "complic": 19, "compon": 25, "compress": [4, 6], "compression_opt": [4, 6], "comput": [12, 15, 16, 17], "compute_angl": [12, 20], "compute_exponential_covari": [15, 20], "compute_pairwise_angl": [17, 20], "compute_spherical_covari": [15, 20], "conda": 19, "config": 19, "configur": [9, 19, 24, 25], "conjug": 12, "consid": [5, 12, 14, 16, 17], "consist": 19, "contact": 19, "contain": [4, 6, 9, 20, 24, 25], "context": 19, "contrib": 19, "contribut": 21, "contributor": 19, "convers": [4, 6], "coordin": [4, 6], "correct": [13, 14, 17, 21], "correspond": [4, 6, 7, 9, 18], "count": 16, "covari": 15, "creat": 25, "credit": 19, "cross": [12, 17], "current": [9, 21, 24, 25], "cycl": 19, "data": [9, 13, 14, 19, 20, 21, 24, 25], "dataobj": [4, 6, 20], "dataset": [4, 7, 9, 18, 21, 25], "decompos": 12, "decomposit": 12, "default": [1, 5, 14, 16, 18, 24], "default_clip_percentil": [14, 20], "default_dtyp": [5, 20], "default_highb_threshold": [14, 20], "default_lowb_threshold": [14, 20], "default_max_bv": [16, 20], "default_max_bvalu": [14, 20], "default_max_s0": [14, 20], "default_min_s0": [14, 20], "default_multishell_bin_count_thr": [16, 20], "default_num_bin": [16, 20], "default_timeframe_midpoint_tol": [14, 20], "defin": [14, 19], "definit": 12, "deform": [9, 21, 25], "delv": 20, "depend": [16, 19, 21], "deploy": 19, "deriv": [9, 21], "desir": 5, "determin": 15, "determinist": [24, 25], "develop": 21, "dict": 9, "diffus": [4, 9, 13, 14, 15, 17, 21, 24, 25], "diffusionkurtosismodel": [13, 14], "dimension": [5, 21], "dipi": [13, 14, 21, 22], "direct": [4, 15, 17, 25], "directori": 24, "disk": [4, 6], "displac": 4, "distanc": 15, "distort": [4, 9, 21, 25], "distribut": 5, "dki": [13, 14, 19], "dkimodel": [13, 14, 20], "dmri": [3, 7, 9, 14, 20, 21, 25], "dmri_covari": [13, 20], "dmri_util": [13, 20], "do": [13, 14, 19, 20], "doc": [19, 20], "docker": 19, "docstr": 19, "document": [19, 21], "download": 25, "dpy": 19, "drop": 19, "dsi": 16, "dti": [13, 14, 19, 21], "dtimodel": [13, 14, 20], "dtype": 5, "due": [21, 25], "durat": 6, "dw": [14, 21], "dwdata": 9, "dwi": [4, 7, 9, 14, 18, 19, 20, 21, 24, 25], "dwi_data": 25, "dwi_ful": 25, "e": [4, 5, 17, 20, 21], "each": [6, 9, 16, 17, 25], "earliest": 21, "easier": 14, "eddi": [9, 21, 25], "eddymot": [19, 20, 22], "eddymotioncorrect": 19, "eddymotionestim": [9, 19, 20, 25], "effect": [17, 21], "either": 25, "em_affin": [4, 6, 8, 9, 19, 20], "emploi": 25, "encapsul": 25, "encod": [9, 15, 17, 25], "end": [5, 15], "enforc": 5, "enh": 19, "enhanc": 19, "ensur": 25, "entri": 2, "environ": [20, 22], "eq": 15, "equal": 19, "error": 19, "estim": [16, 19, 20, 21, 24, 25], "estimated_affin": 25, "et": [17, 21], "everi": [19, 20], "exampl": [12, 17, 18, 25], "except": [20, 21], "execut": 19, "exp": 15, "exponenti": 15, "extern": 21, "factori": [13, 14, 19], "fals": [5, 7, 12, 17, 18], "field": 4, "fieldmap": [4, 20], "file": [4, 6, 19, 24, 25], "filenam": [4, 6], "filepath": [4, 6, 8], "filter": [3, 20], "find": [16, 25], "find_shelling_schem": [16, 20], "first": [5, 12, 19, 20, 25], "fit": [5, 10, 13, 14, 19, 20, 25], "fix": 19, "fixtur": 19, "flake8": 19, "float": [5, 6, 12, 15], "fmap_fil": 4, "fold": 7, "folder": 20, "follow": [14, 15, 17, 19, 22, 25], "format": [4, 17, 19, 25], "formatt": 19, "found": 20, "frac": 15, "frame": 14, "frame_dur": 6, "frame_tim": [6, 20], "framework": 21, "from": [4, 5, 6, 7, 9, 10, 12, 14, 17, 18, 19, 21, 22, 25], "from_filenam": [4, 6, 20, 25], "front": 21, "fsl": [17, 21], "fulldkimodel": 19, "function": [5, 15, 19, 20, 22, 25], "further": 1, "fyi": 19, "g": [5, 17], "garyfallidi": 21, "gaussian": 21, "gener": [9, 18, 19, 20, 21, 24, 25], "get": 4, "get_filenam": [4, 20], "gh": 20, "gha": 19, "git": 20, "github": [19, 20], "given": [12, 16, 18], "go": 9, "goe": 15, "gradient": [4, 6, 7, 9, 14, 15, 17, 19, 20, 25], "gradient_fil": 25, "gradient_util": [13, 20], "gradients_fil": [4, 25], "grammar": 19, "group": 16, "grow": 18, "gtab": [13, 14], "guidelin": 20, "gz": 25, "h": 24, "h5": [19, 25], "ha": 21, "habitu": 22, "handl": 10, "hard": 4, "harmon": 21, "have": [19, 20, 24, 25], "hdf5": [4, 6, 24, 25], "head": [9, 21, 25], "header": [4, 6], "help": 10, "helper": 7, "here": 15, "hglc": 14, "high": 21, "histogram": 16, "hold": 1, "honor": 19, "housekeep": 19, "how": 21, "html": 20, "http": [14, 20], "i": [4, 9, 10, 12, 14, 17, 18, 20, 21, 25], "ii": 21, "imag": [5, 9, 13, 14, 17, 18, 19, 21, 24, 25], "img": 19, "implement": [14, 19, 21], "implicitli": 21, "import": [22, 25], "improv": 19, "includ": 25, "incorpor": 21, "index": [4, 6, 7, 13, 14, 18, 25], "indic": 25, "individu": [9, 24, 25], "inform": [19, 20, 25], "inherit": [10, 14], "init": [13, 14, 20], "initi": [18, 19], "input": [5, 24], "input_fil": 24, "instal": [19, 20, 21], "instanc": [18, 19, 25], "instanti": [13, 14, 25], "instead": 14, "int": [7, 9, 16, 18], "int16": 5, "integr": [17, 19, 21], "intens": [5, 14], "interfac": [13, 14, 21], "intern": [9, 25], "interpol": [13, 14], "intl": 21, "invert": 5, "is_fit": [13, 14, 20], "is_positive_definit": [12, 20], "issu": 21, "iter": [9, 18, 19, 25], "iter_kwarg": 9, "its": [9, 12, 19], "j": [17, 19, 21], "job": [9, 19, 24, 25], "joblib": 19, "just": 19, "keyword": 9, "kwarg": [4, 9, 13, 14, 18], "l": [17, 21], "langl": 17, "last": 25, "later": 21, "latest": 20, "leav": [7, 19, 21, 25], "left": 7, "length": 19, "leq": 15, "less": 21, "level": 19, "librari": 21, "licens": 19, "like": 19, "line": [1, 12, 17, 21, 22], "linear": [4, 6], "linear_iter": [18, 20], "link": 19, "linter": 19, "list": [1, 4, 6, 9, 16, 18, 25], "load": [4, 6, 20, 25], "loader": 19, "local": [19, 20], "lovo": [7, 25], "lovo_split": [7, 20], "low": 16, "lower": [5, 12, 14], "m": [20, 21, 22], "mag": 21, "magnet": 21, "mai": [9, 21, 24, 25], "main": [2, 19, 20], "maint": 19, "maintain": [14, 20], "mainten": 19, "major": 20, "make": [19, 20, 22], "manag": 19, "manual": 20, "map": [4, 7, 9, 13, 14, 19, 25], "mask": 14, "match": 19, "math": [20, 21], "mathbf": 17, "matric": [9, 25], "matrix": [12, 15, 19], "maximum": [9, 14, 16, 24, 25], "med": 21, "median": [5, 16], "medicin": 21, "member": 14, "memori": 4, "merg": 20, "method": [14, 19, 20, 21, 25], "midpoint": 6, "migrat": 19, "minimum": 14, "minor": [19, 20], "miscelan": 19, "miscellan": 19, "miss": 19, "mix": 19, "mm2": 21, "mm\u00b2": 25, "model": [9, 10, 19, 20, 21, 24, 25], "modelfactori": [9, 13, 14, 19, 20], "modelnotfittederror": [10, 20], "modul": [0, 3, 11, 13, 20, 21], "more": [5, 19, 21], "motion": [9, 21, 25], "movement": [17, 21], "mr": [17, 21], "mri": [21, 25], "multi": [16, 21], "multipl": 21, "multishel": 16, "multishell_nonempty_bin_count_thr": 16, "myself": 19, "n": 5, "n_ctrl": [13, 14], "n_iter": 9, "n_job": [9, 14, 25], "name": [19, 21], "namespac": 1, "natur": 21, "ndarrai": [4, 5, 6, 8, 9, 12, 15, 16, 17], "necessari": 25, "need": [20, 21], "neg": 5, "neuroimag": [17, 21], "neuroinformat": 21, "new": 21, "nice": 19, "nifti": [4, 6, 25], "nifti1imag": 8, "nii": [8, 25], "nii_t_img": 8, "niprep": [19, 20], "nitransform": [4, 6], "njob": 24, "node": 19, "non": 5, "none": [1, 2, 4, 6, 8, 9, 13, 14, 18], "nonempti": 16, "nonneg": 5, "noth": [4, 6, 13, 14], "np": 12, "nthread": 24, "num_bin": 16, "number": [6, 9, 16, 18, 24, 25], "numpi": [4, 6, 9, 19], "nx4x4": [8, 25], "object": [1, 4, 6, 7, 9, 13, 14, 19, 25], "obtain": 4, "off": [17, 21], "offer": 20, "omp_nthread": [9, 25], "onc": 25, "one": [4, 7, 19, 21, 25], "onli": [5, 20], "onlin": 20, "open": 21, "option": [1, 5, 8, 13, 14, 16], "order": [4, 6, 13, 14, 18], "org": [19, 20], "orient": [7, 9, 14, 18], "origin": [7, 24], "oscil": 21, "osf": 25, "other": 20, "otherwis": [12, 16], "out": [7, 19, 21, 25], "outlier": 5, "output": [5, 24, 25], "output_dir": 24, "output_filenam": [8, 25], "outsourc": 19, "overli": 19, "ozarslan": 21, "p_max": 5, "p_min": 5, "packag": [19, 20, 21, 25], "page": [20, 25], "pair": 17, "pairwis": [15, 17], "parallel": [9, 19, 24, 25], "paramet": [1, 5, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 24, 25], "pars": 1, "parse_arg": [1, 20], "parser": [0, 19, 20], "particular": 9, "pass": 18, "patch": 20, "path": [19, 24, 25], "pep517": 19, "per": 25, "percentil": [5, 14], "perform": 12, "pet": [3, 13, 14, 19, 20], "petmodel": [13, 14, 20], "pin": 19, "pip": 22, "place": 9, "plai": 19, "platform": 21, "pleas": 20, "plot": [19, 25], "plot_gradi": [4, 19, 20, 25], "plot_mosa": [4, 20, 25], "point": [2, 19], "posit": [12, 15, 21], "post": 20, "prealloc": 19, "predict": [13, 14, 20, 21], "prefer": [4, 25], "preprocess": 21, "principl": 14, "print": 22, "proc": 21, "process": [9, 19, 21, 24, 25], "produc": 7, "product": 12, "program": 21, "progress": 18, "project": [19, 20], "properli": 19, "properti": [9, 13, 14], "propos": 21, "prototyp": 19, "provid": 25, "purpos": [19, 21], "py": 20, "pypi": 19, "pytest": 19, "python": [18, 19, 20, 21, 22], "q": 21, "qsiprep": 21, "r": [17, 21, 25], "ra": [4, 6], "radian": 12, "rais": 10, "random": [18, 19, 24, 25], "random_iter": [18, 20], "randomli": 18, "randomst": 19, "rangl": 17, "read": [4, 6, 14, 20], "readm": 19, "realign": [9, 13, 14, 24, 25], "recent": 21, "reconst": [13, 14], "reconstmodel": [13, 14], "reconstruct": 21, "reduc": 19, "refactor": 19, "refer": [4, 17, 19], "regist": 21, "registr": [5, 9, 19, 21, 24, 25], "relat": 19, "releas": [19, 20], "remaind": 21, "remov": [5, 19], "renam": 19, "repeat": 9, "replac": [19, 21], "repositori": 20, "repres": [1, 4, 6, 9, 25], "represent": [4, 6], "requir": [19, 22, 25], "reson": [17, 21], "result": [12, 17, 25], "retrospect": 21, "return": [1, 2, 5, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 25], "revers": [12, 17], "revis": 19, "rigid": [9, 25], "robustli": 5, "rotat": [9, 19], "row": 25, "ruff": 19, "run": [0, 1, 20, 21, 25], "runner": 2, "s0": [13, 14], "s_": 14, "same": [21, 24], "sampl": [6, 25], "save": [8, 25], "scale": [5, 15], "scan": 21, "scheme": [16, 21], "script": [19, 21], "second": [12, 14], "secret": 19, "see": [9, 14, 25], "seed": [18, 19, 24, 25], "select": [9, 24], "seri": 20, "set": [4, 5, 6, 18, 19, 21], "set_transform": [4, 6, 20], "setup": 19, "setuptools_scm": 20, "sever": 25, "shell": [16, 21], "shield": 19, "shore": 21, "shorelin": 21, "should": [4, 25], "side": 18, "signal": 14, "signatur": 14, "similar": 21, "simpl": 21, "simplifi": 19, "simul": 21, "singl": [16, 21], "size": 18, "smallest": [12, 17], "smart": 4, "so": [14, 19], "soc": 21, "some": 4, "sort": 18, "sotiropoulo": 21, "sourc": [1, 2, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 20], "space": 21, "specif": [20, 25], "specifi": [5, 8, 20, 25], "spectrum": 21, "spheric": 15, "sphinx": 19, "spline": [13, 14], "split": [3, 20, 25], "splitter": 19, "src": 20, "start": [18, 25], "static": [9, 13, 14], "statu": 19, "step": 25, "stop": 19, "store": 20, "str": [1, 5, 8, 13, 14, 16, 18], "strategi": 9, "strength": 25, "string": [1, 8], "structur": [4, 6, 19], "sty": 19, "style": 19, "stylist": 19, "subject": [17, 21], "submodul": 20, "suggest": 19, "suppli": 8, "support": [5, 19], "sure": [20, 22], "suscept": 4, "system": 19, "tabl": [4, 25], "tag": 20, "target": [9, 21, 24, 25], "task": 19, "techniqu": 25, "temporari": 19, "tensormodel": [13, 14], "test": [7, 19, 25], "test_data": 7, "test_gradi": 7, "textnorm": 15, "thei": 16, "theta": [15, 17], "thi": [4, 5, 7, 9, 10, 14, 20, 21, 25], "thread": [9, 24, 25], "threadpoolexecutor": 19, "three": [21, 25], "threshold": [5, 14], "time": [6, 9, 14, 25], "timepoint": [6, 9, 13, 14], "tmp_path": 19, "tmpdir": 19, "to_filenam": [4, 6, 20, 25], "to_nifti": [4, 6, 20, 25], "toler": 14, "toml": 20, "too": 20, "tool": [9, 21, 25], "total": 6, "total_dur": [6, 20], "train": 7, "train_data": 7, "train_gradi": 7, "transform": [8, 25], "transpos": 12, "travers": [9, 18], "tree": 20, "triangular": 12, "trivial": [13, 14, 19], "trivialb0model": [13, 14, 20], "true": [5, 12, 17, 18], "tupl": 7, "two": [12, 17], "txt": 19, "type": [1, 2, 5, 8, 9, 12, 13, 14, 15, 17, 18, 19, 25], "typo": 19, "uint8": 5, "under": 20, "unit": 25, "unnam": 19, "unnecessari": 19, "unus": 19, "unwarp": 4, "up": [19, 21], "updat": [4, 6, 7, 19, 20, 25], "upon": 21, "upper": [5, 14], "upstream": 19, "uptak": 19, "us": [5, 9, 10, 13, 14, 19, 21, 22, 24], "usag": [24, 25], "util": [3, 11, 19, 20, 21, 25], "v": 14, "v1": 12, "v2": 12, "valu": [5, 7, 14, 15, 16, 18, 21], "valueerror": 10, "variabl": 19, "vector": [7, 9, 12, 17], "version": [19, 20], "visual": [4, 25], "vol": 21, "volum": [4, 6, 7, 13, 14, 18, 25], "voxel": [4, 6], "wa": 21, "warn": 19, "watch": 14, "we": 20, "weight": [21, 25], "well": 9, "what": 21, "when": [5, 14], "whether": 12, "which": [8, 15, 20, 25], "while": 21, "wide": 21, "with_b0": 7, "within": [5, 9, 20, 21, 25], "without": [4, 6, 21], "word": 20, "work": 21, "workflow": 19, "wrapper": [13, 14], "write": [4, 6], "www": [14, 20], "x": 20, "xlim": [13, 14], "yaml": 24, "you": 20, "your": [20, 22, 25], "youtub": 14, "zero": 15, "zip": 19, "\u03b8": 15}, "titles": ["eddymotion.cli package", "eddymotion.cli.parser module", "eddymotion.cli.run module", "eddymotion.data package", "eddymotion.data.dmri module", "eddymotion.data.filtering module", "eddymotion.data.pet module", "eddymotion.data.splitting module", "eddymotion.data.utils module", "eddymotion.estimator module", "eddymotion.exceptions module", "eddymotion.math package", "eddymotion.math.utils module", "eddymotion.model package", "eddymotion.model.base module", "eddymotion.model.dmri_covariance module", "eddymotion.model.dmri_utils module", "eddymotion.model.gradient_utils module", "eddymotion.utils module", "What\u2019s new?", "For developers", "Eddymotion", "Installation", "<no title>", "Running Eddymotion", "How to Use"], "titleterms": {"": 19, "0": 19, "1": 19, "12": 19, "13": 19, "15": 19, "2021": 19, "2024": 19, "4": 19, "For": 20, "api": 20, "applic": 20, "april": 19, "argument": 24, "base": 14, "cli": [0, 1, 2], "command": 24, "content": 21, "contribut": 20, "data": [3, 4, 5, 6, 7, 8], "depend": 22, "develop": 20, "dmri": 4, "dmri_covari": 15, "dmri_util": 16, "document": 20, "eddymot": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 21, 24, 25], "estim": 9, "except": 10, "extern": 22, "filter": 5, "gradient_util": 17, "how": 25, "incorpor": 25, "instal": 22, "interfac": [20, 24], "librari": 20, "line": 24, "mai": 19, "math": [11, 12], "model": [13, 14, 15, 16, 17], "modul": [1, 2, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 18, 25], "name": 24, "new": 19, "packag": [0, 3, 11, 13], "parser": 1, "pet": 6, "posit": 24, "program": 20, "python": 25, "run": [2, 24], "script": 25, "split": 7, "submodul": [0, 3, 11, 13], "us": 25, "util": [8, 12, 18], "what": 19}}) \ No newline at end of file diff --git a/main/usage.html b/main/usage.html index 0c53aca0..23e8223f 100644 --- a/main/usage.html +++ b/main/usage.html @@ -6,7 +6,7 @@ - How to Use - eddymotion 24.0.0.dev65 documentation + How to Use - eddymotion 24.0.0.dev67 documentation @@ -180,7 +180,7 @@
@@ -203,14 +203,14 @@ +