Skip to content

[ENH] Specify that dir-<label> should correspond to PhaseEncodingDirection #2097

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.

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

effigies
Copy link
Collaborator

@effigies effigies commented Apr 4, 2025

The BIDS convention is to use dir-{AP,PA,LR,RL} for phase-encoding directions in MRI filenames, as well as PhaseEncodingDirection in JSON sidecars. This duplication has the potential for inconsistency or multiple interpretations of the meaning of AP.

This PR aims to clarify the meaning of dir-<label> when its value matches a cardinal axis, and clearly state that this meaning SHOULD be consistent with the PhaseEncodingDirection.

Copy link
Collaborator

@oesteban oesteban left a comment

Choose a reason for hiding this comment

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

This is great to make the situation better without introducing backward incompatible changes. I made some suggestions to be more explicit about what the problem is and providing examples, that said, the phrasing will likely require improvements.

@effigies effigies force-pushed the feat/nifti-axis-codes branch from d9d762b to a5bad79 Compare May 22, 2025 19:13
Copy link

codecov bot commented May 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.06%. Comparing base (9aaf7e3) to head (a5bad79).
Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2097   +/-   ##
=======================================
  Coverage   82.06%   82.06%           
=======================================
  Files          17       17           
  Lines        1533     1533           
=======================================
  Hits         1258     1258           
  Misses        275      275           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

2 participants