Skip to content

Updated version of MRIAcquisition for v5#43

Merged
lzehl merged 24 commits into
openMetadataInitiative:devfrom
Alixbonard:dev-MRIAquisition
Feb 20, 2026
Merged

Updated version of MRIAcquisition for v5#43
lzehl merged 24 commits into
openMetadataInitiative:devfrom
Alixbonard:dev-MRIAquisition

Conversation

@Alixbonard

@Alixbonard Alixbonard commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

Major changes:

  • Add core:File to input*
  • Add output
  • Update required field

19/02/2026:

  • rename MRIacquisition to staticMRIAcquisition
  • add new properties coming from dynamicMRIAcquisition ( distortion correction, motion correction, registration data)
  • core:File is removed from inputs

Comment thread schemas/activity/MRIAcquisition.schema.tpl.json Outdated
@Alixbonard Alixbonard marked this pull request as ready for review February 2, 2026 12:05
@lzehl

lzehl commented Feb 13, 2026

Copy link
Copy Markdown
Member

@Alixbonard @apdavison since we are asking now for potential input files (used for correction , etc) explicitly in the device usage and in the activity (at least for fMRI) I think File should be removed from input and input should only handle the specimen.

And I checked: distortion correction, motion correction, and registration data are special inputs also for structural MRI (should be optional there). So they could move in here and be removed from fMRI acquisition which extends this one here.
For fMRI: Distortion + motion + registration = standard preprocessing inputs.
For sMRI: Same exists, but are optional.
NOTE: I think we can stick to allowing them to be defined as inputs in these acquisition schemas as short cut, however they are actually always performed as postprocessing of the scan and not as part of the scan (so they normally would be handled by computation).

Otherwise I think this looks good and could be merged from my side. To be considered for the future are potentially the additional parameters identified for activity in #22 (such as: additional contrast agent parameters (e.g. timing after injection), motion and physiology handling parameters, artifact control parameters (maybe, when dependent on specimen))

maybe rename schema to staticMRIAcquisition

@Alixbonard Alixbonard changed the title Updated version of MRIAcquisition for v5 Updated version of staticMRIAcquisition for v5 Feb 20, 2026
],
"properties": {
"contrastAgent": {
"_instruction": "Add the contrast agent used for this scan.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
"_instruction": "Add the contrast agent used for this scan.",
"_instruction": "Add the contrast agent(s) administered for this acquisition, including for each the agent identity and administered amount; if no contrast agent was used, leave this field null. Include all agents given prior to or during the scan.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

expected value number is 1-N (so needs to become an array)

]
},
"device": {
"_instruction": "Add the MRI machine setting used for this scan.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
"_instruction": "Add the MRI machine setting used for this scan.",
"_instruction": "Add the magnetic resonance imaging (MRI) scanner used for this acquisition. This reference should identify the specific device configuration under which the scan was performed.",

]
},
"distortionCorrection": {
"_instruction": "Add the calibration file corresponding to images or field maps used for correction of inhomogeneities in B0 field of this acquisition.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
"_instruction": "Add the calibration file corresponding to images or field maps used for correction of inhomogeneities in B0 field of this acquisition.",
"_instruction": "Add the distortion correction data used for this acquisition, linking to the calibration files applied during image reconstruction or post-processing. If no distortion correction was performed, leave this field null.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

the expected values here are 1-N so needs to become an array

Comment thread schemas/activity/staticMRIAcquisition.schema.tpl.json Outdated
]
},
"motionCorrection": {
"_instruction": "Add the calibration file used for motion correction, corresponding to single-band reference image, for this volume.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
"_instruction": "Add the calibration file used for motion correction, corresponding to single-band reference image, for this volume.",
"_instruction": "Add the motion correction data used for this acquisition, linking to the calibration files or reference images applied during image reconstruction or post-processing. If no motion correction was performed, leave this field null.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

the expected values here are 1-N so needs to become an array

]
},
"output":{
"_instruction": "Add the file generated during this session.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
"_instruction": "Add the file generated during this session.",
"_instruction": "Add the output data generated by this acquisition by linking to one or more files containing the primary imaging outputs and/or, if applicable, any secondary reconstructed or corrected outputs produced during post-processing.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

the expected values here are 1-N so needs to become an array

]
},
"registrationData": {
"_instruction": "Add the registration file corresponding to structural MRI relevant for this acquisition.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
"_instruction": "Add the registration file corresponding to structural MRI relevant for this acquisition.",
"_instruction": "Add the registration data used for this acquisition, linking to the transformation and/or reference files applied during image alignment in post-processing. If no registration was performed, leave this field null.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

the expected values here are 1-N so needs to become an array

Comment thread schemas/activity/staticMRIAcquisition.schema.tpl.json Outdated
Comment thread schemas/activity/MRIAcquisition.schema.tpl.json
Alixbonard and others added 7 commits February 20, 2026 13:23
Co-authored-by: Lyuba Zehl <lyuba.zehl@ebrains.eu>
Co-authored-by: Lyuba Zehl <lyuba.zehl@ebrains.eu>
Co-authored-by: Lyuba Zehl <lyuba.zehl@ebrains.eu>
Co-authored-by: Lyuba Zehl <lyuba.zehl@ebrains.eu>
Co-authored-by: Lyuba Zehl <lyuba.zehl@ebrains.eu>
Co-authored-by: Lyuba Zehl <lyuba.zehl@ebrains.eu>
Co-authored-by: Lyuba Zehl <lyuba.zehl@ebrains.eu>
Comment thread schemas/activity/MRIAcquisition.schema.tpl.json
@Alixbonard Alixbonard changed the title Updated version of staticMRIAcquisition for v5 Updated version of MRIAcquisition for v5 Feb 20, 2026
@lzehl lzehl merged commit 1ecffce into openMetadataInitiative:dev Feb 20, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

major update most likely causes a new version v5.0 candidate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants