Skip to content

DOC: improve documentation for distance_transform_{cdt,edt} #18063

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 14, 2023
Merged

DOC: improve documentation for distance_transform_{cdt,edt} #18063

merged 1 commit into from
Mar 14, 2023

Conversation

OmarManzoor
Copy link
Contributor

Reference issue

Closes gh-17815

What does this implement/fix?

  • Improve the documentation of distance_transform_cdt and distance_transform_cdt_edt by adding in the convention for foreground and background as present in distance_transform_bf.

Additional information

None

@OmarManzoor
DOC improve documentation for distance_transform_{cdt,edt}
eff8045 
[skip cirrus] [skip actions] [skip azp]
@j-bowhay j-bowhay added scipy.spatial Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.ndimage and removed scipy.spatial labels Feb 27, 2023
j-bowhay
j-bowhay approved these changes Feb 27, 2023
View reviewed changes
Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

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

Thanks @OmarManzoor, I think this is an improvement for people transitioning from the MATLAB function.

@j-bowhay j-bowhay added this to the 1.11.0 milestone Feb 27, 2023
@melissawm
Copy link
Member

This is indeed much clearer, thanks @OmarManzoor and @j-bowhay for the review!

@melissawm melissawm changed the title DOC improve documentation for distance_transform_{cdt,edt} DOC: improve documentation for distance_transform_{cdt,edt} Mar 14, 2023
@melissawm melissawm merged commit bb480a3 into scipy:main Mar 14, 2023
@OmarManzoor OmarManzoor deleted the doc_improve_distance_transform_funcs branch March 15, 2023 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@j-bowhay j-bowhay j-bowhay approved these changes

Assignees
No one assigned
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.ndimage
Projects
None yet
Milestone
1.11.0
Development

Successfully merging this pull request may close these issues.

DOC: improve documentation for distance_transform_{cdt,edt}
3 participants
@OmarManzoor @melissawm @j-bowhay