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 task metadata to PET #1196

Merged
merged 7 commits into from
Aug 25, 2022
Merged

[ENH] add task metadata to PET #1196

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d3b9de8
add task metadata to PET
Remi-Gau Aug 12, 2022
ac6cdc3
fix typo
Remi-Gau Aug 12, 2022
c5db963
update schema
Remi-Gau Aug 12, 2022
a3fea1a
fix metadata order
Remi-Gau Aug 12, 2022
28f1036
add task in entites in schema selector
Remi-Gau Aug 12, 2022
bd8f042
Merge branch 'master' into task_pet
sappelhoff Aug 25, 2022
fd39d09
fix indentation
sappelhoff Aug 25, 2022
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
21 changes: 21 additions & 0 deletions src/04-modality-specific-files/09-positron-emission-tomography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,27 @@ and a guide for using macros can be found at

All reconstruction-specific parameters that are not specified, but one wants to include, should go into the `ReconMethodParameterValues` field.

#### Task

If the OPTIONAL [`task-<label>`](../99-appendices/09-entities.md#task) is used,
Copy link
Member

Choose a reason for hiding this comment

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

What does not having task imply? Just that the scan is resting-state, or something more specific? Like it's meant as a static, rather than functional, scan or something?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Given that it's PET it could just be that you are measuring binding potential of some ligand I suspect. Some not exactly static because you have a temporal component but not functional for sure. @mnoergaard ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Not having a task means rest (to lie still in the scanner and note move), and this is how most of PET scans are carried out. Both for static and dynamic scans.

the following metadata SHOULD be used.

<!-- This block generates a metadata table.
The definitions of these fields can be found in
src/schema/objects/metadata.yaml
and a guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___make_metadata_table(
{
"CogPOID": "RECOMMENDED",
"CogAtlasID": "RECOMMENDED",
"TaskDescription": "RECOMMENDED",
"Instructions": ("RECOMMENDED", "This is especially important in context of resting state recordings and distinguishing between eyes open and eyes closed paradigms."),
"TaskName": ("RECOMMENDED", "If used to denote resting scans, a RECOMMENDED convention is to use labels beginning with `rest`."),
}
) }}

#### Example (`*_pet.json`)

```JSON
Expand Down
20 changes: 20 additions & 0 deletions src/schema/rules/sidecars/pet.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,3 +181,23 @@ PETReconstruction:
level: recommended
SinglesRate:
level: recommended

# PET task information
PETTask:
selectors:
- modality == "pet"
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
- '"task" in entities'
fields:
TaskName:
level: recommended
description_addendum: |
If used to denote resting scans, a RECOMMENDED convention is to use labels
beginning with `rest`.
Instructions:
level: recommended
description_addendum: |
This is especially important in context of resting state recordings
and distinguishing between eyes open and eyes closed paradigms.
TaskDescription: recommended
CogAtlasID: recommended
CogPOID: recommended