[ENH] add task metadata to PET #1196
Conversation
| --> | ||
| {{ MACROS___make_metadata_table( | ||
| { | ||
| "TaskName": ("RECOMMENDED", "If used to denote resting scans, a RECOMMENDED convention is to use labels beginning with `rest`.") |
There was a problem hiding this comment.
Usually this is REQUIRED for almost all datatypes (except for behavioral), for backward compatibility I suspect it is better to keep it RECOMMENDED.
There was a problem hiding this comment.
Added an extra comment that tries to make it clear that eventhough task is not required for PET for resting scans, if one decided to use it, it would be better to stick to the convention other datatypes use.
There was a problem hiding this comment.
I agree that it is best to keep recommended, and great that you added the extra comment.
| @@ -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, | |||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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.
|
Better but it seems that dumping extra metadata in the json did not trigger any failure in the bids examples repo, so let's open an issue to remember to do it but hell should not break loose if we don't do it right away. |
That is because
Still, the metadata should be added to the json schema in the validator |
There was a problem hiding this comment.
approved, provided we add "task" to https://github.com/bids-standard/bids-validator/blob/d96d6ff2ee30a6620d91d1d881fdc6e5db9023e9/bids-validator/validators/json/schemas/pet.json#L1
Codecov Report
@@ Coverage Diff @@
## master #1196 +/- ##
=======================================
Coverage 88.23% 88.23%
=======================================
Files 6 6
Lines 1020 1020
=======================================
Hits 900 900
Misses 120 120 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
closes #1188
To view the final render:
https://bids-specification--1196.org.readthedocs.build/en/1196/04-modality-specific-files/09-positron-emission-tomography.html#task