Skip to content

Commit 013fcd8

Browse files
committed
docs: revise *dMRIPrep*'s road-map
Resolves: #116.
1 parent e832044 commit 013fcd8

File tree

1 file changed

+95
-38
lines changed

1 file changed

+95
-38
lines changed

docs/roadmap.rst

Lines changed: 95 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,127 @@
11
.. include:: links.rst
22

3-
--------------------
4-
Development road map
5-
--------------------
3+
Development road-map
4+
====================
65
This road-map serves as a guide for developers as well as a way for us to
76
communicate to users and other stake-holders aboout the expectations they should
87
have about the current functionality of the software and future developments.
98

10-
Version 0.3 (Targetted for March 1st, 2020)
11-
-------------------------------------------
12-
This version should be considered an early alpha of the software, but will
13-
contain a full pipeline of processing from a raw BIDS dataset to analyzable data.
9+
If you want to be part of the team developing this road-map, please make sure you
10+
take a look into our `Contributors Guidelines <https://www.nipreps.org/community/CONTRIBUTING>`__.
11+
Then, please write one of the developers to be invited to our bi-weekly meetings.
1412

15-
At this point, the processing pipeline will include the following major steps:
13+
This road-map proposes a :abbr:`RERO (release early, release often)` planning, scheduling
14+
a monthly release until the first stable 1.0 release is reached.
1615

17-
#. Susceptibility distortion correction.
18-
Using `SDCFlows <https://github.com/poldracklab/sdcflows>`__
16+
.. important::
1917

20-
#. Signal drift estimation
21-
Leveraging the :math:`b=0` extraction, rescaling and averaging that was merged in `#50 <https://github.com/nipreps/dmriprep/pull/50>`__
18+
Updated: Dec 18, 2020
19+
Latest release: `0.3.0 (October 13, 2020) <changes.html#october-13-2020>`__.
2220

23-
Version 0.4 (April 1st, 2020)
24-
-----------------------------
21+
Version 0.4 (Before end of 2020)
22+
--------------------------------
23+
Version 0.4 will condense all the outcomes of our sprint towards ISMRM's 2021 abstracts deadline.
24+
This mostly includes house-keeping work, and most prominently, the integration of the *SDCFlows* 2.0
25+
alpha releases, which makes *dMRIPrep* go ahead of *fMRIPrep* in addressing distortions caused by
26+
:math:`B_0` inhomogeneity.
27+
28+
This release will also include Salim's efforts in `#144 <https://github.com/nipreps/dmriprep/pull/144>`__
29+
to provide with a temporary implementation of head-motion and Eddy-currents correction using
30+
FSL's ``eddy``.
31+
This temporary solution will be replaced by our 3dSHORE-based algorithm ported from QSIPREP,
32+
and left in place for researchers who prefer this option.
33+
34+
Version 0.5 (January, 2021)
35+
---------------------------
36+
#. Continue with the *SDCFlows 2.0* integration:
37+
38+
- Cover more complex fieldmap specifications
39+
- Automatically set up "*fieldmap-less*" estimations
40+
41+
#. Framewise-displacement (or equivalent) calculation
42+
43+
We will identify volumes that are outliers in terms of head-motion, or other
44+
severe artifacts that make them likely candidates for exclusion from further
45+
analysis.
46+
Regarding the *or equivalent* note above: following with `this conversation
47+
<https://neurostars.org/t/head-motion-parameters-different-when-using-fmriprep-and-spm/17386/4>`__,
48+
it could be interesting to calculate some sort of average displacement of voxels
49+
within the white-matter mask instead.
50+
51+
#. Finalize ongoing PRs about reporting number of shells
52+
53+
- `#73 <https://github.com/nipreps/dmriprep/pull/73>`__
54+
- `#129 <https://github.com/nipreps/dmriprep/pull/129>`__
55+
56+
#. First draft of ISBI 2021 tutorial:
57+
58+
- Accept the design for our ISBI 2021 tutorial and document it on the notebooks repo.
59+
- First draft
60+
- Start development
61+
- Plan for supporting Derek and Ariel in taking the head-motion correction to the finish line.
62+
63+
Version 0.6 (February, 2021)
64+
----------------------------
2565
#. Head motion correction.
2666

