Skip to content

Commit da14b63

Browse files
committed
docs: update caption of BOLD ROIs reportlet and boilerplate
1 parent 896f6f8 commit da14b63

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

fmriprep/data/reports-spec.yml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,14 @@ sections:
8585
subtitle: Alignment of functional and anatomical MRI data (surface driven)
8686
- bids: {datatype: figures, desc: rois, suffix: bold}
8787
caption: Brain mask calculated on the BOLD signal (red contour), along with the
88-
masks used for a/tCompCor.<br />The aCompCor mask (magenta contour) is a conservative
89-
CSF and white-matter mask for extracting physiological and movement confounds.
90-
<br />The fCompCor mask (blue contour) contains the top 5% most variable voxels
91-
within a heavily-eroded brain-mask.
92-
subtitle: Brain mask and (temporal/anatomical) CompCor ROIs
88+
regions of interest (ROIs) used in <em>a/tCompCor</em> for extracting
89+
physiological and movement confounding components.<br />
90+
The <em>anatomical CompCor</em> ROI (magenta contour) is a mask combining
91+
CSF and WM (white-matter), where voxels containing a minimal partial volume
92+
of GM have been removed.<br />
93+
The <em>temporal CompCor</em> ROI (blue contour) contains the top 2% most
94+
variable voxels within the brain mask.
95+
subtitle: Brain mask and (anatomical/temporal) CompCor ROIs
9396
- bids:
9497
datatype: figures
9598
desc: '[at]compcor'
@@ -107,10 +110,11 @@ sections:
107110
in the BOLD data. Global signals calculated within the whole-brain (GS), within
108111
the white-matter (WM) and within cerebro-spinal fluid (CSF) show the mean BOLD
109112
signal in their corresponding masks. DVARS and FD show the standardized DVARS
110-
and framewise-displacement measures for each time point.<br />A carpet plot
111-
shows the time series for all voxels within the brain mask, or if ``--cifti-output``
112-
was enabled, all grayordinates. Voxels are grouped into cortical (dark/light blue),
113-
and subcortical (orange) gray matter, cerebellum (green) and white matter and CSF
113+
and framewise-displacement measures for each time point.<br />
114+
A carpet plot shows the time series for all voxels within the brain mask,
115+
or if <code>--cifti-output</code> was enabled, all grayordinates.
116+
Voxels are grouped into cortical (dark/light blue), and subcortical (orange)
117+
gray matter, cerebellum (green) and white matter and CSF
114118
(red), indicated by the color map on the left-hand side.
115119
subtitle: BOLD Summary
116120
- bids: {datatype: figures, desc: 'confoundcorr', suffix: bold}

fmriprep/workflows/bold/confounds.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ def init_bold_confs_wf(
141141
from ...interfaces.confounds import aCompCorMasks
142142

143143
gm_desc = (
144-
'a probabilistic segmentation from the *aseg* segmentation' if freesurfer
145-
else 'the corresponding partial volume map'
144+
"dilating a GM mask extracted from the FreeSurfer's *aseg* segmentation" if freesurfer
145+
else "thresholding the corresponding partial volume map at 0.05"
146146
)
147147

148148
workflow = Workflow(name=name)
@@ -168,11 +168,10 @@ def init_bold_confs_wf(
168168
For aCompCor, three probabilistic masks (CSF, WM and combined CSF+WM)
169169
are generated in anatomical space.
170170
The implementation differs from that of Behzadi et al. in that instead
171-
of eroding the masks by 2 pixels on BOLD space, a liberal mask of the
172-
GM is obtained by thresholding {gm_desc} at 0.05.
173-
Then this mask is substracted from the WM and the combined CSF+WM masks
174-
to ensure components are not extracted from voxels containing a minimal
175-
fraction of GM.
171+
of eroding the masks by 2 pixels on BOLD space, the aCompCor masks are
172+
subtracted a mask of pixels that likely contain a volume fraction of GM.
173+
This mask is obtained by {gm_desc}, and it ensures components are not extracted
174+
from voxels containing a minimal fraction of GM.
176175
Finally, these masks are resampled into BOLD space and binarized by
177176
thresholding at 0.99 (as in the original implementation).
178177
Components are also calculated separately within the WM and CSF masks.

0 commit comments

Comments
 (0)