Skip to content

Conventions for spatial tranformations#47

Open
AlexVCaron wants to merge 3 commits intonf-neuro:mainfrom
AlexVCaron:bids_transforms
Open

Conventions for spatial tranformations#47
AlexVCaron wants to merge 3 commits intonf-neuro:mainfrom
AlexVCaron:bids_transforms

Conversation

@AlexVCaron
Copy link
Contributor

New documentation section on spatial transformations conventions :

  • format
  • operation ordering
  • how to in modules, subworkflows and pipelines
  • filenames convention piggybacking on BIDS

@frheault
Copy link

frheault commented Aug 1, 2025

That's clear (at least for me). One important thing for the warps would be to mention that yes it represents the transformation from A->B, but it should be documented somewhere what is the representation (is it XYZ displacement in RASMM or LPSMM or VOX). Also the ITK convention is to write the displacement in an image interpolation friendly way (it is actually B->A internally). Maybe these notion should be writen in the doc so future module can explain them (case by case) to avoid confusion.

@AlexVCaron
Copy link
Contributor Author

There is 2 options to inform about the transformation space : either we (A) add entities in the filename or (B) add a json sidecar to the mix. I'd tend to try to prevent name bloating with (A), but (B) adds some undesirable management hurdles as well. There is a mechanism in BIDS to define a common sidecar for multiple files using the common entities present in the filenames that solves parts of it, but adds an extra layer of complexity. I don't have a perfect solution for this, maybe we should brainstorm and PoC.

@AlexVCaron
Copy link
Contributor Author

About the ITK convention, I already gave a link to the ANTs wiki, which has a beautiful description of the datastructures and conventions. I can add a sentence to push people towards it to learn more.

Copy link
Member

@gagnonanthony gagnonanthony left a comment

Choose a reason for hiding this comment

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

Looks clear to me as well! I noticed a small typo, otherwise perfect job 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants