Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] add _proc-<label> to all modalities having _rec (anat, fmap, func, perf, and pet) #105

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/modality-specific-files/magnetoencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,8 @@ For example: `sub-01_task-nback_markers.sqd`
Please refer to the [MEG File Formats Appendix](../appendices/meg-file-formats.md)
for general information on how to deal with such manufacturer specifics and to see more examples.

The [`proc-<label>`](../appendices/entities.md#proc) entity is analogous to the
[`rec-<label>`](../appendices/entities.md#rec) entity for MRI,
and denotes a variant of a file that was a result of particular processing performed on the device.
The [`proc-<label>`](../appendices/entities.md#proc) entity
denotes a variant of a file that was a result of particular processing performed on the device.
This is useful for files produced in particular by Neuromag/Elekta/MEGIN's MaxFilter
(for example, sss, tsss, trans, quat, mc),
which some installations impose to be run on raw data prior to analysis.
Expand Down
4 changes: 3 additions & 1 deletion src/schema/objects/entities.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ processing:
name: proc
display_name: Processed (on device)
description: |
The proc label is analogous to rec for MR and denotes a variant of
The proc label denotes a variant of
a file that was a result of particular processing performed on the device.

This is useful for files produced in particular by Neuromag/Elekta/MEGIN's
Expand All @@ -231,6 +231,8 @@ reconstruction:
description: |
The `rec-<label>` entity can be used to distinguish different reconstruction algorithms
(for example, `MoCo` for the ones using motion correction).
Also consider `proc-<label>` entity to represent additional processing performed on the data
after initial reconstruction (for example, spatial smoothing).
type: string
format: label
recording:
Expand Down
9 changes: 9 additions & 0 deletions src/schema/rules/files/raw/anat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ nonparametric:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
part: optional

Expand Down Expand Up @@ -61,6 +62,7 @@ parametric:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional

defacemask:
Expand All @@ -79,6 +81,7 @@ defacemask:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
modality: optional

Expand All @@ -99,6 +102,7 @@ multiecho:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
echo: required
part: optional
Expand All @@ -119,6 +123,7 @@ multiflip:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
echo: optional
flip: required
Expand All @@ -140,6 +145,7 @@ multiinversion:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
inversion: required
part: optional
Expand All @@ -160,6 +166,7 @@ mp2rage:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
echo: optional
flip: optional
Expand All @@ -183,6 +190,7 @@ vfamt:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
echo: optional
flip: required
Expand All @@ -205,6 +213,7 @@ mtr:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
mtransfer: required
part: optional
11 changes: 2 additions & 9 deletions src/schema/rules/files/raw/channels.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,15 @@ channels:
datatypes:
- eeg
- ieeg
- meg
- nirs
entities:
subject: required
session: optional
task: required
acquisition: optional
run: optional

# MEG has an additional entity available
channels__meg:
$ref: rules.files.raw.channels.channels
datatypes:
- meg
entities:
$ref: rules.files.raw.channels.channels.entities
processing: optional
yarikoptic marked this conversation as resolved.
Show resolved Hide resolved
run: optional

coordsystem:
suffixes:
Expand Down
2 changes: 2 additions & 0 deletions src/schema/rules/files/raw/dwi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ dwi:
session: optional
acquisition: optional
reconstruction: optional
processing: optional
direction: optional
run: optional
part: optional
Expand All @@ -33,6 +34,7 @@ sbref:
session: optional
acquisition: optional
reconstruction: optional
processing: optional
direction: optional
run: optional
part: optional
5 changes: 5 additions & 0 deletions src/schema/rules/files/raw/fmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ TB1DAM:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
flip: required
inversion: optional
Expand All @@ -73,6 +74,7 @@ TB1EPI:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
echo: required
flip: required
Expand All @@ -97,6 +99,7 @@ RFFieldMaps:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
echo: optional
flip: optional
Expand All @@ -118,6 +121,7 @@ TB1SRGE:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
echo: optional
flip: required
Expand All @@ -140,4 +144,5 @@ parametric:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
run: optional
2 changes: 2 additions & 0 deletions src/schema/rules/files/raw/func.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ func:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
direction: optional
run: optional
echo: optional
Expand All @@ -38,6 +39,7 @@ phase:
acquisition: optional
ceagent: optional
reconstruction: optional
processing: optional
direction: optional
run: optional
echo: optional
3 changes: 3 additions & 0 deletions src/schema/rules/files/raw/perf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ asl:
session: optional
acquisition: optional
reconstruction: optional
processing: optional
direction: optional
run: optional

Expand All @@ -30,6 +31,7 @@ aslcontext:
session: optional
acquisition: optional
reconstruction: optional
processing: optional
direction: optional
run: optional

Expand All @@ -45,4 +47,5 @@ asllabeling:
session: optional
acquisition: optional
reconstruction: optional
processing: optional
run: optional
2 changes: 2 additions & 0 deletions src/schema/rules/files/raw/pet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ pet:
task: optional
tracer: optional
reconstruction: optional
processing: optional
run: optional

blood:
Expand All @@ -30,5 +31,6 @@ blood:
task: optional
tracer: optional
reconstruction: optional
processing: optional
run: optional
recording: required
4 changes: 4 additions & 0 deletions src/schema/rules/files/raw/task.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ events__mri:
$ref: rules.files.raw.task.events.entities
ceagent: optional
reconstruction: optional
processing: optional
direction: optional

events__pet:
Expand All @@ -62,6 +63,7 @@ events__pet:
task: required
tracer: optional
reconstruction: optional
processing: optional
run: optional

timeseries__mri:
Expand All @@ -72,6 +74,7 @@ timeseries__mri:
entities:
$ref: rules.files.raw.task.timeseries.entities
reconstruction: optional
processing: optional
direction: optional

timeseries__func:
Expand Down Expand Up @@ -101,5 +104,6 @@ timeseries__pet:
task: required
tracer: optional
reconstruction: optional
processing: optional
run: optional
recording: optional