-
Notifications
You must be signed in to change notification settings - Fork 188
[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
[ENH] Specify that dir-<label> should correspond to PhaseEncodingDirection #2097
Conversation
There was a problem hiding this 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.
d9d762b
to
a5bad79
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2097 +/- ##
=======================================
Coverage 82.71% 82.71%
=======================================
Files 20 20
Lines 1608 1608
=======================================
Hits 1330 1330
Misses 278 278 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
@oesteban Would you mind giving this another review? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. A couple of suggestions to make things more explicit, but I think this is really useful.
defd774
to
570267d
Compare
Co-authored-by: Oscar Esteban <[email protected]>
570267d
to
523402a
Compare
The BIDS convention is to use
dir-{AP,PA,LR,RL}
for phase-encoding directions in MRI filenames, as well asPhaseEncodingDirection
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 thePhaseEncodingDirection
.