feat: Pass desc to init_ds_registration_wf

effigies · effigies · commit 82fea988a51d · 2025-09-25T14:43:12.000-04:00
diff --git a/.circleci/ds005_partial_fasttrack_outputs.txt b/.circleci/ds005_partial_fasttrack_outputs.txt
@@ -76,8 +76,8 @@ sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-hmc_boldref.json
 sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-hmc_boldref.nii.gz
 sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-T1w_mode-image_desc-coreg_xfm.json
 sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-T1w_mode-image_desc-coreg_xfm.txt
-sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-auto00000_mode-image_xfm.json
-sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-auto00000_mode-image_xfm.txt
+sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.json
+sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.txt
 sub-01/func/sub-01_task-mixedgamblestask_run-02_from-orig_to-boldref_mode-image_desc-hmc_xfm.json
 sub-01/func/sub-01_task-mixedgamblestask_run-02_from-orig_to-boldref_mode-image_desc-hmc_xfm.txt
 sub-01/func/sub-01_task-mixedgamblestask_run-02_hemi-L_space-fsaverage5_bold.func.gii
diff --git a/.circleci/ds005_partial_outputs.txt b/.circleci/ds005_partial_outputs.txt
@@ -96,8 +96,8 @@ sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-coreg_boldref.json
 sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-coreg_boldref.nii.gz
 sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-hmc_boldref.json
 sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-hmc_boldref.nii.gz
-sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-auto00000_mode-image_xfm.json
-sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-auto00000_mode-image_xfm.txt
+sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.json
+sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.txt
 sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-T1w_mode-image_desc-coreg_xfm.json
 sub-01/func/sub-01_task-mixedgamblestask_run-02_from-boldref_to-T1w_mode-image_desc-coreg_xfm.txt
 sub-01/func/sub-01_task-mixedgamblestask_run-02_from-orig_to-boldref_mode-image_desc-hmc_xfm.json
diff --git a/.circleci/ds054_fasttrack_outputs.txt b/.circleci/ds054_fasttrack_outputs.txt
@@ -33,8 +33,8 @@ sub-100185/func/sub-100185_task-machinegame_run-01_desc-hmc_boldref.json
 sub-100185/func/sub-100185_task-machinegame_run-01_desc-hmc_boldref.nii.gz
 sub-100185/func/sub-100185_task-machinegame_run-01_desc-preproc_bold.json
 sub-100185/func/sub-100185_task-machinegame_run-01_desc-preproc_bold.nii.gz
-sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-auto00000_mode-image_xfm.json
-sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-auto00000_mode-image_xfm.txt
+sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.json
+sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.txt
 sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-T1w_mode-image_desc-coreg_xfm.json
 sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-T1w_mode-image_desc-coreg_xfm.txt
 sub-100185/func/sub-100185_task-machinegame_run-01_from-orig_to-boldref_mode-image_desc-hmc_xfm.json
@@ -61,8 +61,8 @@ sub-100185/func/sub-100185_task-machinegame_run-02_desc-hmc_boldref.json
 sub-100185/func/sub-100185_task-machinegame_run-02_desc-hmc_boldref.nii.gz
 sub-100185/func/sub-100185_task-machinegame_run-02_desc-preproc_bold.json
 sub-100185/func/sub-100185_task-machinegame_run-02_desc-preproc_bold.nii.gz
-sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-auto00000_mode-image_xfm.json
-sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-auto00000_mode-image_xfm.txt
+sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.json
+sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.txt
 sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-T1w_mode-image_desc-coreg_xfm.json
 sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-T1w_mode-image_desc-coreg_xfm.txt
 sub-100185/func/sub-100185_task-machinegame_run-02_from-orig_to-boldref_mode-image_desc-hmc_xfm.json
diff --git a/.circleci/ds054_outputs.txt b/.circleci/ds054_outputs.txt
@@ -43,8 +43,8 @@ sub-100185/func/sub-100185_task-machinegame_run-01_desc-hmc_boldref.json
 sub-100185/func/sub-100185_task-machinegame_run-01_desc-hmc_boldref.nii.gz
 sub-100185/func/sub-100185_task-machinegame_run-01_desc-preproc_bold.json
 sub-100185/func/sub-100185_task-machinegame_run-01_desc-preproc_bold.nii.gz
-sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-auto00000_mode-image_xfm.json
-sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-auto00000_mode-image_xfm.txt
+sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.json
+sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.txt
 sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-T1w_mode-image_desc-coreg_xfm.json
 sub-100185/func/sub-100185_task-machinegame_run-01_from-boldref_to-T1w_mode-image_desc-coreg_xfm.txt
 sub-100185/func/sub-100185_task-machinegame_run-01_from-orig_to-boldref_mode-image_desc-hmc_xfm.json
@@ -71,8 +71,8 @@ sub-100185/func/sub-100185_task-machinegame_run-02_desc-hmc_boldref.json
 sub-100185/func/sub-100185_task-machinegame_run-02_desc-hmc_boldref.nii.gz
 sub-100185/func/sub-100185_task-machinegame_run-02_desc-preproc_bold.json
 sub-100185/func/sub-100185_task-machinegame_run-02_desc-preproc_bold.nii.gz
-sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-auto00000_mode-image_xfm.json
-sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-auto00000_mode-image_xfm.txt
+sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.json
+sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.txt
 sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-T1w_mode-image_desc-coreg_xfm.json
 sub-100185/func/sub-100185_task-machinegame_run-02_from-boldref_to-T1w_mode-image_desc-coreg_xfm.txt
 sub-100185/func/sub-100185_task-machinegame_run-02_from-orig_to-boldref_mode-image_desc-hmc_xfm.json
diff --git a/.circleci/ds210_fasttrack_outputs.txt b/.circleci/ds210_fasttrack_outputs.txt
@@ -36,8 +36,8 @@ sub-02/func/sub-02_task-cuedSGT_run-01_echo-2_desc-preproc_bold.json
 sub-02/func/sub-02_task-cuedSGT_run-01_echo-2_desc-preproc_bold.nii.gz
 sub-02/func/sub-02_task-cuedSGT_run-01_echo-3_desc-preproc_bold.json
 sub-02/func/sub-02_task-cuedSGT_run-01_echo-3_desc-preproc_bold.nii.gz
-sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-auto00000_mode-image_xfm.json
-sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-auto00000_mode-image_xfm.txt
+sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.json
+sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.txt
 sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-T1w_mode-image_desc-coreg_xfm.json
 sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-T1w_mode-image_desc-coreg_xfm.txt
 sub-02/func/sub-02_task-cuedSGT_run-01_from-orig_to-boldref_mode-image_desc-hmc_xfm.json
diff --git a/.circleci/ds210_outputs.txt b/.circleci/ds210_outputs.txt
@@ -46,8 +46,8 @@ sub-02/func/sub-02_task-cuedSGT_run-01_echo-2_desc-preproc_bold.json
 sub-02/func/sub-02_task-cuedSGT_run-01_echo-2_desc-preproc_bold.nii.gz
 sub-02/func/sub-02_task-cuedSGT_run-01_echo-3_desc-preproc_bold.json
 sub-02/func/sub-02_task-cuedSGT_run-01_echo-3_desc-preproc_bold.nii.gz
-sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-auto00000_mode-image_xfm.json
-sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-auto00000_mode-image_xfm.txt
+sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.json
+sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-auto00000_mode-image_desc-fmap_xfm.txt
 sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-T1w_mode-image_desc-coreg_xfm.json
 sub-02/func/sub-02_task-cuedSGT_run-01_from-boldref_to-T1w_mode-image_desc-coreg_xfm.txt
 sub-02/func/sub-02_task-cuedSGT_run-01_from-orig_to-boldref_mode-image_desc-hmc_xfm.json
diff --git a/fmriprep/workflows/bold/fit.py b/fmriprep/workflows/bold/fit.py
@@ -520,6 +520,7 @@ def init_bold_fit_wf(
                 output_dir=config.execution.fmriprep_dir,
                 source='boldref',
                 dest=re.sub(r'[^a-zA-Z0-9]', '', fieldmap_id),
+                desc='fmap',
                 name='ds_fmapreg_wf',
             )
 
@@ -682,6 +683,7 @@ def init_bold_fit_wf(
             output_dir=config.execution.fmriprep_dir,
             source='boldref',
             dest='T1w',
+            desc='coreg',
             name='ds_boldreg_wf',
         )
 
diff --git a/fmriprep/workflows/bold/outputs.py b/fmriprep/workflows/bold/outputs.py
@@ -538,6 +538,7 @@ def init_ds_registration_wf(
     source: str,
     dest: str,
     name: str,
+    desc: str | None = None,
 ) -> pe.Workflow:
     workflow = pe.Workflow(name=name)
 
@@ -561,6 +562,7 @@ def init_ds_registration_wf(
             source_file=source_file,
             base_directory=output_dir,
             mode='image',
+            desc=desc,
             suffix='xfm',
             extension='.txt',
             dismiss_entities=dismiss_echo(['part']),

Original file line number	Diff line number	Diff line change
`@@ -520,6 +520,7 @@ def init_bold_fit_wf(`
`520`	`520`	`output_dir=config.execution.fmriprep_dir,`
`521`	`521`	`source='boldref',`
`522`	`522`	`dest=re.sub(r'[^a-zA-Z0-9]', '', fieldmap_id),`
	`523`	`+ desc='fmap',`
`523`	`524`	`name='ds_fmapreg_wf',`
`524`	`525`	`)`
`525`	`526`
`@@ -682,6 +683,7 @@ def init_bold_fit_wf(`
`682`	`683`	`output_dir=config.execution.fmriprep_dir,`
`683`	`684`	`source='boldref',`
`684`	`685`	`dest='T1w',`
	`686`	`+ desc='coreg',`
`685`	`687`	`name='ds_boldreg_wf',`
`686`	`688`	`)`
`687`	`689`