Skip to content

Commit e55f185

Browse files
committed
DOC: Add notes on processing level to outputs.rst
1 parent 921caf9 commit e55f185

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/outputs.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,28 @@ This layout, now the default, may be explicitly specified with the
6262
For compatibility with versions of fMRIPrep prior to 21.0, the
6363
`legacy layout`_ is available via ``--output-layout legacy``.
6464

65+
Processing level
66+
----------------
67+
As of version 23.2.0, fMRIPrep supports three levels of derivatives:
68+
69+
* ``--level minimal``: This processing mode aims to produce the smallest
70+
working directory and output dataset possible, while enabling all further
71+
processing results to be deterministically generated. Most components of
72+
the `visual reports`_ can be generated at this level, so the quality of
73+
preprocessing can be assessed. Because no resampling is done, confounds
74+
and carpetplots will be missing from the reports.
75+
* ``--level resampling``: This processing mode aims to produce additional
76+
derivatives that enable third-party resampling, resampling BOLD series
77+
in the working directory as needed, but these are not saved to the output
78+
directory.
79+
The ``--me-output-echos`` flag will be enabled at this level, in which
80+
case the individual echos will be saved to the working directory after
81+
slice-timing correction, head-motion correction, and susceptibility
82+
distortion correction.
83+
* ``--level full``: This processing mode aims to produce all derivatives
84+
that have previously been a part of the fMRIPrep output dataset.
85+
This is the default processing level.
86+
6587
Visual Reports
6688
--------------
6789
*fMRIPrep* outputs summary reports, written to ``<output dir>/fmriprep/sub-<subject_label>.html``.

0 commit comments

Comments
 (0)