Skip to content

Commit 9196e89

Browse files
committed
ENH(DOC): adjust docstring to describe Philips tuneups
1 parent 9730486 commit 9196e89

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

heudiconv/heuristics/reproin.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@
2828
Sequence names on the scanner must follow this specification to avoid manual
2929
conversion/handling:
3030
31-
[PREFIX:]<seqtype[-label]>[_ses-<SESID>][_task-<TASKID>][_acq-<ACQLABEL>][_run-<RUNID>][_dir-<DIR>][<more BIDS>][__<custom>]
31+
[PREFIX:][WIP ]<seqtype[-label]>[_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
35+
[WIP ] - prefix is stripped/ignored (added by Philips for patch sequences)
3536
<...> - value to be entered
3637
[...] - optional -- might be nearly mandatory for some modalities (e.g.,
3738
run for functional) and very optional for others
@@ -104,6 +105,16 @@
104105
105106
Although we still support "-" and "+" used within SESID and TASKID, their use is
106107
not recommended, thus not listed here
108+
109+
## Scanner specifics
110+
111+
We perform following actions regardless of the type of scanner, but applied
112+
generally to accommodate limitations imposed by different manufacturers/models:
113+
114+
### Philips
115+
116+
- We replace all ( with { and ) with } to be able e.g. to specify session {date}
117+
- "WIP " prefix unconditionally added by the scanner is stripped
107118
"""
108119

109120
import os

0 commit comments

Comments
 (0)