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.

Sign up for GitHub

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

Jump to bottom

[ENH] add hemi entity to schema #917

Merged
merged 6 commits into from
Nov 9, 2021
Merged

[ENH] add hemi entity to schema #917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dea7abc
add hemi entity to schema
Remi-Gau Oct 29, 2021
845daa3
lint yml
Remi-Gau Oct 29, 2021
73bd378
Update src/schema/objects/entities.yaml
Remi-Gau Oct 30, 2021
632202d
add link to hemi in appendix
Remi-Gau Oct 30, 2021
3f2d58b
fix entity order in example derivatives iEEG
Remi-Gau Oct 30, 2021
2908103
fix hemi entity name and link to appendix
Remi-Gau Oct 30, 2021
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
2 changes: 1 addition & 1 deletion src/04-modality-specific-files/04-intracranial-electroencephalography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ General fields:
"For example, **T1**: `'sub-<label>/ses-<label>/anat/"
"sub-01_T1w.nii.gz'` "
"**Surface**: `'/derivatives/surfaces/sub-<label>/ses-<label>/anat/"
"sub-01_desc-T1w_hemi-R_pial.surf.gii'` "
"sub-01_hemi-R_desc-T1w_pial.surf.gii'` "
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small change in this example to make it bids derivatives compliant

"**Operative photo**: `'/sub-<label>/ses-<label>/ieeg/"
"sub-0001_ses-01_acq-photo1_photo.jpg'` "
"**Talairach**: `'/derivatives/surfaces/sub-Talairach/ses-01/anat/"
Expand Down
2 changes: 1 addition & 1 deletion src/05-derivatives/03-imaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ Template:
<source_entities>[_hemi-{L|R}][_space-<space>][_res-<label>][_den-<label>]_dseg.{label.gii|dlabel.nii}
```

The `hemi` tag is REQUIRED for GIFTI files storing information about
The [`hemi-<label>`](../99-appendices/09-entities.md#hemi) entity is REQUIRED for GIFTI files storing information about
a structure that is restricted to a hemibrain.
For example:

Expand Down
16 changes: 14 additions & 2 deletions src/schema/objects/entities.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,18 @@ flip:
value which needs to be stored in the field `FlipAngle` of the separate JSON file.
type: string
format: index
hemisphere:
name: Hemisphere
entity: hemi
description: |
The `hemi-<label>` entity indicates which hemibrain is described by the file.
Allowed label values for this entity are `L` and `R`, for the left and right
hemibrains, respectively.
type: string
format: label
enum:
- "L"
- "R"
inversion:
name: Inversion Time
entity: inv
Expand Down Expand Up @@ -135,8 +147,8 @@ mtransfer:
respectively.
type: string
enum:
- 'on'
- 'off'
- "on"
- "off"
part:
name: Part
entity: part
Expand Down
1 change: 1 addition & 0 deletions src/schema/rules/entities.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- part
- recording
- processing
- hemisphere
- space
- split
- resolution
Expand Down