Skip to content

Commit 4a9ea0c

Browse files
authored
DOC: Fix documentation and description for init_bold_grayords_wf (#3051)
- Update documentation for `init_bold_grayords_wf` Removes mention of inputs that are no longer used (`surf_files` and `surf_refs`). Adds documentation of the new `repetition_time` parameter and `bold_fsLR` input. Additionally, updates the description to clarify that the surface data is transformed directly to fsLR and the surface data is transformed to MNI152NLin6Asym at the appropriate resolution. Resolves #3050.
2 parents 01a13ca + 6d2005d commit 4a9ea0c

File tree

3 files changed

+17
-9
lines changed

3 files changed

+17
-9
lines changed

.maint/CONTRIBUTORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Before every release, unlisted contributors will be invited again to add their n
3434
| Mentch | Jeff | | 0000-0002-7762-8678 | Speech & Hearing Bioscience & Technology Program, Harvard University |
3535
| Moodie | Craig A. | | 0000-0003-0867-1469 | Department of Psychology, Stanford University |
3636
| Naveau | Mikaël | | 0000-0001-6948-9068 | Cyceron, UMS 3408 (CNRS - UCBN), France |
37+
| Nielson | Dylan M. | | 0000-0003-4613-6643 | Machine Learning Team, National Institute of Mental Health, USA |
3738
| Nitsch | Alexander | | 0000-0002-5740-9451 | Max Planck Institute for Human Cognitive and Brain Sciences, Leipzig, Germany |
3839
| Papadopoulos | Dimitri | | 0000-0002-1242-8990 | Neurospin, CEA |
3940
| Plunkett | Dillon | | 0000-0001-7822-6024 | Department of Psychology, Harvard University |

.zenodo.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,11 @@
330330
"name": "Blair, Ross W.",
331331
"orcid": "0000-0003-3007-1056"
332332
},
333+
{
334+
"affiliation": "Machine Learning Team, National Institute of Mental Health",
335+
"name": "Nielson, Dylan M.",
336+
"orcid": "0000-0003-4613-6643"
337+
},
333338
{
334339
"affiliation": "Department of Psychology, Stanford University",
335340
"name": "Poldrack, Russell A.",

fmriprep/workflows/bold/resampling.py

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1241,19 +1241,20 @@ def init_bold_grayords_wf(
12411241
Either ``"91k"`` or ``"170k"``, representing the total *grayordinates*.
12421242
mem_gb : :obj:`float`
12431243
Size of BOLD file in GB
1244+
repetition_time : :obj:`float`
1245+
Repetition time in seconds
12441246
name : :obj:`str`
12451247
Unique name for the subworkflow (default: ``"bold_grayords_wf"``)
12461248
12471249
Inputs
12481250
------
1251+
bold_fsLR : :obj:`str`
1252+
List of paths to BOLD series resampled as functional GIFTI files in fsLR space
12491253
bold_std : :obj:`str`
12501254
List of BOLD conversions to standard spaces.
12511255
spatial_reference : :obj:`str`
12521256
List of unique identifiers corresponding to the BOLD standard-conversions.
1253-
surf_files : :obj:`str`
1254-
List of BOLD files resampled on the fsaverage (ico7) surfaces.
1255-
surf_refs :
1256-
List of unique identifiers corresponding to the BOLD surface-conversions.
1257+
12571258
12581259
Outputs
12591260
-------
@@ -1268,16 +1269,17 @@ def init_bold_grayords_wf(
12681269
from niworkflows.interfaces.utility import KeySelect
12691270

12701271
workflow = Workflow(name=name)
1272+
1273+
mni_density = "2" if grayord_density == "91k" else "1"
1274+
12711275
workflow.__desc__ = """\
12721276
*Grayordinates* files [@hcppipelines] containing {density} samples were also
1273-
generated using the highest-resolution ``fsaverage`` as intermediate standardized
1274-
surface space.
1277+
generated with surface data transformed directly to fsLR space and subcortical
1278+
data transformed to {mni_density} mm resolution MNI152NLin6Asym space.
12751279
""".format(
1276-
density=grayord_density
1280+
density=grayord_density, mni_density=mni_density
12771281
)
12781282

1279-
mni_density = "2" if grayord_density == "91k" else "1"
1280-
12811283
inputnode = pe.Node(
12821284
niu.IdentityInterface(
12831285
fields=[

0 commit comments

Comments
 (0)