2767
A SHOREline-based approach, ported from QSIPREP. In cases where the data are
2868
"shelled", 3dSHORE will be used as the diffusion model. If the data are
2969
single-shell, we will use SFM as the diffusion model.
3070

31-
#. Eddy current correction.
71+
#. :math:`B_1` inhomogeneity correction
3272

33-
We will explore the possible adaptations of the HMC based on SHOREline above.
34-
In cases where the data are "shelled", 3dSHORE will be
35-
used as the diffusion model. If the data are single-shell, we will use SFM
36-
as the diffusion model.
73+
- Decide whether it can be brought around from estimation on T1w images
74+
- Decide whether it should be a default-off option that can be enabled with
75+
a flag, or else, generate both conversions always.
3776

38-
#. Framewise-displacement calculation
77+
#. Initiate Phase I of testing
3978

40-
We will identify volumes that are outliers in terms of head motion, or other
41-
severe artifacts that make them likely candidates for exclusion from further
42-
analysis.
79+
- Compose our test-bed dataset
80+
- Document Phase I testing and reporting protocols
81+
- Start execution
4382

44-
Version 0.5 (May 1st, 2020)
45-
----------------------------
46-
#. Registration between dMRI and T1w image.
83+
# Continue with the development of ISBI 2021 tutorial
84+
85+
Version 0.7 (March, 2021)
86+
-------------------------
87+
The *noisy month*. This is not a musical event, but a development cycle where we will
88+
focus on the implementation of steps addressing noise in DWI:
4789

4890
#. Identification of outlier measurements (+ imputation?)
4991

50-
If we get around to doing thesee steps earlier, they can also be included in
51-
earlier releases.
92+
#. Implementation of component-based noise identification techniques
5293

94+
#. Gibbs-ringing: investigate whether it should be estimated if other techniques
95+
are in place (i.e., component-based above), and ordering of steps.
5396

54-
Version 1.0 (Targetted for September 2020)
55-
------------------------------------------
56-
After integrating the above steps, we will spend the time leading to a 1.0
57-
testing the software on various datasets, evaluating and validating the
58-
resulting derivatives.
97+
#. Rician bias modeling.
98+
99+
#. DWI carpet-plot and confounds collation.
59100

101+
#. Testing Phase I execution
102+
103+
#. Final release of the ISBI 2021 tutorial
104+
105+
Version 0.8 (April, 2021)
106+
-------------------------
107+
This release will only address bugfixes conducive to finishing evaluation Phase I,
108+
which should conform a pretty solid ensemble ready for premiere in ISMRM 2021.
109+
110+
Version 0.9 (May, 2021)
111+
-----------------------
112+
#. First official presentation at ISMRM 2021 (should the abstract be accepted)
113+
#. Evaluation Phase II starts.
114+
115+
- Determine an appropriate dataset
116+
- Plan for benchmarking experiments (`#121 <https://github.com/nipreps/dmriprep/issues/121>`__)
117+
- Start with addressing issues as the are reported
118+
119+
Version 1.0 (Targetted for September 2021)
120+
------------------------------------------
121+
Wrap-up evaluation Phase II with the first stable release of *dMRIPrep*.
60122

61123
Long-term plans
62124
---------------
63125
In the long run we would like to explore the following processing steps:
64126

65-
- Gibbs ringing (using DIPY's image-based implementation).
66-
- Denoising (e.g., MP-PCA)
67-
- Rician bias correction
68127
- Gradient non-linearity correction
69-
- B1 inhomogeneity field estimation and :abbr:`INU (intensity non-uniformity) correction`
70-
- Signal drift correction

0 commit comments

Comments
 (0)