GeezerVison is showing github.com — BUG: ensure that errorbar does not error on masked negative errors. by mhvk · Pull Request #29897 · matplotlib/matplotlib
Conversation
mhvk
commented
Apr 10, 2025
•
edited
Loading
Uh oh!
There was an error while loading. Please reload this page.
errorbar checks that errors are not negative, but a bit convolutedly, in order to avoid triggering on nan. Unfortunately, the work-around for nan means that possible masks get discarded, and hence passing in a masked error array that has a negative but masked value leads to an exception. This PR solves that by simply combining the test for
negative values with the indirect isnan test (err == err), so that if a masked array is passed, the test values are masked and ignored in the check.
As a bonus, this also means that astropy's Masked arrays can now be used -- those refuse to write output of tests to unmasked values since that would discard the mask (which is indeed the underlying problem here) -- see
astropy/astropy#17996
p.s. I checked that the test case that I added fails on current main. The test case is based on the one for nan right above - let me know if this is an OK location for it.
EDIT: updated to simplify the check without using any storing of outputs. This means we can also continue to use astropy's Quantity for error bars (and just shows how damn careful one has to be, sigh).
EDIT 2: second commit prevents any comparison of nan < nan, which causes RuntimeError that I did not see locally.
PR checklist
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
errorbar checks that errors are not negative, but a bit convolutedly,
in order to avoid triggering on nan. Unfortunately, the work-around
for nan means that possible masks get discarded, and hence passing in
a masked error array that has a negative but masked value leads to
an exception. This PR solves that by simply combining the test for
negative values with the indirect isnan test (err == err), so that
if a masked array is passed, the test values are masked and ignored
in the check.
As a bonus, this also means that astropy's ``Masked`` arrays can now
be used -- those refuse to write output of tests to unmasked values
since that would discard the mask (which is indeed the underlying
problem here).
|
The underlying (underlying) problem is that np.where does not respect the mask and __getitem__ does?
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
The underlying (underlying) problem is that np.where does not respect the mask and __getitem__ does?
No, the problem is that when writing directly to a regular array, as happened in np.less(err, -err, out=res) (where res was a regular array created with np.zeros), the mask gets dropped (more specifically, np.less(err, -err) would normally return a masked boolean array, with the mask a copy of the mask of err, but writing that to res drops the mask).
p.s. What was a surprise is that np.less raises a RuntimeWarning for np.nan unless that particular element is not included in where -- a surprise mostly because I know from my ufunc work that generally the where argument does not actually prevent the function to be done on the arguments, it just avoids the result being written back. But perhaps it is different for the comparisons - nan are of course notorious and there is a lot of extra code to work around them... Anyway, unrelated to the issue at hand!
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Actually, I guess I misread your question: yes, it is also true that the where argument ignores the mask on the output of err == err.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Thanks @mhvk! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again.
|
bsipocz reacted with hooray emoji
bsipocz reacted with heart emoji
All reactions
-
🎉
1 reaction
-
❤️
1 reaction
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Apr 16, 2025
…r on masked negative errors.
|
Thanks @mhvk for fixing this!
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
QuLogic
added a commit
that referenced
this pull request
Apr 17, 2025
…897-on-v3.10.x
Backport PR #29897 on branch v3.10.x (BUG: ensure that errorbar does not error on masked negative errors.)
Reviewers
dstansby
dstansby approved these changes
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.
|