Skip to content

Commit 34242f3

Browse files
committed
DOC+tinyRF: reproin - use BIDS terminology
BIDS, in particular in its schema, formalized terms to be "datatype" and "suffix", so let"s use those in reproin heuristic documentation.
1 parent e9bc381 commit 34242f3

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

heudiconv/heuristics/reproin.py

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
Sequence names on the scanner must follow this specification to avoid manual
2929
conversion/handling:
3030
31-
[PREFIX:][WIP ]<seqtype[-label]>[_ses-<SESID>][_task-<TASKID>][_acq-<ACQLABEL>][_run-<RUNID>][_dir-<DIR>][<more BIDS>][__<custom>]
31+
[PREFIX:][WIP ]<datatype[-<suffix>]>[_ses-<SESID>][_task-<TASKID>][_acq-<ACQLABEL>][_run-<RUNID>][_dir-<DIR>][<more BIDS>][__<custom>]
3232
3333
where
3434
[PREFIX:] - leading capital letters followed by : are stripped/ignored
@@ -42,24 +42,33 @@
4242
descriptive ones for e.g. SESID (_ses-movie, _ses-localizer)
4343
4444
45-
<seqtype[-label]>
46-
a known BIDS sequence type which is usually a name of the folder under
47-
subject's directory. And (optional) label is specific per sequence type
48-
(e.g. typical "bold" for func, or "T1w" for "anat"), which could often
49-
(but not always) be deduced from DICOM. Known to BIDS modalities are:
45+
<datatype[-suffix]>
46+
a known BIDS sequence datatype which is usually a name of the folder under
47+
subject's directory. And (optional) suffix is a specific sequence type
48+
(e.g., "bold" for func, or "T1w" for "anat"), which could often
49+
(but not always) be deduced from DICOM. Known to ReproIn BIDS modalities
50+
are:
5051
5152
anat - anatomical data. Might also be collected multiple times across
5253
runs (e.g. if subject is taken out of magnet etc), so could
5354
(optionally) have "_run" definition attached. For "standard anat"
54-
labels, please consult to "8.3 Anatomy imaging data" but most
55-
common are 'T1w', 'T2w', 'angio'
55+
suffixes, please consult to "8.3 Anatomy imaging data" but most
56+
common are 'T1w', 'T2w', 'angio'.
57+
beh - behavioral data. known but not "treated".
5658
func - functional (AKA task, including resting state) data.
5759
Typically contains multiple runs, and might have multiple different
5860
tasks different per each run
5961
(e.g. _task-memory_run-01, _task-oddball_run-02)
6062
fmap - field maps
6163
dwi - diffusion weighted imaging (also can as well have runs)
6264
65+
The other BIDS modalities are not known ATM and their data will not be
66+
converted and will be just skipped (with a warning). Full list of datatypes
67+
can be found at
68+
https://github.com/bids-standard/bids-specification/blob/v1.7.0/src/schema/objects/datatypes.yaml
69+
and their corresponding suffixes at
70+
https://github.com/bids-standard/bids-specification/tree/v1.7.0/src/schema/rules/datatypes
71+
6372
_ses-<SESID> (optional)
6473
a session. Having a single sequence within a study would make that study
6574
follow "multi-session" layout. A common practice to have a _ses specifier

0 commit comments

Comments
 (0)