diff --git a/main/.buildinfo b/main/.buildinfo index 7235c376..0c927929 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: 08cb6f20e1be0387bf0d81947daef8de +config: 1f1570e4f3bdfb1618abf3381fef3b88 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/_modules/eddymotion/data/dmri.html b/main/_modules/eddymotion/data/dmri.html index 6bd83571..42c142e7 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.dev162+gc073fdf documentation + eddymotion.data.dmri - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -123,7 +123,7 @@
-
eddymotion 24.0.0.dev162+gc073fdf documentation
+
eddymotion 24.0.0.dev166+ga35b36a documentation
@@ -145,14 +145,14 @@ diff --git a/main/_modules/eddymotion/data/pet.html b/main/_modules/eddymotion/data/pet.html index 2de48300..2ea0b1dc 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.dev162+gc073fdf documentation + eddymotion.data.pet - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -123,7 +123,7 @@
-
eddymotion 24.0.0.dev162+gc073fdf documentation
+
eddymotion 24.0.0.dev166+ga35b36a documentation
@@ -145,14 +145,14 @@ diff --git a/main/_modules/eddymotion/data/utils.html b/main/_modules/eddymotion/data/utils.html index 58b642ff..0b0895ac 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.dev162+gc073fdf documentation + eddymotion.data.utils - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -123,7 +123,7 @@
@@ -145,14 +145,14 @@ diff --git a/main/_modules/eddymotion/estimator.html b/main/_modules/eddymotion/estimator.html index 51600b39..4aa8d59d 100644 --- a/main/_modules/eddymotion/estimator.html +++ b/main/_modules/eddymotion/estimator.html @@ -5,7 +5,7 @@ - eddymotion.estimator - eddymotion 24.0.0.dev162+gc073fdf documentation + eddymotion.estimator - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -123,7 +123,7 @@
@@ -145,14 +145,14 @@ diff --git a/main/_modules/eddymotion/model/base.html b/main/_modules/eddymotion/model/base.html index 82e54c94..5cb08afc 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.dev162+gc073fdf documentation + eddymotion.model.base - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -123,7 +123,7 @@
@@ -145,14 +145,14 @@ diff --git a/main/_modules/eddymotion/viz.html b/main/_modules/eddymotion/viz.html index 5991eb8e..44d20bf5 100644 --- a/main/_modules/eddymotion/viz.html +++ b/main/_modules/eddymotion/viz.html @@ -5,7 +5,7 @@ - eddymotion.viz - eddymotion 24.0.0.dev162+gc073fdf documentation + eddymotion.viz - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -123,7 +123,7 @@
@@ -145,14 +145,14 @@ diff --git a/main/_modules/index.html b/main/_modules/index.html index b02c01e3..a52c470b 100644 --- a/main/_modules/index.html +++ b/main/_modules/index.html @@ -5,7 +5,7 @@ - Overview: module code - eddymotion 24.0.0.dev162+gc073fdf documentation + Overview: module code - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -123,7 +123,7 @@
@@ -145,14 +145,14 @@ +
diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js index 3cfcfd12..071de3e6 100644 --- a/main/_static/documentation_options.js +++ b/main/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '24.0.0.dev162+gc073fdf', + VERSION: '24.0.0.dev166+ga35b36a', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/main/api/eddymotion.data.dmri.html b/main/api/eddymotion.data.dmri.html index 7daf10b6..2c9bbb9c 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.dev162+gc073fdf documentation + eddymotion.data.dmri module - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@ +
diff --git a/main/api/eddymotion.data.html b/main/api/eddymotion.data.html index d4e2b5b7..a3d0989b 100644 --- a/main/api/eddymotion.data.html +++ b/main/api/eddymotion.data.html @@ -6,7 +6,7 @@ - eddymotion.data package - eddymotion 24.0.0.dev162+gc073fdf documentation + eddymotion.data package - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@
@@ -146,14 +146,14 @@ +
diff --git a/main/api/eddymotion.data.utils.html b/main/api/eddymotion.data.utils.html index e07e534e..2eebcd1f 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.dev162+gc073fdf documentation + eddymotion.data.utils module - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@ +
diff --git a/main/api/eddymotion.estimator.html b/main/api/eddymotion.estimator.html index 2f4b75e6..55951377 100644 --- a/main/api/eddymotion.estimator.html +++ b/main/api/eddymotion.estimator.html @@ -6,7 +6,7 @@ - eddymotion.estimator module - eddymotion 24.0.0.dev162+gc073fdf documentation + eddymotion.estimator module - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@ +
diff --git a/main/api/eddymotion.model.base.html b/main/api/eddymotion.model.base.html index dd0ad419..673ec9eb 100644 --- a/main/api/eddymotion.model.base.html +++ b/main/api/eddymotion.model.base.html @@ -6,7 +6,7 @@ - eddymotion.model.base module - eddymotion 24.0.0.dev162+gc073fdf documentation + eddymotion.model.base module - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@ +
diff --git a/main/api/eddymotion.model.html b/main/api/eddymotion.model.html index 267f9c97..f4556d1a 100644 --- a/main/api/eddymotion.model.html +++ b/main/api/eddymotion.model.html @@ -6,7 +6,7 @@ - eddymotion.model package - eddymotion 24.0.0.dev162+gc073fdf documentation + eddymotion.model package - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@
@@ -146,14 +146,14 @@ +
diff --git a/main/changes.html b/main/changes.html index 821dfaae..7dd2d020 100644 --- a/main/changes.html +++ b/main/changes.html @@ -6,7 +6,7 @@ - What’s new? - eddymotion 24.0.0.dev162+gc073fdf documentation + What’s new? - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@
@@ -146,14 +146,14 @@
@@ -144,14 +144,14 @@ +
diff --git a/main/index.html b/main/index.html index 40d866e3..0966f40f 100644 --- a/main/index.html +++ b/main/index.html @@ -6,7 +6,7 @@ - eddymotion 24.0.0.dev162+gc073fdf documentation + eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@ +
diff --git a/main/installation.html b/main/installation.html index 20bdee69..d8d1a65c 100644 --- a/main/installation.html +++ b/main/installation.html @@ -6,7 +6,7 @@ - Installation - eddymotion 24.0.0.dev162+gc073fdf documentation + Installation - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -124,7 +124,7 @@
@@ -146,14 +146,14 @@ +
diff --git a/main/objects.inv b/main/objects.inv index 676ee7ce..0f72a1ba 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 d73b211f..bfe02fbe 100644 --- a/main/py-modindex.html +++ b/main/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - eddymotion 24.0.0.dev162+gc073fdf documentation + Python Module Index - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -122,7 +122,7 @@
@@ -144,14 +144,14 @@ +
diff --git a/main/search.html b/main/search.html index a8715f86..58831b04 100644 --- a/main/search.html +++ b/main/search.html @@ -4,7 +4,7 @@ - Search - eddymotion 24.0.0.dev162+gc073fdf documentation + Search - eddymotion 24.0.0.dev166+ga35b36a documentation @@ -121,7 +121,7 @@
@@ -143,14 +143,14 @@ +
diff --git a/main/searchindex.js b/main/searchindex.js index d6c09e6b..c8b9c0d8 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["api/eddymotion.data", "api/eddymotion.data.dmri", "api/eddymotion.data.pet", "api/eddymotion.data.utils", "api/eddymotion.estimator", "api/eddymotion.model", "api/eddymotion.model.base", "api/eddymotion.viz", "changes", "developers", "index", "installation", "links"], "filenames": ["api/eddymotion.data.rst", "api/eddymotion.data.dmri.rst", "api/eddymotion.data.pet.rst", "api/eddymotion.data.utils.rst", "api/eddymotion.estimator.rst", "api/eddymotion.model.rst", "api/eddymotion.model.base.rst", "api/eddymotion.viz.rst", "changes.rst", "developers.rst", "index.rst", "installation.rst", "links.rst"], "titles": ["eddymotion.data package", "eddymotion.data.dmri module", "eddymotion.data.pet module", "eddymotion.data.utils module", "eddymotion.estimator module", "eddymotion.model package", "eddymotion.model.base module", "eddymotion.viz module", "What\u2019s new?", "For developers", "Eddymotion", "Installation", "<no title>"], "terms": {"dmri": [0, 4, 6, 9, 10], "modul": [0, 5, 9, 10], "pet": [0, 5, 6, 9], "util": [0, 7, 9], "repres": [1, 2, 4], "hard": 1, "disk": [1, 2], "memori": 1, "class": [1, 2, 4, 5, 6, 9], "dwi": [1, 4, 8, 9, 10], "dataobj": [1, 2, 7, 9], "none": [1, 2, 3, 4, 5, 6, 7], "affin": [1, 2, 3, 4, 7, 9], "brainmask": [1, 2, 9], "bzero": [1, 9], "gradient": [1, 2, 4, 5, 6, 7, 8, 9], "em_affin": [1, 2, 3, 4, 9], "fieldmap": [1, 9], "filepath": [1, 2, 3, 7], "noth": [1, 2, 5, 6], "sourc": [1, 2, 3, 4, 5, 6, 7, 9], "base": [1, 2, 4, 5, 9, 10], "object": [1, 2, 4, 5, 6, 7], "represent": [1, 2], "structur": [1, 2], "best": [1, 2], "ra": [1, 2, 7], "voxel": [1, 2], "convers": [1, 2], "coordin": [1, 2], "nifti": [1, 2], "header": [1, 2], "A": [1, 2, 4, 5, 6, 7], "boolean": [1, 2, 7], "ndarrai": [1, 2, 3, 4, 7], "contain": [1, 2, 4, 7, 9], "correspond": [1, 2, 4, 7], "b": [1, 2, 4, 5, 6, 7, 10], "0": [1, 2, 5, 6, 7, 9, 10], "refer": [1, 7], "map": [1, 4, 5, 6, 7, 8], "prefer": 1, "obtain": 1, "some": [1, 7], "smart": 1, "averag": [1, 5, 6], "If": 1, "b_0": 1, "i": [1, 4, 6, 7, 9, 10], "set": [1, 2, 10], "thi": [1, 4, 6, 9, 10], "should": 1, "also": 1, "unwarp": 1, "numpi": [1, 2, 4, 7], "arrai": [1, 2, 3, 7], "without": [1, 2, 10], "volum": [1, 2], "list": [1, 2, 4], "nitransform": [1, 2], "linear": [1, 2], "bring": [1, 2], "e": [1, 7, 9, 10], "align": [1, 2], "3d": [1, 7], "displac": 1, "field": 1, "suscept": 1, "distort": [1, 4, 10], "classmethod": [1, 2], "from_filenam": [1, 2, 9], "filenam": [1, 2, 7], "read": [1, 2, 6, 9], "an": [1, 2, 4, 5, 6, 7, 10], "hdf5": [1, 2], "file": [1, 2, 7], "from": [1, 2, 4, 6, 7, 8, 10, 11], "2d": [1, 7], "tabl": [1, 7], "format": [1, 7], "logo_split": [1, 9], "index": [1, 2, 7], "with_b0": 1, "fals": [1, 2, 7], "produc": 1, "one": [1, 10], "fold": 1, "logo": 1, "leav": [1, 10], "out": [1, 10], "paramet": [1, 3, 4, 5, 6, 7], "int": [1, 4, 7], "orient": 1, "left": 1, "bool": [1, 4, 7], "insert": 1, "begin": 1, "train": 1, "dataset": [1, 4, 10], "return": [1, 3, 4, 5, 6, 7], "train_data": 1, "train_gradi": 1, "tupl": 1, "come": 1, "updat": [1, 2, 7, 8, 9], "test_data": 1, "test_gradi": 1, "test": 1, "vector": [1, 4, 7], "valu": [1, 7, 10], "The": [1, 4, 7, 8, 9], "origin": 1, "plot_gradi": [1, 7, 8, 9], "kwarg": [1, 4, 5, 6, 7], "visual": [1, 7], "diffus": [1, 4, 5, 6, 10], "plot_mosa": [1, 9], "direct": [1, 7], "set_transform": [1, 2, 9], "order": [1, 2, 5, 6], "3": [1, 2, 5, 6, 7, 10, 11], "to_filenam": [1, 2, 9], "compress": [1, 2], "compression_opt": [1, 2], "write": [1, 2], "to_nifti": [1, 2, 9], "insert_b0": [1, 2], "1": [1, 2, 7, 9, 10], "load": [1, 2, 9], "gradients_fil": 1, "b0_file": 1, "brainmask_fil": [1, 2], "fmap_fil": 1, "bvec_fil": 1, "bval_fil": 1, "b0_thre": 1, "50": 1, "frame_tim": [2, 9], "total_dur": [2, 9], "timepoint": [2, 5, 6], "1d": 2, "midpoint": 2, "time": [2, 4, 7], "each": [2, 4, 7], "sampl": [2, 7], "float": [2, 7], "number": [2, 4, 7], "total": 2, "durat": 2, "acquisit": [2, 10], "frame_dur": 2, "apply_affin": [3, 9], "nii": [3, 7], "output_filenam": 3, "appli": 3, "suppli": 3, "nifti1imag": [3, 7], "transform": 3, "nx4x4": 3, "str": [3, 5, 6], "option": [3, 5, 6], "string": [3, 7], "specifi": [3, 7, 9], "which": [3, 7, 9], "save": [3, 7], "nii_t_img": 3, "type": [3, 4, 5, 6, 7], "model": [4, 9, 10], "algorithm": 4, "realign": [4, 5, 6], "data": [4, 5, 6, 7, 9, 10], "eddymotionestim": [4, 9], "rigid": 4, "bodi": 4, "head": [4, 10], "motion": [4, 10], "deriv": [4, 10], "eddi": [4, 10], "current": [4, 10], "static": [4, 5, 6], "fit": [4, 5, 6, 9], "dwdata": 4, "align_kwarg": 4, "b0": 4, "omp_nthread": 4, "n_job": [4, 6], "seed": 4, "target": [4, 10], "tool": [4, 10], "": [4, 5, 6, 7, 10], "intern": 4, "us": [4, 7, 8, 10, 11], "place": 4, "its": 4, "properti": 4, "well": 4, "rotat": [4, 7], "within": [4, 9, 10], "n_iter": 4, "iter": 4, "particular": 4, "go": 4, "repeat": 4, "dict": [4, 7], "configur": 4, "imag": [4, 5, 6, 7, 10], "registr": [4, 10], "process": [4, 10], "select": 4, "gener": [4, 8, 9, 10], "see": [4, 6], "modelfactori": [4, 5, 6, 9], "allow": 4, "keyword": [4, 7], "maximum": [4, 7], "thread": 4, "individu": 4, "mai": 4, "parallel": 4, "job": 4, "random": 4, "necessari": 4, "when": 4, "we": [4, 9], "want": 4, "determinist": 4, "4": [4, 7, 10], "matric": 4, "encod": 4, "deform": [4, 10], "caus": 4, "averagedwmodel": [5, 6, 9], "trivial": [5, 6], "calcul": [5, 6, 7], "predict": [5, 6, 9, 10], "dkimodel": [5, 6, 9], "gtab": [5, 6, 7], "s0": [5, 6], "mask": [5, 6, 7], "b_max": [5, 6], "basemodel": [5, 6, 9], "wrapper": [5, 6], "dipi": [5, 6, 10, 11], "reconst": [5, 6], "dki": [5, 6, 8], "diffusionkurtosismodel": [5, 6], "dtimodel": [5, 6, 9], "dti": [5, 6, 8, 10], "tensormodel": [5, 6], "factori": [5, 6], "instanti": [5, 6], "init": [5, 6, 9], "instati": [5, 6], "averagedw": [5, 6], "compliant": [5, 6], "interfac": [5, 6, 10], "reconstmodel": [5, 6], "petmodel": [5, 6, 9], "xlim": [5, 6], "n_ctrl": [5, 6], "spline": [5, 6], "approxim": [5, 6], "arg": [5, 6, 7], "trivialb0model": [5, 6, 9], "alwai": [5, 6], "do": [5, 6, 9], "adapt": [6, 7], "defin": 6, "default": 6, "method": [6, 8, 9, 10], "implement": [6, 8, 10], "instead": [6, 7], "inherit": 6, "abstract": 6, "follow": [6, 8, 11], "principl": 6, "easier": 6, "maintain": [6, 9], "http": [6, 9], "www": [6, 9], "youtub": 6, "com": 6, "watch": 6, "v": [6, 7], "3mnvp9": 6, "hglc": 6, "chunk": 6, "asynchron": 6, "signal": 6, "draw_circl": [7, 9], "posit": 7, "radiu": 7, "n_sampl": 7, "20": 7, "draw": 7, "circular": 7, "patch": [7, 9], "ly": 7, "sphere": 7, "given": 7, "emmanuel": 7, "caruy": 7, "code": [7, 9], "distribut": 7, "under": [7, 9], "revis": 7, "bsd": 7, "licens": [7, 8], "copyright": 7, "c": [7, 9, 11], "2013": 7, "2015": 7, "all": [7, 9, 11], "right": 7, "reserv": 7, "modifi": 7, "take": 7, "full": 7, "normal": 7, "bvec": 7, "circl": 7, "radii": 7, "specif": [7, 9], "shell": [7, 10], "n": 7, "cartesian": 7, "singl": [7, 10], "plot": [7, 8], "draw_point": [7, 9], "ax": 7, "rad_min": 7, "rad_max": 7, "7": [7, 10, 11], "cmap": 7, "viridi": 7, "input": 7, "scale": 7, "proport": 7, "invers": 7, "bval": 7, "minimum": 7, "maxim": 7, "can": [7, 11], "ar": [7, 9, 11], "drawn": 7, "onc": 7, "loop": 7, "over": 7, "variabl": 7, "have": [7, 9], "been": 7, "renam": 7, "like": 7, "vect": 7, "shape": 7, "matplotlib": 7, "axi": 7, "instanc": 7, "between": [7, 10], "render": [7, 10], "pyplot": 7, "cm": 7, "colormap": 7, "name": [7, 8], "get_segment_label": [7, 9], "delimit": 7, "index_posit": 7, "label_posit": 7, "segment": 7, "label": 7, "plot_carpet": [7, 9], "function": [7, 9, 11], "path": 7, "text": 7, "freesurf": 7, "group": 7, "togeth": 7, "g": 7, "cerebral_white_matt": 7, "cerebral_cortex": 7, "ventricl": 7, "2": [7, 8, 9, 10], "41": 7, "42": 7, "14": 7, "15": 7, "43": 7, "72": 7, "sort_by_bv": 7, "output_fil": 7, "segment_label": 7, "detrend": 7, "carpet": 7, "niworkflow": 7, "carpet_plot": 7, "dw": [7, 10], "gradientt": 7, "flag": 7, "reorder": 7, "point": 7, "bvalu": 7, "dictionari": 7, "integ": 7, "gridspec": 7, "plot_dwi": [7, 9], "titl": 7, "space": [7, 10], "05": 7, "unit": 7, "color": 7, "multipl": [7, 10], "custom": 7, "figur": 7, "adjust": 7, "extra": 7, "rotation_matrix": [7, 9], "u": 7, "matrix": 7, "r": [7, 10], "cdot": 7, "mathbf": 7, "extract": 7, "onli": [7, 9], "minim": 7, "leverag": 7, "first": [8, 9], "releas": [8, 9], "more": [8, 10], "complet": 8, "deploy": 8, "cycl": 8, "fix": 8, "bad": 8, "argument": 8, "33": 8, "consist": 8, "30": 8, "enh": 8, "add": 8, "credit": 8, "system": 8, "32": 8, "27": 8, "stylist": 8, "suggest": 8, "maint": 8, "main": [8, 9], "upstream": 8, "niprep": [8, 9], "eddymotioncorrect": 8, "eddymot": [9, 11], "project": 9, "commun": 9, "guidelin": 9, "befor": 9, "delv": 9, "pleas": 9, "make": [9, 11], "sure": [9, 11], "you": 9, "offer": 9, "onlin": 9, "found": 9, "doc": 9, "folder": 9, "build": [9, 10], "archiv": 9, "gh": 9, "page": 9, "branch": 9, "repositori": 9, "With": 9, "github": 9, "post": 9, "org": 9, "version": 9, "store": 9, "git": 9, "tag": 9, "major": 9, "minor": 9, "everi": 9, "In": 9, "other": 9, "word": 9, "tree": 9, "latest": 9, "x": 9, "seri": 9, "commit": 9, "merg": 9, "too": 9, "automat": 9, "action": 9, "manual": 9, "To": 9, "local": 9, "need": [9, 10], "setuptools_scm": 9, "toml": 9, "6": 9, "instal": [9, 10], "your": [9, 11], "environ": [9, 11], "cd": 9, "python": [9, 11], "m": [9, 10, 11], "src": 9, "_version": 9, "py": 9, "html": 9, "inform": 9, "packag": [9, 10], "submodul": 9, "estim": [9, 10], "viz": [9, 10], "mri": 10, "retrospect": 10, "weight": 10, "acquir": 10, "experi": 10, "exception": 10, "challenging1": 10, "includ": 10, "high": 10, "These": 10, "1000": 10, "mm2": 10, "enabl": 10, "higher": 10, "angular": 10, "resolut": 10, "compar": 10, "tradit": 10, "tensor": 10, "scheme": 10, "undistort": 10, "nondistort": 10, "simul": 10, "templat": 10, "Of": 10, "wa": 10, "earliest": 10, "address": 10, "issu": 10, "scan": 10, "same": 10, "subject": 10, "later": 10, "andersson": 10, "sotiropoulo": 10, "propos": 10, "similar": 10, "approach": 10, "wide": 10, "avail": 10, "fsl": 10, "regist": 10, "remaind": 10, "gaussian": 10, "besid": 10, "less": 10, "ha": 10, "advantag": 10, "implicitli": 10, "due": 10, "recent": 10, "cieslak": 10, "et": 10, "al": 10, "integr": 10, "both": 10, "shorelin": 10, "up": 10, "framework": 10, "ii": 10, "replac": 10, "purpos": 10, "shore": 10, "open": 10, "correct": 10, "upon": 10, "work": 10, "while": 10, "multi": 10, "spectrum": 10, "5": 10, "ben": 10, "amitai": 10, "magnet": 10, "reson": 10, "medicin": 10, "67": 10, "1694": 10, "1702": 10, "2012": 10, "j": 10, "l": 10, "off": 10, "effect": 10, "movement": 10, "mr": 10, "neuroimag": 10, "125": 10, "2016": 10, "1063": 10, "1078": 10, "qsiprep": 10, "platform": 10, "preprocess": 10, "reconstruct": 10, "natur": 10, "18": 10, "775": 10, "778": 10, "2021": 10, "ozarslan": 10, "simpl": 10, "harmon": 10, "oscil": 10, "three": 10, "dimension": 10, "q": 10, "proc": 10, "intl": 10, "soc": 10, "mag": 10, "med": 10, "vol": 10, "17": 10, "1396": 10, "2009": 10, "garyfallidi": 10, "librari": 10, "analysi": 10, "front": 10, "neuroinformat": 10, "8": 10, "2014": 10, "extern": 10, "depend": 10, "For": 10, "develop": 10, "contribut": 10, "document": 10, "api": 10, "applic": 10, "program": 10, "what": 10, "new": 10, "april": 10, "12": 10, "On": 11, "abov": 11, "pip": 11, "habitu": 11, "command": 11, "check": 11, "line": 11, "import": 11, "__version__": 11, "print": 11, "requir": 11, "ant": 11}, "objects": {"eddymotion": [[0, 0, 0, "-", "data"], [4, 0, 0, "-", "estimator"], [5, 0, 0, "-", "model"], [7, 0, 0, "-", "viz"]], "eddymotion.data": [[1, 0, 0, "-", "dmri"], [2, 0, 0, "-", "pet"], [3, 0, 0, "-", "utils"]], "eddymotion.data.dmri": [[1, 1, 1, "", "DWI"], [1, 4, 1, "", "load"]], "eddymotion.data.dmri.DWI": [[1, 2, 1, "", "affine"], [1, 2, 1, "", "brainmask"], [1, 2, 1, "", "bzero"], [1, 2, 1, "", "dataobj"], [1, 2, 1, "", "em_affines"], [1, 2, 1, "", "fieldmap"], [1, 3, 1, "", "from_filename"], [1, 2, 1, "", "gradients"], [1, 3, 1, "", "logo_split"], [1, 3, 1, "", "plot_gradients"], [1, 3, 1, "", "plot_mosaic"], [1, 3, 1, "", "set_transform"], [1, 3, 1, "", "to_filename"], [1, 3, 1, "", "to_nifti"]], "eddymotion.data.pet": [[2, 1, 1, "", "PET"], [2, 4, 1, "", "load"]], "eddymotion.data.pet.PET": [[2, 2, 1, "", "affine"], [2, 2, 1, "", "brainmask"], [2, 2, 1, "", "dataobj"], [2, 2, 1, "", "em_affines"], [2, 2, 1, "", "frame_time"], [2, 3, 1, "", "from_filename"], [2, 3, 1, "", "set_transform"], [2, 3, 1, "", "to_filename"], [2, 3, 1, "", "to_nifti"], [2, 2, 1, "", "total_duration"]], "eddymotion.data.utils": [[3, 4, 1, "", "apply_affines"]], "eddymotion.estimator": [[4, 1, 1, "", "EddyMotionEstimator"]], "eddymotion.estimator.EddyMotionEstimator": [[4, 3, 1, "", "fit"]], "eddymotion.model": [[5, 1, 1, "", "AverageDWModel"], [5, 1, 1, "", "DKIModel"], [5, 1, 1, "", "DTIModel"], [5, 1, 1, "", "ModelFactory"], [5, 1, 1, "", "PETModel"], [5, 1, 1, "", "TrivialB0Model"], [6, 0, 0, "-", "base"]], "eddymotion.model.AverageDWModel": [[5, 3, 1, "", "fit"], [5, 3, 1, "", "predict"]], "eddymotion.model.ModelFactory": [[5, 3, 1, "", "init"]], "eddymotion.model.PETModel": [[5, 3, 1, "", "fit"], [5, 3, 1, "", "predict"]], "eddymotion.model.TrivialB0Model": [[5, 3, 1, "", "fit"], [5, 3, 1, "", "predict"]], "eddymotion.model.base": [[6, 1, 1, "", "AverageDWModel"], [6, 1, 1, "", "BaseModel"], [6, 1, 1, "", "DKIModel"], [6, 1, 1, "", "DTIModel"], [6, 1, 1, "", "ModelFactory"], [6, 1, 1, "", "PETModel"], [6, 1, 1, "", "TrivialB0Model"]], "eddymotion.model.base.AverageDWModel": [[6, 3, 1, "", "fit"], [6, 3, 1, "", "predict"]], "eddymotion.model.base.BaseModel": [[6, 3, 1, "", "fit"], [6, 3, 1, "", "predict"]], "eddymotion.model.base.ModelFactory": [[6, 3, 1, "", "init"]], "eddymotion.model.base.PETModel": [[6, 3, 1, "", "fit"], [6, 3, 1, "", "predict"]], "eddymotion.model.base.TrivialB0Model": [[6, 3, 1, "", "fit"], [6, 3, 1, "", "predict"]], "eddymotion.viz": [[7, 4, 1, "", "draw_circles"], [7, 4, 1, "", "draw_points"], [7, 4, 1, "", "get_segment_labels"], [7, 4, 1, "", "plot_carpet"], [7, 4, 1, "", "plot_dwi"], [7, 4, 1, "", "plot_gradients"], [7, 4, 1, "", "rotation_matrix"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"]}, "titleterms": {"eddymot": [0, 1, 2, 3, 4, 5, 6, 7, 10], "data": [0, 1, 2, 3], "packag": [0, 5], "submodul": [0, 5], "dmri": 1, "modul": [1, 2, 3, 4, 6, 7], "pet": 2, "util": 3, "estim": 4, "model": [5, 6], "base": 6, "viz": 7, "list": 7, "chang": 7, "what": 8, "": 8, "new": 8, "0": 8, "1": 8, "4": 8, "april": 8, "12": 8, "2021": 8, "For": 9, "develop": 9, "contribut": 9, "document": 9, "librari": 9, "api": 9, "applic": 9, "program": 9, "interfac": 9, "content": 10, "instal": 11, "extern": 11, "depend": 11}, "envversion": {"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, "sphinx": 60}, "alltitles": {"eddymotion.data package": [[0, "module-eddymotion.data"]], "Submodules": [[0, "submodules"], [5, "submodules"]], "eddymotion.data.dmri module": [[1, "module-eddymotion.data.dmri"]], "eddymotion.data.pet module": [[2, "module-eddymotion.data.pet"]], "eddymotion.data.utils module": [[3, "module-eddymotion.data.utils"]], "eddymotion.estimator module": [[4, "module-eddymotion.estimator"]], "eddymotion.model package": [[5, "module-eddymotion.model"]], "eddymotion.model.base module": [[6, "module-eddymotion.model.base"]], "eddymotion.viz module": [[7, "module-eddymotion.viz"]], "List of changes": [[7, null], [7, null], [7, null]], "What\u2019s new?": [[8, "what-s-new"]], "0.1.4 (April 12, 2021)": [[8, "april-12-2021"]], "For developers": [[9, "for-developers"]], "Contributing": [[9, "contributing"]], "Documentation": [[9, "documentation"]], "Library API (application program interface)": [[9, "library-api-application-program-interface"]], "Eddymotion": [[10, "eddymotion"]], "Contents": [[10, "contents"]], "Installation": [[11, "id1"]], "External Dependencies": [[11, "external-dependencies"]]}, "indexentries": {"eddymotion.data": [[0, "module-eddymotion.data"]], "module": [[0, "module-eddymotion.data"], [1, "module-eddymotion.data.dmri"], [2, "module-eddymotion.data.pet"], [3, "module-eddymotion.data.utils"], [4, "module-eddymotion.estimator"], [5, "module-eddymotion.model"], [6, "module-eddymotion.model.base"], [7, "module-eddymotion.viz"]], "dwi (class in eddymotion.data.dmri)": [[1, "eddymotion.data.dmri.DWI"]], "affine (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.affine"]], "brainmask (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.brainmask"]], "bzero (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.bzero"]], "dataobj (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.dataobj"]], "eddymotion.data.dmri": [[1, "module-eddymotion.data.dmri"]], "em_affines (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.em_affines"]], "fieldmap (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.fieldmap"]], "from_filename() (eddymotion.data.dmri.dwi class method)": [[1, "eddymotion.data.dmri.DWI.from_filename"]], "gradients (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.gradients"]], "load() (in module eddymotion.data.dmri)": [[1, "eddymotion.data.dmri.load"]], "logo_split() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.logo_split"]], "plot_gradients() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.plot_gradients"]], "plot_mosaic() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.plot_mosaic"]], "set_transform() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.set_transform"]], "to_filename() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.to_filename"]], "to_nifti() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.to_nifti"]], "pet (class in eddymotion.data.pet)": [[2, "eddymotion.data.pet.PET"]], "affine (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.affine"]], "brainmask (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.brainmask"]], "dataobj (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.dataobj"]], "eddymotion.data.pet": [[2, "module-eddymotion.data.pet"]], "em_affines (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.em_affines"]], "frame_time (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.frame_time"]], "from_filename() (eddymotion.data.pet.pet class method)": [[2, "eddymotion.data.pet.PET.from_filename"]], "load() (in module eddymotion.data.pet)": [[2, "eddymotion.data.pet.load"]], "set_transform() (eddymotion.data.pet.pet method)": [[2, "eddymotion.data.pet.PET.set_transform"]], "to_filename() (eddymotion.data.pet.pet method)": [[2, "eddymotion.data.pet.PET.to_filename"]], "to_nifti() (eddymotion.data.pet.pet method)": [[2, "eddymotion.data.pet.PET.to_nifti"]], "total_duration (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.total_duration"]], "apply_affines() (in module eddymotion.data.utils)": [[3, "eddymotion.data.utils.apply_affines"]], "eddymotion.data.utils": [[3, "module-eddymotion.data.utils"]], "eddymotionestimator (class in eddymotion.estimator)": [[4, "eddymotion.estimator.EddyMotionEstimator"]], "eddymotion.estimator": [[4, "module-eddymotion.estimator"]], "fit() (eddymotion.estimator.eddymotionestimator static method)": [[4, "eddymotion.estimator.EddyMotionEstimator.fit"]], "averagedwmodel (class in eddymotion.model)": [[5, "eddymotion.model.AverageDWModel"]], "dkimodel (class in eddymotion.model)": [[5, "eddymotion.model.DKIModel"]], "dtimodel (class in eddymotion.model)": [[5, "eddymotion.model.DTIModel"]], "modelfactory (class in eddymotion.model)": [[5, "eddymotion.model.ModelFactory"]], "petmodel (class in eddymotion.model)": [[5, "eddymotion.model.PETModel"]], "trivialb0model (class in eddymotion.model)": [[5, "eddymotion.model.TrivialB0Model"]], "eddymotion.model": [[5, "module-eddymotion.model"]], "fit() (eddymotion.model.averagedwmodel method)": [[5, "eddymotion.model.AverageDWModel.fit"]], "fit() (eddymotion.model.petmodel method)": [[5, "eddymotion.model.PETModel.fit"]], "fit() (eddymotion.model.trivialb0model method)": [[5, "eddymotion.model.TrivialB0Model.fit"]], "init() (eddymotion.model.modelfactory static method)": [[5, "eddymotion.model.ModelFactory.init"]], "predict() (eddymotion.model.averagedwmodel method)": [[5, "eddymotion.model.AverageDWModel.predict"]], "predict() (eddymotion.model.petmodel method)": [[5, "eddymotion.model.PETModel.predict"]], "predict() (eddymotion.model.trivialb0model method)": [[5, "eddymotion.model.TrivialB0Model.predict"]], "averagedwmodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.AverageDWModel"]], "basemodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.BaseModel"]], "dkimodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.DKIModel"]], "dtimodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.DTIModel"]], "modelfactory (class in eddymotion.model.base)": [[6, "eddymotion.model.base.ModelFactory"]], "petmodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.PETModel"]], "trivialb0model (class in eddymotion.model.base)": [[6, "eddymotion.model.base.TrivialB0Model"]], "eddymotion.model.base": [[6, "module-eddymotion.model.base"]], "fit() (eddymotion.model.base.averagedwmodel method)": [[6, "eddymotion.model.base.AverageDWModel.fit"]], "fit() (eddymotion.model.base.basemodel method)": [[6, "eddymotion.model.base.BaseModel.fit"]], "fit() (eddymotion.model.base.petmodel method)": [[6, "eddymotion.model.base.PETModel.fit"]], "fit() (eddymotion.model.base.trivialb0model method)": [[6, "eddymotion.model.base.TrivialB0Model.fit"]], "init() (eddymotion.model.base.modelfactory static method)": [[6, "eddymotion.model.base.ModelFactory.init"]], "predict() (eddymotion.model.base.averagedwmodel method)": [[6, "eddymotion.model.base.AverageDWModel.predict"]], "predict() (eddymotion.model.base.basemodel method)": [[6, "eddymotion.model.base.BaseModel.predict"]], "predict() (eddymotion.model.base.petmodel method)": [[6, "eddymotion.model.base.PETModel.predict"]], "predict() (eddymotion.model.base.trivialb0model method)": [[6, "eddymotion.model.base.TrivialB0Model.predict"]], "draw_circles() (in module eddymotion.viz)": [[7, "eddymotion.viz.draw_circles"]], "draw_points() (in module eddymotion.viz)": [[7, "eddymotion.viz.draw_points"]], "eddymotion.viz": [[7, "module-eddymotion.viz"]], "get_segment_labels() (in module eddymotion.viz)": [[7, "eddymotion.viz.get_segment_labels"]], "plot_carpet() (in module eddymotion.viz)": [[7, "eddymotion.viz.plot_carpet"]], "plot_dwi() (in module eddymotion.viz)": [[7, "eddymotion.viz.plot_dwi"]], "plot_gradients() (in module eddymotion.viz)": [[7, "eddymotion.viz.plot_gradients"]], "rotation_matrix() (in module eddymotion.viz)": [[7, "eddymotion.viz.rotation_matrix"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["api/eddymotion.data", "api/eddymotion.data.dmri", "api/eddymotion.data.pet", "api/eddymotion.data.utils", "api/eddymotion.estimator", "api/eddymotion.model", "api/eddymotion.model.base", "api/eddymotion.viz", "changes", "developers", "index", "installation", "links"], "filenames": ["api/eddymotion.data.rst", "api/eddymotion.data.dmri.rst", "api/eddymotion.data.pet.rst", "api/eddymotion.data.utils.rst", "api/eddymotion.estimator.rst", "api/eddymotion.model.rst", "api/eddymotion.model.base.rst", "api/eddymotion.viz.rst", "changes.rst", "developers.rst", "index.rst", "installation.rst", "links.rst"], "titles": ["eddymotion.data package", "eddymotion.data.dmri module", "eddymotion.data.pet module", "eddymotion.data.utils module", "eddymotion.estimator module", "eddymotion.model package", "eddymotion.model.base module", "eddymotion.viz module", "What\u2019s new?", "For developers", "Eddymotion", "Installation", "<no title>"], "terms": {"dmri": [0, 4, 6, 9, 10], "modul": [0, 5, 9, 10], "pet": [0, 5, 6, 9], "util": [0, 7, 9], "repres": [1, 2, 4], "hard": 1, "disk": [1, 2], "memori": 1, "class": [1, 2, 4, 5, 6, 9], "dwi": [1, 4, 8, 9, 10], "dataobj": [1, 2, 7, 9], "none": [1, 2, 3, 4, 5, 6, 7], "affin": [1, 2, 3, 4, 7, 9], "brainmask": [1, 2, 9], "bzero": [1, 9], "gradient": [1, 2, 4, 5, 6, 7, 8, 9], "em_affin": [1, 2, 3, 4, 9], "fieldmap": [1, 9], "filepath": [1, 2, 3, 7], "noth": [1, 2, 5, 6], "sourc": [1, 2, 3, 4, 5, 6, 7, 9], "base": [1, 2, 4, 5, 9, 10], "object": [1, 2, 4, 5, 6, 7], "represent": [1, 2], "structur": [1, 2], "best": [1, 2], "ra": [1, 2, 7], "voxel": [1, 2], "convers": [1, 2], "coordin": [1, 2], "nifti": [1, 2], "header": [1, 2], "A": [1, 2, 4, 5, 6, 7], "boolean": [1, 2, 7], "ndarrai": [1, 2, 3, 4, 7], "contain": [1, 2, 4, 7, 9], "correspond": [1, 2, 4, 7], "b": [1, 2, 4, 5, 6, 7, 10], "0": [1, 2, 5, 6, 7, 9, 10], "refer": [1, 7], "map": [1, 4, 5, 6, 7, 8], "prefer": 1, "obtain": 1, "some": [1, 7], "smart": 1, "averag": [1, 5, 6], "If": 1, "b_0": 1, "i": [1, 4, 6, 7, 9, 10], "set": [1, 2, 10], "thi": [1, 4, 6, 9], "should": 1, "also": 1, "unwarp": 1, "numpi": [1, 2, 4, 7], "arrai": [1, 2, 3, 7], "without": [1, 2], "volum": [1, 2], "list": [1, 2, 4], "nitransform": [1, 2], "linear": [1, 2], "bring": [1, 2], "e": [1, 7, 9, 10], "align": [1, 2], "3d": [1, 7], "displac": 1, "field": 1, "suscept": 1, "distort": [1, 4, 10], "classmethod": [1, 2], "from_filenam": [1, 2, 9], "filenam": [1, 2, 7], "read": [1, 2, 6, 9], "an": [1, 2, 4, 5, 6, 7, 10], "hdf5": [1, 2], "file": [1, 2, 7], "from": [1, 2, 4, 6, 7, 8, 10, 11], "2d": [1, 7], "tabl": [1, 7], "format": [1, 7], "logo_split": [1, 9], "index": [1, 2, 7], "with_b0": 1, "fals": [1, 2, 7], "produc": 1, "one": [1, 10], "fold": 1, "logo": 1, "leav": [1, 10], "out": [1, 10], "paramet": [1, 3, 4, 5, 6, 7], "int": [1, 4, 7], "orient": 1, "left": 1, "bool": [1, 4, 7], "insert": 1, "begin": 1, "train": 1, "dataset": [1, 4, 10], "return": [1, 3, 4, 5, 6, 7], "train_data": 1, "train_gradi": 1, "tupl": 1, "come": 1, "updat": [1, 2, 7, 8, 9], "test_data": 1, "test_gradi": 1, "test": 1, "vector": [1, 4, 7], "valu": [1, 7, 10], "The": [1, 4, 7, 8, 9], "origin": 1, "plot_gradi": [1, 7, 8, 9], "kwarg": [1, 4, 5, 6, 7], "visual": [1, 7], "diffus": [1, 4, 5, 6, 10], "plot_mosa": [1, 9], "direct": [1, 7], "set_transform": [1, 2, 9], "order": [1, 2, 5, 6], "3": [1, 2, 5, 6, 7, 10, 11], "to_filenam": [1, 2, 9], "compress": [1, 2], "compression_opt": [1, 2], "write": [1, 2], "to_nifti": [1, 2, 9], "insert_b0": [1, 2], "1": [1, 2, 7, 9, 10], "load": [1, 2, 9], "gradients_fil": 1, "b0_file": 1, "brainmask_fil": [1, 2], "fmap_fil": 1, "bvec_fil": 1, "bval_fil": 1, "b0_thre": 1, "50": 1, "frame_tim": [2, 9], "total_dur": [2, 9], "timepoint": [2, 5, 6], "1d": 2, "midpoint": 2, "time": [2, 4, 7], "each": [2, 4, 7], "sampl": [2, 7], "float": [2, 7], "number": [2, 4, 7], "total": 2, "durat": 2, "acquisit": [2, 10], "frame_dur": 2, "apply_affin": [3, 9], "nii": [3, 7], "output_filenam": 3, "appli": 3, "suppli": 3, "nifti1imag": [3, 7], "transform": 3, "nx4x4": 3, "str": [3, 5, 6], "option": [3, 5, 6], "string": [3, 7], "specifi": [3, 7, 9], "which": [3, 7, 9], "save": [3, 7], "nii_t_img": 3, "type": [3, 4, 5, 6, 7], "model": [4, 9, 10], "algorithm": 4, "realign": [4, 5, 6], "data": [4, 5, 6, 7, 9, 10], "eddymotionestim": [4, 9], "rigid": 4, "bodi": 4, "head": [4, 10], "motion": [4, 10], "deriv": [4, 10], "eddi": [4, 10], "current": [4, 10], "static": [4, 5, 6], "fit": [4, 5, 6, 9], "dwdata": 4, "align_kwarg": 4, "b0": 4, "omp_nthread": 4, "n_job": [4, 6], "seed": 4, "target": 4, "tool": 4, "": [4, 5, 6, 7, 10], "intern": 4, "us": [4, 7, 8, 10, 11], "place": 4, "its": 4, "properti": 4, "well": 4, "rotat": [4, 7], "within": [4, 9, 10], "n_iter": 4, "iter": 4, "particular": 4, "go": 4, "repeat": 4, "dict": [4, 7], "configur": 4, "imag": [4, 5, 6, 7, 10], "registr": [4, 10], "process": [4, 10], "select": 4, "gener": [4, 8, 9, 10], "see": [4, 6], "modelfactori": [4, 5, 6, 9], "allow": 4, "keyword": [4, 7], "maximum": [4, 7], "thread": 4, "individu": 4, "mai": 4, "parallel": 4, "job": 4, "random": 4, "necessari": 4, "when": 4, "we": [4, 9], "want": 4, "determinist": 4, "4": [4, 7, 10], "matric": 4, "encod": 4, "deform": [4, 10], "caus": 4, "averagedwmodel": [5, 6, 9], "trivial": [5, 6], "calcul": [5, 6, 7], "predict": [5, 6, 9, 10], "dkimodel": [5, 6, 9], "gtab": [5, 6, 7], "s0": [5, 6], "mask": [5, 6, 7], "b_max": [5, 6], "basemodel": [5, 6, 9], "wrapper": [5, 6], "dipi": [5, 6, 10, 11], "reconst": [5, 6], "dki": [5, 6, 8], "diffusionkurtosismodel": [5, 6], "dtimodel": [5, 6, 9], "dti": [5, 6, 8, 10], "tensormodel": [5, 6], "factori": [5, 6], "instanti": [5, 6], "init": [5, 6, 9], "instati": [5, 6], "averagedw": [5, 6], "compliant": [5, 6], "interfac": [5, 6, 10], "reconstmodel": [5, 6], "petmodel": [5, 6, 9], "xlim": [5, 6], "n_ctrl": [5, 6], "spline": [5, 6], "approxim": [5, 6], "arg": [5, 6, 7], "trivialb0model": [5, 6, 9], "alwai": [5, 6], "do": [5, 6, 9], "adapt": [6, 7], "defin": 6, "default": 6, "method": [6, 8, 9, 10], "implement": [6, 8, 10], "instead": [6, 7], "inherit": 6, "abstract": 6, "follow": [6, 8, 11], "principl": 6, "easier": 6, "maintain": [6, 9], "http": [6, 9], "www": [6, 9], "youtub": 6, "com": 6, "watch": 6, "v": [6, 7], "3mnvp9": 6, "hglc": 6, "chunk": 6, "asynchron": 6, "signal": 6, "draw_circl": [7, 9], "posit": 7, "radiu": 7, "n_sampl": 7, "20": 7, "draw": 7, "circular": 7, "patch": [7, 9], "ly": 7, "sphere": 7, "given": 7, "emmanuel": 7, "caruy": 7, "code": [7, 9], "distribut": 7, "under": [7, 9], "revis": 7, "bsd": 7, "licens": [7, 8], "copyright": 7, "c": [7, 9, 11], "2013": 7, "2015": 7, "all": [7, 9, 11], "right": 7, "reserv": 7, "modifi": 7, "take": 7, "full": 7, "normal": 7, "bvec": 7, "circl": 7, "radii": 7, "specif": [7, 9], "shell": [7, 10], "n": 7, "cartesian": 7, "singl": [7, 10], "plot": [7, 8], "draw_point": [7, 9], "ax": 7, "rad_min": 7, "rad_max": 7, "7": [7, 10, 11], "cmap": 7, "viridi": 7, "input": 7, "scale": 7, "proport": 7, "invers": 7, "bval": 7, "minimum": 7, "maxim": 7, "can": [7, 11], "ar": [7, 9, 11], "drawn": 7, "onc": 7, "loop": 7, "over": 7, "variabl": 7, "have": [7, 9], "been": 7, "renam": 7, "like": 7, "vect": 7, "shape": 7, "matplotlib": 7, "axi": 7, "instanc": 7, "between": [7, 10], "render": [7, 10], "pyplot": 7, "cm": 7, "colormap": 7, "name": [7, 8], "get_segment_label": [7, 9], "delimit": 7, "index_posit": 7, "label_posit": 7, "segment": 7, "label": 7, "plot_carpet": [7, 9], "function": [7, 9, 11], "path": 7, "text": 7, "freesurf": 7, "group": 7, "togeth": 7, "g": 7, "cerebral_white_matt": 7, "cerebral_cortex": 7, "ventricl": 7, "2": [7, 8, 9, 10], "41": 7, "42": 7, "14": 7, "15": 7, "43": 7, "72": 7, "sort_by_bv": 7, "output_fil": 7, "segment_label": 7, "detrend": 7, "carpet": 7, "niworkflow": 7, "carpet_plot": 7, "dw": 7, "gradientt": 7, "flag": 7, "reorder": 7, "point": 7, "bvalu": 7, "dictionari": 7, "integ": 7, "gridspec": 7, "plot_dwi": [7, 9], "titl": 7, "space": [7, 10], "05": 7, "unit": 7, "color": 7, "multipl": [7, 10], "custom": 7, "figur": 7, "adjust": 7, "extra": 7, "rotation_matrix": [7, 9], "u": 7, "matrix": 7, "r": [7, 10], "cdot": 7, "mathbf": 7, "extract": 7, "onli": [7, 9], "minim": 7, "leverag": 7, "first": [8, 9], "releas": [8, 9], "more": [8, 10], "complet": 8, "deploy": 8, "cycl": 8, "fix": 8, "bad": 8, "argument": 8, "33": 8, "consist": 8, "30": 8, "enh": 8, "add": 8, "credit": 8, "system": 8, "32": 8, "27": 8, "stylist": 8, "suggest": 8, "maint": 8, "main": [8, 9], "upstream": 8, "niprep": [8, 9], "eddymotioncorrect": 8, "eddymot": [9, 11], "project": 9, "commun": 9, "guidelin": 9, "befor": 9, "delv": 9, "pleas": 9, "make": [9, 11], "sure": [9, 11], "you": 9, "offer": 9, "onlin": 9, "found": 9, "doc": 9, "folder": 9, "build": [9, 10], "archiv": 9, "gh": 9, "page": 9, "branch": 9, "repositori": 9, "With": 9, "github": 9, "post": 9, "org": 9, "version": 9, "store": 9, "git": 9, "tag": 9, "major": 9, "minor": 9, "everi": 9, "In": 9, "other": 9, "word": 9, "tree": 9, "latest": 9, "x": 9, "seri": 9, "commit": 9, "merg": 9, "too": 9, "automat": 9, "action": 9, "manual": 9, "To": 9, "local": 9, "need": [9, 10], "setuptools_scm": 9, "toml": 9, "6": 9, "instal": [9, 10], "your": [9, 11], "environ": [9, 11], "cd": 9, "python": [9, 11], "m": [9, 10, 11], "src": 9, "_version": 9, "py": 9, "html": 9, "inform": 9, "packag": [9, 10], "submodul": 9, "estim": [9, 10], "viz": [9, 10], "mri": 10, "retrospect": 10, "weight": 10, "acquir": 10, "experi": 10, "exception": 10, "challenging1": 10, "includ": 10, "high": 10, "These": 10, "1000": 10, "mm2": 10, "enabl": 10, "higher": 10, "angular": 10, "resolut": 10, "compar": 10, "tradit": 10, "tensor": 10, "scheme": 10, "gaussian": 10, "besid": 10, "less": 10, "ha": 10, "advantag": 10, "implicitli": 10, "due": 10, "recent": 10, "cieslak": 10, "et": 10, "al": 10, "integr": 10, "both": 10, "approach": 10, "shorelin": 10, "up": 10, "framework": 10, "ii": 10, "replac": 10, "purpos": 10, "shore": 10, "open": 10, "correct": 10, "upon": 10, "work": 10, "while": 10, "multi": 10, "spectrum": 10, "avail": 10, "5": 10, "ben": 10, "amitai": 10, "magnet": 10, "reson": 10, "medicin": 10, "67": 10, "1694": 10, "1702": 10, "2012": 10, "j": 10, "l": 10, "andersson": 10, "off": 10, "effect": 10, "subject": 10, "movement": 10, "mr": 10, "neuroimag": 10, "125": 10, "2016": 10, "1063": 10, "1078": 10, "qsiprep": 10, "platform": 10, "preprocess": 10, "reconstruct": 10, "natur": 10, "18": 10, "775": 10, "778": 10, "2021": 10, "ozarslan": 10, "simpl": 10, "harmon": 10, "oscil": 10, "three": 10, "dimension": 10, "q": 10, "proc": 10, "intl": 10, "soc": 10, "mag": 10, "med": 10, "vol": 10, "17": 10, "1396": 10, "2009": 10, "garyfallidi": 10, "librari": 10, "analysi": 10, "front": 10, "neuroinformat": 10, "8": 10, "2014": 10, "extern": 10, "depend": 10, "For": 10, "develop": 10, "contribut": 10, "document": 10, "api": 10, "applic": 10, "program": 10, "what": 10, "new": 10, "april": 10, "12": 10, "On": 11, "abov": 11, "pip": 11, "habitu": 11, "command": 11, "check": 11, "line": 11, "import": 11, "__version__": 11, "print": 11, "requir": 11, "ant": 11}, "objects": {"eddymotion": [[0, 0, 0, "-", "data"], [4, 0, 0, "-", "estimator"], [5, 0, 0, "-", "model"], [7, 0, 0, "-", "viz"]], "eddymotion.data": [[1, 0, 0, "-", "dmri"], [2, 0, 0, "-", "pet"], [3, 0, 0, "-", "utils"]], "eddymotion.data.dmri": [[1, 1, 1, "", "DWI"], [1, 4, 1, "", "load"]], "eddymotion.data.dmri.DWI": [[1, 2, 1, "", "affine"], [1, 2, 1, "", "brainmask"], [1, 2, 1, "", "bzero"], [1, 2, 1, "", "dataobj"], [1, 2, 1, "", "em_affines"], [1, 2, 1, "", "fieldmap"], [1, 3, 1, "", "from_filename"], [1, 2, 1, "", "gradients"], [1, 3, 1, "", "logo_split"], [1, 3, 1, "", "plot_gradients"], [1, 3, 1, "", "plot_mosaic"], [1, 3, 1, "", "set_transform"], [1, 3, 1, "", "to_filename"], [1, 3, 1, "", "to_nifti"]], "eddymotion.data.pet": [[2, 1, 1, "", "PET"], [2, 4, 1, "", "load"]], "eddymotion.data.pet.PET": [[2, 2, 1, "", "affine"], [2, 2, 1, "", "brainmask"], [2, 2, 1, "", "dataobj"], [2, 2, 1, "", "em_affines"], [2, 2, 1, "", "frame_time"], [2, 3, 1, "", "from_filename"], [2, 3, 1, "", "set_transform"], [2, 3, 1, "", "to_filename"], [2, 3, 1, "", "to_nifti"], [2, 2, 1, "", "total_duration"]], "eddymotion.data.utils": [[3, 4, 1, "", "apply_affines"]], "eddymotion.estimator": [[4, 1, 1, "", "EddyMotionEstimator"]], "eddymotion.estimator.EddyMotionEstimator": [[4, 3, 1, "", "fit"]], "eddymotion.model": [[5, 1, 1, "", "AverageDWModel"], [5, 1, 1, "", "DKIModel"], [5, 1, 1, "", "DTIModel"], [5, 1, 1, "", "ModelFactory"], [5, 1, 1, "", "PETModel"], [5, 1, 1, "", "TrivialB0Model"], [6, 0, 0, "-", "base"]], "eddymotion.model.AverageDWModel": [[5, 3, 1, "", "fit"], [5, 3, 1, "", "predict"]], "eddymotion.model.ModelFactory": [[5, 3, 1, "", "init"]], "eddymotion.model.PETModel": [[5, 3, 1, "", "fit"], [5, 3, 1, "", "predict"]], "eddymotion.model.TrivialB0Model": [[5, 3, 1, "", "fit"], [5, 3, 1, "", "predict"]], "eddymotion.model.base": [[6, 1, 1, "", "AverageDWModel"], [6, 1, 1, "", "BaseModel"], [6, 1, 1, "", "DKIModel"], [6, 1, 1, "", "DTIModel"], [6, 1, 1, "", "ModelFactory"], [6, 1, 1, "", "PETModel"], [6, 1, 1, "", "TrivialB0Model"]], "eddymotion.model.base.AverageDWModel": [[6, 3, 1, "", "fit"], [6, 3, 1, "", "predict"]], "eddymotion.model.base.BaseModel": [[6, 3, 1, "", "fit"], [6, 3, 1, "", "predict"]], "eddymotion.model.base.ModelFactory": [[6, 3, 1, "", "init"]], "eddymotion.model.base.PETModel": [[6, 3, 1, "", "fit"], [6, 3, 1, "", "predict"]], "eddymotion.model.base.TrivialB0Model": [[6, 3, 1, "", "fit"], [6, 3, 1, "", "predict"]], "eddymotion.viz": [[7, 4, 1, "", "draw_circles"], [7, 4, 1, "", "draw_points"], [7, 4, 1, "", "get_segment_labels"], [7, 4, 1, "", "plot_carpet"], [7, 4, 1, "", "plot_dwi"], [7, 4, 1, "", "plot_gradients"], [7, 4, 1, "", "rotation_matrix"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"]}, "titleterms": {"eddymot": [0, 1, 2, 3, 4, 5, 6, 7, 10], "data": [0, 1, 2, 3], "packag": [0, 5], "submodul": [0, 5], "dmri": 1, "modul": [1, 2, 3, 4, 6, 7], "pet": 2, "util": 3, "estim": 4, "model": [5, 6], "base": 6, "viz": 7, "list": 7, "chang": 7, "what": 8, "": 8, "new": 8, "0": 8, "1": 8, "4": 8, "april": 8, "12": 8, "2021": 8, "For": 9, "develop": 9, "contribut": 9, "document": 9, "librari": 9, "api": 9, "applic": 9, "program": 9, "interfac": 9, "content": 10, "instal": 11, "extern": 11, "depend": 11}, "envversion": {"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, "sphinx": 60}, "alltitles": {"eddymotion.data package": [[0, "module-eddymotion.data"]], "Submodules": [[0, "submodules"], [5, "submodules"]], "eddymotion.data.dmri module": [[1, "module-eddymotion.data.dmri"]], "eddymotion.data.pet module": [[2, "module-eddymotion.data.pet"]], "eddymotion.data.utils module": [[3, "module-eddymotion.data.utils"]], "eddymotion.estimator module": [[4, "module-eddymotion.estimator"]], "eddymotion.model package": [[5, "module-eddymotion.model"]], "eddymotion.model.base module": [[6, "module-eddymotion.model.base"]], "eddymotion.viz module": [[7, "module-eddymotion.viz"]], "List of changes": [[7, null], [7, null], [7, null]], "What\u2019s new?": [[8, "what-s-new"]], "0.1.4 (April 12, 2021)": [[8, "april-12-2021"]], "For developers": [[9, "for-developers"]], "Contributing": [[9, "contributing"]], "Documentation": [[9, "documentation"]], "Library API (application program interface)": [[9, "library-api-application-program-interface"]], "Eddymotion": [[10, "eddymotion"]], "Contents": [[10, "contents"]], "Installation": [[11, "id1"]], "External Dependencies": [[11, "external-dependencies"]]}, "indexentries": {"eddymotion.data": [[0, "module-eddymotion.data"]], "module": [[0, "module-eddymotion.data"], [1, "module-eddymotion.data.dmri"], [2, "module-eddymotion.data.pet"], [3, "module-eddymotion.data.utils"], [4, "module-eddymotion.estimator"], [5, "module-eddymotion.model"], [6, "module-eddymotion.model.base"], [7, "module-eddymotion.viz"]], "dwi (class in eddymotion.data.dmri)": [[1, "eddymotion.data.dmri.DWI"]], "affine (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.affine"]], "brainmask (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.brainmask"]], "bzero (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.bzero"]], "dataobj (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.dataobj"]], "eddymotion.data.dmri": [[1, "module-eddymotion.data.dmri"]], "em_affines (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.em_affines"]], "fieldmap (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.fieldmap"]], "from_filename() (eddymotion.data.dmri.dwi class method)": [[1, "eddymotion.data.dmri.DWI.from_filename"]], "gradients (eddymotion.data.dmri.dwi attribute)": [[1, "eddymotion.data.dmri.DWI.gradients"]], "load() (in module eddymotion.data.dmri)": [[1, "eddymotion.data.dmri.load"]], "logo_split() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.logo_split"]], "plot_gradients() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.plot_gradients"]], "plot_mosaic() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.plot_mosaic"]], "set_transform() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.set_transform"]], "to_filename() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.to_filename"]], "to_nifti() (eddymotion.data.dmri.dwi method)": [[1, "eddymotion.data.dmri.DWI.to_nifti"]], "pet (class in eddymotion.data.pet)": [[2, "eddymotion.data.pet.PET"]], "affine (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.affine"]], "brainmask (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.brainmask"]], "dataobj (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.dataobj"]], "eddymotion.data.pet": [[2, "module-eddymotion.data.pet"]], "em_affines (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.em_affines"]], "frame_time (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.frame_time"]], "from_filename() (eddymotion.data.pet.pet class method)": [[2, "eddymotion.data.pet.PET.from_filename"]], "load() (in module eddymotion.data.pet)": [[2, "eddymotion.data.pet.load"]], "set_transform() (eddymotion.data.pet.pet method)": [[2, "eddymotion.data.pet.PET.set_transform"]], "to_filename() (eddymotion.data.pet.pet method)": [[2, "eddymotion.data.pet.PET.to_filename"]], "to_nifti() (eddymotion.data.pet.pet method)": [[2, "eddymotion.data.pet.PET.to_nifti"]], "total_duration (eddymotion.data.pet.pet attribute)": [[2, "eddymotion.data.pet.PET.total_duration"]], "apply_affines() (in module eddymotion.data.utils)": [[3, "eddymotion.data.utils.apply_affines"]], "eddymotion.data.utils": [[3, "module-eddymotion.data.utils"]], "eddymotionestimator (class in eddymotion.estimator)": [[4, "eddymotion.estimator.EddyMotionEstimator"]], "eddymotion.estimator": [[4, "module-eddymotion.estimator"]], "fit() (eddymotion.estimator.eddymotionestimator static method)": [[4, "eddymotion.estimator.EddyMotionEstimator.fit"]], "averagedwmodel (class in eddymotion.model)": [[5, "eddymotion.model.AverageDWModel"]], "dkimodel (class in eddymotion.model)": [[5, "eddymotion.model.DKIModel"]], "dtimodel (class in eddymotion.model)": [[5, "eddymotion.model.DTIModel"]], "modelfactory (class in eddymotion.model)": [[5, "eddymotion.model.ModelFactory"]], "petmodel (class in eddymotion.model)": [[5, "eddymotion.model.PETModel"]], "trivialb0model (class in eddymotion.model)": [[5, "eddymotion.model.TrivialB0Model"]], "eddymotion.model": [[5, "module-eddymotion.model"]], "fit() (eddymotion.model.averagedwmodel method)": [[5, "eddymotion.model.AverageDWModel.fit"]], "fit() (eddymotion.model.petmodel method)": [[5, "eddymotion.model.PETModel.fit"]], "fit() (eddymotion.model.trivialb0model method)": [[5, "eddymotion.model.TrivialB0Model.fit"]], "init() (eddymotion.model.modelfactory static method)": [[5, "eddymotion.model.ModelFactory.init"]], "predict() (eddymotion.model.averagedwmodel method)": [[5, "eddymotion.model.AverageDWModel.predict"]], "predict() (eddymotion.model.petmodel method)": [[5, "eddymotion.model.PETModel.predict"]], "predict() (eddymotion.model.trivialb0model method)": [[5, "eddymotion.model.TrivialB0Model.predict"]], "averagedwmodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.AverageDWModel"]], "basemodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.BaseModel"]], "dkimodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.DKIModel"]], "dtimodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.DTIModel"]], "modelfactory (class in eddymotion.model.base)": [[6, "eddymotion.model.base.ModelFactory"]], "petmodel (class in eddymotion.model.base)": [[6, "eddymotion.model.base.PETModel"]], "trivialb0model (class in eddymotion.model.base)": [[6, "eddymotion.model.base.TrivialB0Model"]], "eddymotion.model.base": [[6, "module-eddymotion.model.base"]], "fit() (eddymotion.model.base.averagedwmodel method)": [[6, "eddymotion.model.base.AverageDWModel.fit"]], "fit() (eddymotion.model.base.basemodel method)": [[6, "eddymotion.model.base.BaseModel.fit"]], "fit() (eddymotion.model.base.petmodel method)": [[6, "eddymotion.model.base.PETModel.fit"]], "fit() (eddymotion.model.base.trivialb0model method)": [[6, "eddymotion.model.base.TrivialB0Model.fit"]], "init() (eddymotion.model.base.modelfactory static method)": [[6, "eddymotion.model.base.ModelFactory.init"]], "predict() (eddymotion.model.base.averagedwmodel method)": [[6, "eddymotion.model.base.AverageDWModel.predict"]], "predict() (eddymotion.model.base.basemodel method)": [[6, "eddymotion.model.base.BaseModel.predict"]], "predict() (eddymotion.model.base.petmodel method)": [[6, "eddymotion.model.base.PETModel.predict"]], "predict() (eddymotion.model.base.trivialb0model method)": [[6, "eddymotion.model.base.TrivialB0Model.predict"]], "draw_circles() (in module eddymotion.viz)": [[7, "eddymotion.viz.draw_circles"]], "draw_points() (in module eddymotion.viz)": [[7, "eddymotion.viz.draw_points"]], "eddymotion.viz": [[7, "module-eddymotion.viz"]], "get_segment_labels() (in module eddymotion.viz)": [[7, "eddymotion.viz.get_segment_labels"]], "plot_carpet() (in module eddymotion.viz)": [[7, "eddymotion.viz.plot_carpet"]], "plot_dwi() (in module eddymotion.viz)": [[7, "eddymotion.viz.plot_dwi"]], "plot_gradients() (in module eddymotion.viz)": [[7, "eddymotion.viz.plot_gradients"]], "rotation_matrix() (in module eddymotion.viz)": [[7, "eddymotion.viz.rotation_matrix"]]}}) \ No newline at end of file