📝 Add utils.visualization Examples#943
Merged
shaneahmed merged 6 commits intodevelopfrom Jul 24, 2025
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #943 +/- ##
========================================
Coverage 99.70% 99.70%
========================================
Files 71 71
Lines 9133 9133
Branches 1188 1188
========================================
Hits 9106 9106
Misses 23 23
Partials 4 4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request adds usage examples to several visualization utilities in tiatoolbox/utils/visualization.py.
- Adds
Examplessections to the docstrings of:random_colorscolourise_imageoverlay_prediction_maskoverlay_probability_mapoverlay_prediction_contoursplot_graph
Comments suppressed due to low confidence (2)
tiatoolbox/utils/visualization.py:355
- The example assigns to
axbutreturn_ax=Falsereturns the overlay array, not an axis. Rename the variable (e.g.,overlay = overlay_probability_map(...)) or setreturn_ax=Trueto match the example.
>>> ax = overlay_probability_map(
tiatoolbox/utils/visualization.py:628
- This comment references
overlay_prediction_contoursbut should sayplot_graphto match the function being demonstrated.
>>> # Example usage of overlay_prediction_contours
This file contains hidden or 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
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.
utils.visualization.