Skip to content
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

Add new tutorial for contrast agnostic registration #3831

Merged
merged 13 commits into from Jul 28, 2022

Conversation

joshuacwnewton
Copy link
Member

@joshuacwnewton joshuacwnewton commented Jul 6, 2022

Checklist

GitHub

PR contents

Description

This PR adds a new tutorial to the registration section of the SCT tutorials, corresponding to @EvanBeal's new contrast agnostic registration method.

I've also made identical changes to the SCT Course PDF. (p76-p80)

Linked issues

N/A, but related to #3760.

The last tutorial in the "registration-to-template" section ("MTR Computation") doesn't actually use the template at all! Instead, it involves using `sct_register_multimodal` to coregister two *non-template* images together.

Additionally, in the next commits, I will be adding a second tutorial that *also* involes coregistering two non-template images together.

So, given that we will have a pair of similar tutorials, it makes sense to break them off into their own section.
@joshuacwnewton joshuacwnewton changed the title Add new tutorial for contrast agnostic registration tutorial Add new tutorial for contrast agnostic registration Jul 6, 2022
@codecov
Copy link

codecov bot commented Jul 6, 2022

Codecov Report

Merging #3831 (1f72515) into master (820d375) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 1f72515 differs from pull request most recent head 6209339. Consider uploading reports for the commit 6209339 to get more accurate results

Flag Coverage Δ
api-tests 21.86% <ø> (-0.02%) ⬇️
cli-tests 58.76% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
spinalcordtoolbox/metadata.py 54.40% <0.00%> (-0.72%) ⬇️
spinalcordtoolbox/math.py 56.71% <0.00%> (ø)
spinalcordtoolbox/moco.py 74.84% <0.00%> (ø)
spinalcordtoolbox/image.py 66.09% <0.00%> (ø)
spinalcordtoolbox/types.py 30.24% <0.00%> (ø)
spinalcordtoolbox/csa_pmj.py 79.48% <0.00%> (ø)
spinalcordtoolbox/qmri/mt.py 85.45% <0.00%> (ø)
spinalcordtoolbox/__init__.py 100.00% <0.00%> (ø)
spinalcordtoolbox/cropping.py 73.61% <0.00%> (ø)
spinalcordtoolbox/download.py 72.32% <0.00%> (ø)
... and 39 more

Copy link
Member

@mguaypaq mguaypaq 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 written clearly, and follows the style of the other tutorials. After downloading t1.nii.gz and t2.nii.gz directly from the sct_tutorial_data repo, I was able to run all the steps. I like the images you included at the bottom of each page of the tutorial.

I guess the commands for using the warping fields produced during this tutorial are more advanced and out of scope.

(I did run into a few errors at first, but that's just because I hadn't re-run sct_install recently, so I was missing some sct_download_data datasets and some pip install -r requirements.txt dependencies.)

Copy link
Member

@jcohenadad jcohenadad left a comment

Choose a reason for hiding this comment

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

How come I am not able to see the deepreg algo in the CLI page?

image

joshuacwnewton added a commit to spinalcordtoolbox/sct_tutorial_data that referenced this pull request Jul 27, 2022
@joshuacwnewton
Copy link
Member Author

joshuacwnewton commented Jul 27, 2022

How come I am not able to see the deepreg algo in the CLI page?

Ah! Good catch! This is because the argparse help description was not updated in #3807. Fixing this now. 🤦

Copy link
Member

@jcohenadad jcohenadad left a comment

Choose a reason for hiding this comment

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

Minor suggestions added. This is an excellent tutorial addition, thank you so much @joshuacwnewton !!

@mguaypaq mguaypaq merged commit 00ca428 into master Jul 28, 2022
@mguaypaq mguaypaq deleted the jn/3760-add-dl-registration-tutorial branch July 28, 2022 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation category: readthedocs, sourceforge, or SCT courses
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants