sct_image: Clarify descriptions for -setorient commands
#3938
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is to clear up some confusion raised by a user on the forum, since `-setorient` *doesn't* just modify the header.
This is to clear up some confusion raised by a user on the forum, since `-setorient` *doesn't* just modify the header.
joshuacwnewton
added
documentation
mguaypaq
approved these changes
Nov 9, 2022
joshuacwnewton
deleted the
jn/3741-clarify-setorient-help-description
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is a direct response to the user confusion from https://forum.spinalcordmri.org/t/how-to-use-sct-image-to-fix-the-orientation-of-the-header-and-data-array-setorient-data-vs-setorient/848/1.
My main goals were to:
-setorientmodifies the header and array in tandem.-setorient-data, since I had to explain its usage multiple times to the user.Linked issues
Fixes #3741.