@@ -57,14 +57,14 @@ The log directory contains `citation boilerplate`_ text.
57
57
``dataset_description.json `` is a metadata file in which PETPrep
58
58
records metadata recommended by the BIDS standard.
59
59
60
- This layout, now the default, may be explicitly specified with the
60
+ This default layout , may be explicitly specified with the
61
61
``--output-layout bids `` command-line option.
62
- For compatibility with versions of PETPrep prior to 21.0, the
62
+ For compatibility with versions of fMRIPrep prior to 21.0, the
63
63
`legacy layout `_ is available via ``--output-layout legacy ``.
64
64
65
65
Processing level
66
66
----------------
67
- As of version 23.2.0 , PETPrep supports three levels of derivatives:
67
+ As of version 0.0.1 , PETPrep supports three levels of derivatives:
68
68
69
69
* ``--level minimal ``: This processing mode aims to produce the smallest
70
70
working directory and output dataset possible, while enabling all further
@@ -73,13 +73,9 @@ As of version 23.2.0, PETPrep supports three levels of derivatives:
73
73
preprocessing can be assessed. Because no resampling is done, confounds
74
74
and carpetplots will be missing from the reports.
75
75
* ``--level resampling ``: This processing mode aims to produce additional
76
- derivatives that enable third-party resampling, resampling PET series
76
+ derivatives that enable third-party resampling, resampling PET data
77
77
in the working directory as needed, but these are not saved to the output
78
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
79
* ``--level full ``: This processing mode aims to produce all derivatives
84
80
that have previously been a part of the PETPrep output dataset.
85
81
This is the default processing level.
@@ -197,7 +193,7 @@ and lookup tables are provided. ::
197
193
desc-aparcaseg_dseg.tsv
198
194
199
195
Copies of the ``fsaverage `` subjects distributed with the running version of
200
- FreeSurfer are copied into this subjects directory, if any functional data are
196
+ FreeSurfer are copied into this subjects directory, if any PET data are
201
197
sampled to those subject spaces.
202
198
203
199
Note that the use of ``sourcedata/ `` recognizes FreeSurfer derivatives as an input to
@@ -206,16 +202,14 @@ This is strictly true when pre-computed FreeSurfer derivatives are provided eith
206
202
the ``sourcedata/ `` directory or passed via the ``--fs-subjects-dir `` flag;
207
203
if PETPrep runs FreeSurfer, then there is a mutual dependency.
208
204
209
- Functional derivatives
205
+ PET derivatives
210
206
~~~~~~~~~~~~~~~~~~~~~~
211
- Functional derivatives are stored in the ``func/ `` subfolder.
212
- All derivatives contain ``task-<task_label> `` (mandatory) and ``run-<run_index> `` (optional), and
213
- these will be indicated with ``[specifiers] ``::
207
+ PET derivatives are stored in the ``pet/ `` subfolder.
214
208
215
209
sub-<subject_label>/
216
210
func/
217
- sub-<subject_label>_[specifiers] _space-<space_label>_desc-brain_mask.nii.gz
218
- sub-<subject_label>_[specifiers] _space-<space_label>_desc-preproc_pet.nii.gz
211
+ sub-<subject_label>_space-<space_label>_desc-brain_mask.nii.gz
212
+ sub-<subject_label>_space-<space_label>_desc-preproc_pet.nii.gz
219
213
220
214
.. note ::
221
215
@@ -251,27 +245,6 @@ image and affine transform::
251
245
252
246
Coregistration outputs are part of the *minimal * processing level.
253
247
254
- **Fieldmap registration **.
255
-
256
- If a fieldmap is used for the correction of a PET series, then a registration
257
- is calculated between the PET series and the fieldmap. If, for example, the fieldmap
258
- is identified with ``"B0Identifier": "TOPUP" ``, the generated transform will be named::
259
-
260
- sub-<subject_label>/
261
- func/
262
- sub-<subject_label>_[specifiers]_from-petref_to-TOPUP_mode-image_xfm.txt
263
-
264
- If the association is discovered through the ``IntendedFor `` field of the
265
- fieldmap metadata, then the transform will be given an auto-generated name::
266
-
267
- sub-<subject_label>/
268
- func/
269
- sub-<subject_label>_[specifiers]_from-petref_to-auto000XX_mode-image_xfm.txt
270
-
271
- .. note ::
272
-
273
- Fieldmap registration outputs are part of the *minimal * processing level.
274
-
275
248
**Regularly gridded outputs (images) **.
276
249
Volumetric output spaces labels (``<space_label> `` above, and in the following) include
277
250
``T1w `` and ``MNI152NLin2009cAsym `` (default).
@@ -285,7 +258,7 @@ mid-thickness surface mesh::
285
258
func/
286
259
sub-<subject_label>_[specifiers]_space-T1w_desc-aparcaseg_dseg.nii.gz
287
260
sub-<subject_label>_[specifiers]_space-T1w_desc-aseg_dseg.nii.gz
288
- sub-<subject_label>_[specifiers]_hemi-[LR]_space-<space_label>_bold .func.gii
261
+ sub-<subject_label>_[specifiers]_hemi-[LR]_space-<space_label>_pet .func.gii
289
262
290
263
Surface output spaces include ``fsnative `` (full density subject-specific mesh),
291
264
``fsaverage `` and the down-sampled meshes ``fsaverage6 `` (41k vertices) and
@@ -438,9 +411,6 @@ frames with sudden and large motion or intensity spikes.
438
411
- ``dvars `` - the derivative of RMS variance over voxels (or :abbr: `DVARS ( derivative of
439
412
RMS variance over voxels ) `) [Power2012 ]_;
440
413
- ``std_dvars `` - standardized :abbr: `DVARS ( derivative of RMS variance over voxels ) `;
441
- - ``non_steady_state_outlier_XX `` - columns indicate non-steady state volumes with a single
442
- ``1 `` value and ``0 `` elsewhere (*i.e. *, there is one ``non_steady_state_outlier_XX `` column per
443
- outlier/volume).
444
414
445
415
Detected outliers can be further removed from time series using methods such as:
446
416
volume *censoring * - entirely discarding problematic time points [Power2012 ]_,
@@ -648,14 +618,14 @@ See implementation on :mod:`~petprep.workflows.pet.confounds.init_pet_confs_wf`.
648
618
Legacy layout
649
619
-------------
650
620
651
- Prior to PETPrep 21.0, the following organizational structure was used::
621
+ Prior to tools such as fMRIPrep 21.0, the following organizational structure was used::
652
622
653
623
<output_dir>/
654
- petprep /
624
+ fmriprep /
655
625
freesurfer/
656
626
657
627
Although this has the advantage of keeping all outputs together,
658
- it ensured that the output of PETPrep could not itself be a BIDS derivative dataset,
628
+ it ensured that the output of fMRIPrep could not itself be a BIDS derivative dataset,
659
629
only contain one.
660
630
661
631
To restore this behavior, use the ``--output-layout legacy `` command-line option.
0 commit comments