Add a (skippable) check that the axes have equal aspect ratio. #61
Conversation
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
ppinard
requested changes
Jan 4, 2025
README.md
Outdated
| By default, matplotlib_scalebar checks whether the axes have equal aspect ratio | ||
| (so that the scale bar applies both for the x and the y directions), and emits | ||
| a warning if this is not the case. This warning can be suppressed by setting | ||
| *rotation* to `horizontal-only` ("the colorbar only applies to the horizontal |
There was a problem hiding this comment.
colorbar? Shouldn't it be "scale bar"?
README.md
Outdated
| (so that the scale bar applies both for the x and the y directions), and emits | ||
| a warning if this is not the case. This warning can be suppressed by setting | ||
| *rotation* to `horizontal-only` ("the colorbar only applies to the horizontal | ||
| direction") or `vertical-only` ("the colorbar only applies to the vertical |
matplotlib_scalebar/test_scalebar.py
Outdated
| @@ -33,7 +35,7 @@ def scalebar(): | |||
|
|
|||
| yield scalebar | |||
|
|
|||
| plt.draw() | |||
There was a problem hiding this comment.
I think the draw is important here to make sure the scale bar is drawn. It doesn't look that it will impact your unit test
ppinard
requested changes
Jan 4, 2025
When the scalebar is not drawn on an aspect where imshow() has been
called (e.g., a point cloud made with plot()), the axes aspect ratio is
not automatically set to 1, in which case the scale bar will be wrong
(or rather, it will only be correct in the direction (horizontal or
vertical) in which it is drawn).
To avoid mistakes, add a check for the aspect ratio, emitting a warning
when appropriate. The check can be skipped by using new variants for
`rotation`: it can now be set to "horizontal-only" ("the scalebar only
applies to the horizontal direction") or "vertical-only". (This could
also have been a separate kwarg, but something like `check_aspect=False`
reads a bit awkwardly to me.)
|
Thanks, I addressed your comments. |
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #61 +/- ##
==========================================
- Coverage 91.46% 89.93% -1.54%
==========================================
Files 3 3
Lines 422 437 +15
==========================================
+ Hits 386 393 +7
- Misses 36 44 +8 ☔ View full report in Codecov by Sentry. |
zezhong-zhang
pushed a commit
to zezhong-zhang/matplotlib-scalebar
that referenced
this pull request
Feb 20, 2025
…rd#61) * Add a (skippable) check that the axes have equal aspect ratio. When the scalebar is not drawn on an aspect where imshow() has been called (e.g., a point cloud made with plot()), the axes aspect ratio is not automatically set to 1, in which case the scale bar will be wrong (or rather, it will only be correct in the direction (horizontal or vertical) in which it is drawn). To avoid mistakes, add a check for the aspect ratio, emitting a warning when appropriate. The check can be skipped by using new variants for `rotation`: it can now be set to "horizontal-only" ("the scalebar only applies to the horizontal direction") or "vertical-only". (This could also have been a separate kwarg, but something like `check_aspect=False` reads a bit awkwardly to me.) * Try to fix CI --------- Co-authored-by: Philippe Pinard <philippe.pinard@gmail.com>
zezhong-zhang
pushed a commit
to zezhong-zhang/matplotlib-scalebar
that referenced
this pull request
Feb 20, 2025
…rd#61) * Add a (skippable) check that the axes have equal aspect ratio. When the scalebar is not drawn on an aspect where imshow() has been called (e.g., a point cloud made with plot()), the axes aspect ratio is not automatically set to 1, in which case the scale bar will be wrong (or rather, it will only be correct in the direction (horizontal or vertical) in which it is drawn). To avoid mistakes, add a check for the aspect ratio, emitting a warning when appropriate. The check can be skipped by using new variants for `rotation`: it can now be set to "horizontal-only" ("the scalebar only applies to the horizontal direction") or "vertical-only". (This could also have been a separate kwarg, but something like `check_aspect=False` reads a bit awkwardly to me.) * Try to fix CI --------- Co-authored-by: Philippe Pinard <philippe.pinard@gmail.com>
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.
When the scalebar is not drawn on an aspect where imshow() has been called (e.g., a point cloud made with plot()), the axes aspect ratio is not automatically set to 1, in which case the scale bar will be wrong (or rather, it will only be correct in the direction (horizontal or vertical) in which it is drawn).
To avoid mistakes, add a check for the aspect ratio, emitting a warning when appropriate. The check can be skipped by using new variants for
rotation: it can now be set to "horizontal-only" ("the scalebar only applies to the horizontal direction") or "vertical-only". (This could also have been a separate kwarg, but something likecheck_aspect=Falsereads a bit awkwardly to me -- let me know if you'd prefer that.)