Skip to content

Commit 93632f7

Browse files
committed
Merge tag '24.0.0'
24.0.0 (August 29, 2024) This major release includes a substantial refactoring of the pipeline. One key addition is the addition of the `--level` flag, which 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 was altered to take arguments in the form `name=/path/to/dir`. For each directory provided, if a derivative is found - it will be used instead of computing it from scratch. If a derivative is not found, NiBabies will compute it and proceed as usual. Taken together, these features can allow a dataset provider to run a minimal NiBabies 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 NiBabies behavior, enabling easier workarounds for bugs or experimentation with alternatives. Another new feature is a dynamic anatomical reference, which is set based on surface reconstruction method or through the `--reference-anatomical` flag. Previously, T1w was the default output space. Now, the reference anatomical is determined based on the surface reconstruction method. Additionally, minor adjustments have been made to MCRIBS surface reconstruction to address failure rates. This is still an on-going investigation, but preliminary results look promising. 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, add `fmap-jacobian` to the `--ignore` argument. 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: nest pathlib import in fix_multi_source_name (#365) * FIX: Avoid retrieving multiple templates from latest TF (#353) * FIX: Raise informative error if no t1w or t2w found (#347) * FIX: Easier pyenv usage (#342) * FIX: Catch nonexistent derivatives, clean up subworkflow logic (#336) * FIX: Use fsLR reg sphere for MCRIBS morphometrics resampling (#334) * FIX: T2star map MNI scaling (#320) * ENH: Alter outputs when MCRIBS reconstruction is used (#329) * ENH: Use nireports for Report generation + add reportlet per reconstruction (#328) * ENH: better repr for Derivatives class (#351) * RF: Move to fit/apply workflow (#360) * RF: Replace `resource_filename` with `load_data` (#345) * MAINT: Bump urllib3 from 2.0.3 to 2.0.7 (#319) * MAINT: Raise minimum to 3.10, bump actions (#337) * MAINT: Bump pillow from 9.5.0 to 10.0.1 (#317) * MAINT: Update to latest migas API (#326) * DOC: Use correct argument flag (#338) * DOC: Move to new theme, add outputs description (#383)
2 parents 9529f59 + d207c6f commit 93632f7

File tree

3 files changed

+21
-34
lines changed

3 files changed

+21
-34
lines changed

CHANGES.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,45 @@
1-
24.0.0 (TBD)
2-
============
1+
24.0.0 (August 29, 2024)
2+
========================
33
This major release includes a substantial refactoring of the pipeline.
44

55
One key addition is the addition of the `--level` flag, which 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.
66

77
The `--derivatives` flag was altered to take arguments in the form `name=/path/to/dir`.
88
For each directory provided, if a derivative is found - it will be used instead of computing it from scratch. If a derivative is not found, NiBabies will compute it and proceed as usual.
99

10-
Taken together, these features can allow a dataset provider to run a minimal NiBabies 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 NiBabies behavior, enabling easier workarounds for bugs or experimentation with alternatives.
10+
Taken together, these features can allow a dataset provider to run a minimal NiBabies 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 NiBabies behavior, enabling easier workarounds for bugs or experimentation with alternatives.
1111

12-
Another new feature is a dynamic anatomical reference, which is set based on surface reconstruction method or through the `--reference-anatomical` flag. Previously, T1w was the default output space.
12+
Another new feature is a dynamic anatomical reference, which is set based on surface reconstruction method or through the `--reference-anatomical` flag. Previously, T1w was the default output space. Now, the reference anatomical is determined based on the surface reconstruction method.
1313

1414
Additionally, minor adjustments have been made to MCRIBS surface reconstruction to address failure rates. This is still an on-going investigation, but preliminary results look promising.
1515

1616
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, add `fmap-jacobian` to the `--ignore` argument.
1717

1818
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.
1919

20-
## 24.0.0rc0 (August 01, 2024)
21-
* RF: Move to fit/apply workflow (#360)
2220
* FIX: nest pathlib import in fix_multi_source_name (#365)
2321
* FIX: Avoid retrieving multiple templates from latest TF (#353)
24-
* ENH: better repr for Derivatives class (#351)
2522
* FIX: Raise informative error if no t1w or t2w found (#347)
26-
* Replace `resource_filename` with `load_data` (#345)
2723
* FIX: Easier pyenv usage (#342)
28-
* Build(deps): Bump urllib3 from 2.0.3 to 2.0.7 (#319)
29-
* Build(deps): Bump pillow from 9.5.0 to 10.0.1 (#317)
30-
* DOC: Use correct argument flag (#338)
31-
* MAINT: Raise minimum to 3.10, bump actions (#337)
3224
* FIX: Catch nonexistent derivatives, clean up subworkflow logic (#336)
33-
* Use fsLR reg sphere for MCRIBS morphometrics resampling (#334)
34-
* FIX: Multiple T2ws, coerce reference to string (#333)
35-
36-
## 24.0.0a1
37-
* MAINT: Update to latest migas API (#326)
25+
* FIX: Use fsLR reg sphere for MCRIBS morphometrics resampling (#334)
3826
* FIX: T2star map MNI scaling (#320)
27+
3928
* ENH: Alter outputs when MCRIBS reconstruction is used (#329)
4029
* ENH: Use nireports for Report generation + add reportlet per reconstruction (#328)
30+
* ENH: better repr for Derivatives class (#351)
31+
32+
* RF: Move to fit/apply workflow (#360)
33+
* RF: Replace `resource_filename` with `load_data` (#345)
34+
35+
* MAINT: Bump urllib3 from 2.0.3 to 2.0.7 (#319)
36+
* MAINT: Raise minimum to 3.10, bump actions (#337)
37+
* MAINT: Bump pillow from 9.5.0 to 10.0.1 (#317)
38+
* MAINT: Update to latest migas API (#326)
39+
40+
* DOC: Use correct argument flag (#338)
41+
* DOC: Move to new theme, add outputs description (#383)
42+
4143

4244
23.1.0 (November 22, 2023)
4345
============

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ dependencies = [
3333
"pybids >= 0.15.0",
3434
"requests",
3535
"sdcflows >= 2.10.0",
36-
# "smriprep >= 0.16.0",
37-
"smriprep @ git+https://github.com/nipreps/smriprep.git@master",
36+
"smriprep >= 0.16.1",
3837
"tedana >= 23.0.2",
3938
"templateflow >= 24.2.0",
4039
"toml",

requirements.txt

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ botocore==1.34.150
3434
# s3transfer
3535
certifi==2024.7.4
3636
# via requests
37-
cffi==1.16.0
38-
# via cryptography
3937
chardet==5.2.0
4038
# via datalad
4139
charset-normalizer==3.3.2
@@ -52,8 +50,6 @@ contourpy==1.2.1
5250
# via
5351
# bokeh
5452
# matplotlib
55-
cryptography==43.0.0
56-
# via secretstorage
5753
cycler==0.12.1
5854
# via matplotlib
5955
datalad==1.1.2
@@ -81,8 +77,6 @@ formulaic==0.5.2
8177
# via pybids
8278
fsspec==2024.6.1
8379
# via universal-pathlib
84-
greenlet==3.0.3
85-
# via sqlalchemy
8680
h5py==3.11.0
8781
# via nitransforms
8882
humanize==4.10.0
@@ -115,10 +109,6 @@ jaraco-context==5.3.0
115109
# keyrings-alt
116110
jaraco-functools==4.0.1
117111
# via keyring
118-
jeepney==0.8.0
119-
# via
120-
# keyring
121-
# secretstorage
122112
jinja2==3.1.4
123113
# via
124114
# bokeh
@@ -305,8 +295,6 @@ pybtex==0.24.0
305295
# via tedana
306296
pybtex-apa-style==1.3
307297
# via tedana
308-
pycparser==2.22
309-
# via cffi
310298
pydot==3.0.1
311299
# via nipype
312300
pyparsing==3.1.2
@@ -379,8 +367,6 @@ seaborn==0.13.2
379367
# via
380368
# nireports
381369
# niworkflows
382-
secretstorage==3.3.3
383-
# via keyring
384370
simplejson==3.19.2
385371
# via nipype
386372
six==1.16.0
@@ -389,7 +375,7 @@ six==1.16.0
389375
# osfclient
390376
# pybtex
391377
# python-dateutil
392-
smriprep @ git+https://github.com/nipreps/smriprep.git@master
378+
smriprep==0.16.1
393379
# via nibabies (pyproject.toml)
394380
sqlalchemy==2.0.31
395381
# via pybids

0 commit comments

Comments
 (0)