Skip to content

Commit de72651

Browse files
effigieseffigies
committed
Merge tag '23.2.0'
23.2.0 (January 10, 2024) New feature release in the 23.2.x series. This release wraps up a significant refactor of fMRIPrep. The main new features can be used with the ``--level`` and ``--derivatives`` flags. The ``--level`` flag can take the arguments ``minimal``, ``resampling`` or ``full``. The default is ``full``, which should produce nearly the same results as previous versions. ``minimal`` will produce only the minimum necessary to deterministically generate the remaining derivatives. ``resampling`` will produce some additional derivatives, intended to simplify resampling with other tools. The ``--derivatives`` flag takes arguments of the form ``name=/path/to/dir``, for example ``--derivatives anat=$SMRIPREP_DIR``. If provided, fMRIPrep will read the specified directories for pre-computed derivatives. If a derivative is found, it will be used instead of computing it from scratch. If a derivative is not found, fMRIPrep will compute it and proceed as usual. Taken together, these features can allow a dataset provider to run a minimal fMRIPrep run, targeting many output spaces, while a user can then run a ``--derivatives`` run to generate additional derivatives in only the output spaces they need. Another use case is to provide an precomputed derivative to override the default fMRIPrep behavior, enabling easier workarounds for bugs or experimentation with alternatives. Additionally, this release includes a number of bug fixes and improvements. This release adds support for MSM-Sulc, improving the alignment of subject surfaces to the fsLR template. This process is enabled by default, but may be disabled with the ``--no-msm`` flag. This release resolves a number of issues with fieldmaps inducing distortions during correction. Phase difference and direct fieldmaps are now masked correctly, preventing the overestimation of distortions outside the brain. Additionally, we now implement Jacobian weighting during unwarping, which corrects for compression and expansion effects on signal intensity. To disable Jacobian weighting, use ``--ignore fmap-jacobian``. Finally, a new resampling method has been added, to better account for susceptibility distortion and motion in a single shot resampling to a volumetric target space. We anticipate extending this to surface targets in the future. * FIX: Restore --ignore sbref functionality (#3180) * FIX: Retrieve atlas ROIs at requested density (#3179) * FIX: Keep minctracc executable in FreeSurfer installation (#3175) * FIX: Exclude echo entity from optimally combined derivatives (#3166) * FIX: Disable boldref-space outputs unless requested (#3159) * FIX: Tag memory estimates in resamplers (#3150) * FIX: Final revisions for next branch (#3134) * FIX: Minor fixes to work with MSMSulc-enabled smriprep-next (#3098) * FIX: Connect EPI-to-fieldmap transform (#3099) * FIX: Use Py2-compatible version file template for fmriprep-docker (#3101) * FIX: Update connections to unwarp_wf, convert ITK transforms to text (#3077) * ENH: Allow --ignore fmap-jacobian to disable Jacobian determinant modulation during fieldmap correction (#3186) * ENH: Exclude non-steady-state volumes from confound correlation plot (#3171) * ENH: Pass FLAIR images to anatomical workflow builder to include in boilerplate (#3146) * ENH: Restore carpetplot and other final adjustments (#3131) * ENH: Restore CIFTI-2 generation (#3129) * ENH: Restore resampling to surface GIFTIs (#3126) * ENH: Restore confound generation (#3120) * ENH: Restore resampling BOLD to volumetric templates (#3121) * ENH: Restore resampling to T1w target (#3116) * ENH: Add MSMSulc (#3085) * ENH: Add reporting workflow for BOLD fit (#3082) * ENH: Generate anatomical derivatives useful for resampling (#3081) * RF: Load reportlets interfaces from nireports rather than niworkflows (#3176, #3184) * RF: Separate goodvoxels mask creation from fsLR resampling (#3170) * RF: Write out anatomical template derivatives (#3136) * RF: Update primary bold workflow to incorporate single shot resampling (#3114) * RF: Update derivative cache spec, calculate per-BOLD, reuse boldref2fmap (#3078) * RF: Split fMRIPrep into fit and derivatives workflows (#2913) * RPT: Rename CSF/WM confounds in fMRIPlot (#3172) * TST: Add smoke tests for full workflow and most branching flags (#3155) * TST: Add smoke-tests for bold_fit_wf (#3152) * DOC: Fix documentation and description for init_bold_grayords_wf (#3051) * DOC: Minor updates in outputs.rst (#3148) * STY: Apply a couple refurb suggestions (#3151) * STY: Fix flake8 warnings (#3044) * STY: Apply pyupgrade suggestions (#3043) * MNT: Restore mritotal subcommands to Dockerfile (#3149) * MNT: Update smriprep to 0.13.1 (#3153) * MNT: optimise size of PNG files (#3145) * MNT: update vendored docs script ``github_link.py`` (#3144) * MNT: Update tedana pin, test on Python 3.12 (#3141) * MNT: Bump environment (#3132) * MNT: Bump version requirements (#3107) * MNT: http:// → https:// (#3097) * MNT: Remove mritotal and dependencies from FreeSurfer ignore file (#3090) * MNT: Update environment (#3073) * MNT: Depend on newer sphinx (#3067) * MNT: Install ANTs from conda-forge (#3061) * MNT: Drop Python 3.8 and numpy 1.21 support (NEP29) (#3052) * MNT: update update_zenodo.py script (#3042) * MNT: Fix welcome message formatting and instructions (#3039) * MNT: Python 3.11 should be supported (#3038) * CI: Bump actions/setup-python from 4 to 5 (#3181) * CI: Stop testing legacy layout (#3079) * CI: Improve tag detection for docker builds (#3066) * CI: Clean up pre-release builds (#3040)
2 parents 24002ef + 8b3a957 commit de72651

File tree

5 files changed

+83
-47
lines changed

5 files changed

+83
-47
lines changed

‎.maint/CONTRIBUTORS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Before every release, unlisted contributors will be invited again to add their n
3232
| Liem | Franz | | 0000-0003-0646-4810 | URPP Dynamics of Healthy Aging, University of Zurich |
3333
| Lurie | Daniel J. | | 0000-0001-8012-6399 | Department of Psychology, University of California, Berkeley |
3434
| Ma | Feilong | | 0000-0002-6838-3971 | Dartmouth College: Hanover, NH, United States |
35+
| Madison | Thomas | | 0000-0003-3030-6580 | Department of Pediatrics, University of Minnesota, MN, USA |
3536
| Mentch | Jeff | | 0000-0002-7762-8678 | Speech & Hearing Bioscience & Technology Program, Harvard University |
3637
| Moodie | Craig A. | | 0000-0003-0867-1469 | Department of Psychology, Stanford University |
3738
| Naveau | Mikaël | | 0000-0001-6948-9068 | Cyceron, UMS 3408 (CNRS - UCBN), France |

‎.zenodo.json‎

Lines changed: 51 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,24 @@
88
"orcid": "0000-0002-1668-9629",
99
"type": "Researcher"
1010
},
11+
{
12+
"affiliation": "Department of Pediatrics, University of Minnesota, MN, USA",
13+
"name": "Madison, Thomas",
14+
"orcid": "0000-0003-3030-6580",
15+
"type": "Researcher"
16+
},
1117
{
1218
"affiliation": "Florey Institute of Neuroscience and Mental Health",
1319
"name": "Smith, Robert E.",
1420
"orcid": "0000-0003-3636-4642",
1521
"type": "Researcher"
1622
},
23+
{
24+
"affiliation": "Neurospin, CEA",
25+
"name": "Papadopoulos, Dimitri",
26+
"orcid": "0000-0002-1242-8990",
27+
"type": "Researcher"
28+
},
1729
{
1830
"affiliation": "Centre for Modern Interdisciplinary Technologies, Nicolaus Copernicus University in Toruń",
1931
"name": "Finc, Karolina",
@@ -26,18 +38,6 @@
2638
"orcid": "0000-0002-6533-2909",
2739
"type": "Researcher"
2840
},
29-
{
30-
"affiliation": "Neurospin, CEA",
31-
"name": "Papadopoulos, Dimitri",
32-
"orcid": "0000-0002-1242-8990",
33-
"type": "Researcher"
34-
},
35-
{
36-
"affiliation": "Dartmouth College: Hanover, NH, United States",
37-
"name": "Halchenko, Yaroslav O.",
38-
"orcid": "0000-0003-3456-2493",
39-
"type": "Researcher"
40-
},
4141
{
4242
"affiliation": "Department of Neuroscience, University of Pennsylvania, PA, USA",
4343
"name": "Tooley, Ursula A.",
@@ -51,9 +51,9 @@
5151
"type": "Researcher"
5252
},
5353
{
54-
"affiliation": "University of Texas at Austin",
55-
"name": "de la Vega, Alejandro",
56-
"orcid": "0000-0001-9062-3778",
54+
"affiliation": "Dartmouth College: Hanover, NH, United States",
55+
"name": "Halchenko, Yaroslav O.",
56+
"orcid": "0000-0003-3456-2493",
5757
"type": "Researcher"
5858
},
5959
{
@@ -63,9 +63,9 @@
6363
"type": "Researcher"
6464
},
6565
{
66-
"affiliation": "Montreal Neurological Institute, McGill University",
67-
"name": "Urchs, Sebastian",
68-
"orcid": "0000-0001-5504-8579",
66+
"affiliation": "University of Texas at Austin",
67+
"name": "de la Vega, Alejandro",
68+
"orcid": "0000-0001-9062-3778",
6969
"type": "Researcher"
7070
},
7171
{
@@ -75,9 +75,15 @@
7575
"type": "Researcher"
7676
},
7777
{
78-
"affiliation": "Charite Universitatsmedizin Berlin, Germany",
79-
"name": "Waller, Lea",
80-
"orcid": "0000-0002-3239-6957",
78+
"affiliation": "Montreal Neurological Institute, McGill University",
79+
"name": "Urchs, Sebastian",
80+
"orcid": "0000-0001-5504-8579",
81+
"type": "Researcher"
82+
},
83+
{
84+
"affiliation": "Machine Learning Team, National Institute of Mental Health, USA",
85+
"name": "Nielson, Dylan M.",
86+
"orcid": "0000-0003-4613-6643",
8187
"type": "Researcher"
8288
},
8389
{
@@ -86,6 +92,12 @@
8692
"orcid": "0000-0002-2050-0614",
8793
"type": "Researcher"
8894
},
95+
{
96+
"affiliation": "Charite Universitatsmedizin Berlin, Germany",
97+
"name": "Waller, Lea",
98+
"orcid": "0000-0002-3239-6957",
99+
"type": "Researcher"
100+
},
89101
{
90102
"affiliation": "Speech & Hearing Bioscience & Technology Program, Harvard University",
91103
"name": "Mentch, Jeff",
@@ -98,12 +110,6 @@
98110
"orcid": "0000-0001-8012-6399",
99111
"type": "Researcher"
100112
},
101-
{
102-
"affiliation": "Department of Psychology, Columbia University",
103-
"name": "Jacoby, Nir",
104-
"orcid": "0000-0001-7936-9991",
105-
"type": "Researcher"
106-
},
107113
{
108114
"affiliation": "Computational Neuroimaging Lab, BioCruces Health Research Institute",
109115
"name": "Erramuzpe, Asier",
@@ -194,6 +200,18 @@
194200
"orcid": "0000-0002-1652-9297",
195201
"type": "Researcher"
196202
},
203+
{
204+
"affiliation": "Department of Psychology, Columbia University",
205+
"name": "Jacoby, Nir",
206+
"orcid": "0000-0001-7936-9991",
207+
"type": "Researcher"
208+
},
209+
{
210+
"affiliation": "Department of Psychology, University of Washington",
211+
"name": "Kruper, John",
212+
"orcid": "0000-0003-0081-391X",
213+
"type": "Researcher"
214+
},
197215
{
198216
"affiliation": "URPP Dynamics of Healthy Aging, University of Zurich",
199217
"name": "Liem, Franz",
@@ -301,19 +319,19 @@
301319
"orcid": "0000-0002-1668-9629"
302320
},
303321
{
304-
"affiliation": "Montreal Neurological Institute, McGill University",
305-
"name": "DuPre, Elizabeth",
306-
"orcid": "0000-0003-1358-196X"
322+
"affiliation": "Department of Psychology, Florida International University",
323+
"name": "Salo, Taylor",
324+
"orcid": "0000-0001-9813-3167"
307325
},
308326
{
309327
"affiliation": "Neuroscience Program, University of Iowa",
310328
"name": "Kent, James D.",
311329
"orcid": "0000-0002-4892-2659"
312330
},
313331
{
314-
"affiliation": "Department of Psychology, Florida International University",
315-
"name": "Salo, Taylor",
316-
"orcid": "0000-0001-9813-3167"
332+
"affiliation": "Montreal Neurological Institute, McGill University",
333+
"name": "DuPre, Elizabeth",
334+
"orcid": "0000-0003-1358-196X"
317335
},
318336
{
319337
"affiliation": "Department of Psychology, Stanford University",
@@ -330,11 +348,6 @@
330348
"name": "Blair, Ross W.",
331349
"orcid": "0000-0003-3007-1056"
332350
},
333-
{
334-
"affiliation": "Machine Learning Team, National Institute of Mental Health",
335-
"name": "Nielson, Dylan M.",
336-
"orcid": "0000-0003-4613-6643"
337-
},
338351
{
339352
"affiliation": "Department of Psychology, Stanford University",
340353
"name": "Poldrack, Russell A.",

‎CHANGES.rst‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
23.2.0 (To be determined)
1+
23.2.0 (January 10, 2024)
22
=========================
33
New feature release in the 23.2.x series.
44

@@ -33,17 +33,27 @@ This release resolves a number of issues with fieldmaps inducing distortions
3333
during correction. Phase difference and direct fieldmaps are now masked correctly,
3434
preventing the overestimation of distortions outside the brain. Additionally,
3535
we now implement Jacobian weighting during unwarping, which corrects for compression
36-
and expansion effects on signal intensity.
36+
and expansion effects on signal intensity. To disable Jacobian weighting, use
37+
``--ignore fmap-jacobian``.
3738

3839
Finally, a new resampling method has been added, to better account for
3940
susceptibility distortion and motion in a single shot resampling to a volumetric
4041
target space. We anticipate extending this to surface targets in the future.
4142

43+
* FIX: Restore --ignore sbref functionality (#3180)
44+
* FIX: Retrieve atlas ROIs at requested density (#3179)
45+
* FIX: Keep minctracc executable in FreeSurfer installation (#3175)
46+
* FIX: Exclude echo entity from optimally combined derivatives (#3166)
47+
* FIX: Disable boldref-space outputs unless requested (#3159)
48+
* FIX: Tag memory estimates in resamplers (#3150)
4249
* FIX: Final revisions for next branch (#3134)
4350
* FIX: Minor fixes to work with MSMSulc-enabled smriprep-next (#3098)
4451
* FIX: Connect EPI-to-fieldmap transform (#3099)
4552
* FIX: Use Py2-compatible version file template for fmriprep-docker (#3101)
4653
* FIX: Update connections to unwarp_wf, convert ITK transforms to text (#3077)
54+
* ENH: Allow --ignore fmap-jacobian to disable Jacobian determinant modulation during fieldmap correction (#3186)
55+
* ENH: Exclude non-steady-state volumes from confound correlation plot (#3171)
56+
* ENH: Pass FLAIR images to anatomical workflow builder to include in boilerplate (#3146)
4757
* ENH: Restore carpetplot and other final adjustments (#3131)
4858
* ENH: Restore CIFTI-2 generation (#3129)
4959
* ENH: Restore resampling to surface GIFTIs (#3126)
@@ -53,13 +63,25 @@ target space. We anticipate extending this to surface targets in the future.
5363
* ENH: Add MSMSulc (#3085)
5464
* ENH: Add reporting workflow for BOLD fit (#3082)
5565
* ENH: Generate anatomical derivatives useful for resampling (#3081)
66+
* RF: Load reportlets interfaces from nireports rather than niworkflows (#3176, #3184)
67+
* RF: Separate goodvoxels mask creation from fsLR resampling (#3170)
5668
* RF: Write out anatomical template derivatives (#3136)
5769
* RF: Update primary bold workflow to incorporate single shot resampling (#3114)
5870
* RF: Update derivative cache spec, calculate per-BOLD, reuse boldref2fmap (#3078)
5971
* RF: Split fMRIPrep into fit and derivatives workflows (#2913)
72+
* RPT: Rename CSF/WM confounds in fMRIPlot (#3172)
73+
* TST: Add smoke tests for full workflow and most branching flags (#3155)
74+
* TST: Add smoke-tests for bold_fit_wf (#3152)
6075
* DOC: Fix documentation and description for init_bold_grayords_wf (#3051)
76+
* DOC: Minor updates in outputs.rst (#3148)
77+
* STY: Apply a couple refurb suggestions (#3151)
6178
* STY: Fix flake8 warnings (#3044)
6279
* STY: Apply pyupgrade suggestions (#3043)
80+
* MNT: Restore mritotal subcommands to Dockerfile (#3149)
81+
* MNT: Update smriprep to 0.13.1 (#3153)
82+
* MNT: optimise size of PNG files (#3145)
83+
* MNT: update vendored docs script ``github_link.py`` (#3144)
84+
* MNT: Update tedana pin, test on Python 3.12 (#3141)
6385
* MNT: Bump environment (#3132)
6486
* MNT: Bump version requirements (#3107)
6587
* MNT: http:// → https:// (#3097)
@@ -71,6 +93,7 @@ target space. We anticipate extending this to surface targets in the future.
7193
* MNT: update update_zenodo.py script (#3042)
7294
* MNT: Fix welcome message formatting and instructions (#3039)
7395
* MNT: Python 3.11 should be supported (#3038)
96+
* CI: Bump actions/setup-python from 4 to 5 (#3181)
7497
* CI: Stop testing legacy layout (#3079)
7598
* CI: Improve tag detection for docker builds (#3066)
7699
* CI: Clean up pre-release builds (#3040)

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ dependencies = [
3333
"pybids >= 0.15.2",
3434
"requests",
3535
"sdcflows @ git+https://github.com/nipreps/sdcflows.git@master",
36-
"smriprep >= 0.13.1",
36+
"smriprep @ git+https://github.com/nipreps/smriprep.git@master",
3737
"tedana >= 23.0.2",
3838
"templateflow >= 23.0.0",
3939
"toml",

‎requirements.txt‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ importlib-resources==6.1.1
101101
# via
102102
# nireports
103103
# niworkflows
104-
# sdcflows
105104
# templateflow
106105
indexed-gzip==1.8.7
107106
# via smriprep
@@ -165,6 +164,7 @@ matplotlib==3.8.2
165164
migas==0.4.0
166165
# via
167166
# fmriprep
167+
# sdcflows
168168
more-itertools==10.1.0
169169
# via jaraco-classes
170170
msgpack==1.0.7
@@ -302,7 +302,7 @@ psutil==5.9.6
302302
# fmriprep (pyproject.toml)
303303
py-cpuinfo==9.0.0
304304
# via codecarbon
305-
pybids==0.16.3
305+
pybids==0.16.4
306306
# via
307307
# fmriprep
308308
# fmriprep (pyproject.toml)
@@ -382,7 +382,7 @@ scipy==1.11.4
382382
# scikit-learn
383383
# sdcflows
384384
# tedana
385-
sdcflows==2.6.0
385+
sdcflows==2.8.0
386386
# via
387387
# fmriprep
388388
# fmriprep (pyproject.toml)
@@ -393,8 +393,7 @@ seaborn==0.13.0
393393
secretstorage==3.3.3
394394
# via keyring
395395
sentry-sdk==1.39.0
396-
# via
397-
# fmriprep
396+
# via fmriprep
398397
simplejson==3.19.2
399398
# via nipype
400399
six==1.16.0
@@ -434,7 +433,7 @@ tifffile==2023.9.26
434433
toml==0.10.2
435434
# via
436435
# fmriprep
437-
# fmriprep (pyproject.toml)
436+
# sdcflows
438437
tornado==6.3.3
439438
# via bokeh
440439
tqdm==4.66.1

0 commit comments

Comments
 (0)