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
Update argparse descriptions to make it clear that the script can also be used to compute MCC #4331
Merged
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
joshuacwnewton
approved these changes
Jan 10, 2024
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.
Assuming the functionality works as intended, then I think the argparse changes are good!!
joshuacwnewton
added
the
documentation
category: readthedocs, sourceforge, or SCT courses
label
Jan 10, 2024
joshuacwnewton
changed the title
Add MCC to
Update argparse descriptions to make it clear that the script can also be used to compute MCC
Jan 10, 2024
sct_compute_compression
((I just tweaked the title of the PR to make it clear that no new functionality is actually being added.)) |
jcohenadad
approved these changes
Jan 10, 2024
jcohenadad
reviewed
Jan 10, 2024
sandrinebedard
approved these changes
Jan 10, 2024
Co-authored-by: Julien Cohen-Adad <jcohen@polymtl.ca>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Checklist
GitHub
PR contents
Description
The
sct_compute_compression
function is meant to compute maximum spinal cord compression (MSCC) using the SC segmentation.This PR updates the
sct_compute_compression
description to make clear that the function can also be used for maximum canal compromise (MCC) computation if spinal canal (aka CSF) segmentation is provided.More context in #4330.
Currently, I have updated only the description (without changing any code). This assumes that users will read the description and will not provide spinal canal segmentation in combination with the
-normalize-hc
flag (normative database does not contain measures of the spinal canal). I made this clear by the following note:spinalcordtoolbox/spinalcordtoolbox/scripts/sct_compute_compression.py
Lines 101 to 106 in 0ab1044
Linked issues
Resolves #4330