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

extend SurfaceDiceMetric for 3D images #6549

Merged
merged 6 commits into from
May 24, 2023
Merged

Conversation

dyollb
Copy link
Contributor

@dyollb dyollb commented May 24, 2023

Description

This PR extends the SurfaceDiceMetric for 3D images. The implementation already uses generic functions to obtain the boundary edges and compute the distance, the extension just

  • removes the assertion that the input is 2D ([B,C,W,H]).
  • updates the docstrings
  • adds a test case in TestAllSurfaceDiceMetrics.test_tolerance_euclidean_distance_3d

fixes #5906
mentioning #4103

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
  • Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

Signed-off-by: Bryn Lloyd <lloyd@itis.swiss>
@dyollb
Copy link
Contributor Author

dyollb commented May 24, 2023

/black

Bryn Lloyd and others added 3 commits May 24, 2023 11:52
Signed-off-by: Bryn Lloyd <lloyd@itis.swiss>
Signed-off-by: monai-bot <monai.miccai2019@gmail.com>
Signed-off-by: Bryn Lloyd <lloyd@itis.swiss>
@wyli
Copy link
Member

wyli commented May 24, 2023

Hi @dyollb, thanks for the PR! since you are looking at these components... would you be interested in fixing a related documentation issue #5906? I think to close the issue we just replace Normalized Surface Distance with Normalized Surface Dice in the docstring and include this reference https://arxiv.org/abs/2111.05408.

For the 3D option, it'll be very useful to clarify that this implementation is different from the deepmind's in terms of the voxel surface boundaries #4103, perhaps we include this URL https://github.com/Project-MONAI/MONAI/issues/4103 in the docstring. please let me know your thoughts, thanks!

Signed-off-by: Bryn Lloyd <lloyd@itis.swiss>
@dyollb
Copy link
Contributor Author

dyollb commented May 24, 2023

Hi @dyollb, thanks for the PR! since you are looking at these components... would you be interested in fixing a related documentation issue #5906? I think to close the issue we just replace Normalized Surface Distance with Normalized Surface Dice in the docstring and include this reference https://arxiv.org/abs/2111.05408.

For the 3D option, it'll be very useful to clarify that this implementation is different from the deepmind's in terms of the voxel surface boundaries #4103, perhaps we include this URL https://github.com/Project-MONAI/MONAI/issues/4103 in the docstring. please let me know your thoughts, thanks!

Thanks @wyli. I adapted the docstring accordingly.

Copy link
Member

@wyli wyli left a comment

Choose a reason for hiding this comment

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

thanks, I'll fix the style error and merge this soon..

Signed-off-by: Wenqi Li <wenqil@nvidia.com>
@wyli
Copy link
Member

wyli commented May 24, 2023

/build

@wyli wyli enabled auto-merge (squash) May 24, 2023 12:23
@wyli wyli merged commit 8dd004a into Project-MONAI:dev May 24, 2023
30 of 35 checks passed
@dyollb dyollb deleted the surface_dice_3d branch May 24, 2023 13:37
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.

Clarification required for SurfaceDiceMetric
3 participants