Skip to content

[MRG+1] Fix imshow masked interpolation #8024

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

Merged
merged 1 commit into from
Feb 24, 2017

Conversation

tacaswell
Copy link
Member

Closes #8012

The code changes are in the first commit, the image changes are in the second.

This probably needs some more tests and docs. I suspect there is at least one more 🐉 down here...

attn @mdboom

@tacaswell tacaswell added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Feb 5, 2017
@tacaswell tacaswell added this to the 2.0.1 (next bug fix release) milestone Feb 5, 2017
@tacaswell
Copy link
Member Author

So, defiantly 🐲 in up-sampling when mixing masking + over/under with in the kernel foot print.

import matplotlib.pyplot as plt
import matplotlib as mpl
import matplotlib.colors as mcolors
import matplotlib.image as mimage
import matplotlib.cm as mcm
import numpy as np
import copy

cm = copy.copy(mcm.get_cmap('viridis'))
cm.set_over('r')
cm.set_under('b')
cm.set_bad('k')

n = mcolors.Normalize(vmin=0, vmax=100)

data = np.arange(100, dtype='float').reshape(10, 10)

data[5, 5] = -1

data[7, 7] = 101

data[3, 3] = np.nan

data[5, 3] = np.inf

mask = np.zeros_like(data).astype('bool')
mask[3, 5] = True

data = np.ma.masked_array(data, mask)


fig, ax_grid = plt.subplots(3, 6)
for interp, ax in zip(mimage._interpd_, ax_grid.ravel()):
    ax.set_title(interp)
    im = ax.imshow(data, norm=n, cmap=cm, interpolation=interp)

so

@tacaswell
Copy link
Member Author

Right, forget about the topo failure, that is due to the resample vs not resample change and I have not looked into it yet.

@tacaswell tacaswell force-pushed the fix_ishow_masked_interpolation branch 2 times, most recently from 8786852 to 236b48f Compare February 6, 2017 01:02
@tacaswell
Copy link
Member Author

On the bright side I have managed to fix this without having to change classic style and only update 1 test image, on the down side, one test is still broken.

@tacaswell
Copy link
Member Author

and I have fixed the checker-board effect in that png above, that was due to Agg's aggressive clipping.

@tacaswell tacaswell force-pushed the fix_ishow_masked_interpolation branch from 236b48f to 5e83b93 Compare February 6, 2017 02:05
@tacaswell tacaswell closed this Feb 6, 2017
@tacaswell tacaswell reopened this Feb 6, 2017
@tacaswell
Copy link
Member Author

Of course this passes locally...

@tacaswell tacaswell force-pushed the fix_ishow_masked_interpolation branch 2 times, most recently from a1fbee5 to 73091ac Compare February 6, 2017 13:23
When determining which pixels to mask in the resampled image, if _any_
contribution to final value comes from a masked pixel, mask the
result.

Due to Agg special-casing the meaning of the alpha channel,
the interpolation for the mask channel needs to be done separately.
This is probably a template for doing the over/under separately.

print out exact hash on travis
@tacaswell tacaswell force-pushed the fix_ishow_masked_interpolation branch from 73091ac to 1a7c4ef Compare February 6, 2017 20:22
@@ -76,6 +76,7 @@ before_install:

install:
- ccache -s
- git describe
Copy link
Member

Choose a reason for hiding this comment

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

I'm not concerned about this, but would like to make sure that you intended to have this here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I did, was a bit worried that gh/travis were having caching / timeout issues and not running the code I thought it was running (turns out the problem is I had accidentally depended on dictionary ordering in 3.6). I think this is a good idea to keep around so that we can verify exactly what code travis runs for testing locally (it should be running on the merge into the target branch, when it re-sets what that merge is is not something I fully understand yet).

@QuLogic QuLogic changed the title Fix ishow masked interpolation Fix imshow masked interpolation Feb 6, 2017
@QuLogic
Copy link
Member

QuLogic commented Feb 6, 2017

The CI failure appears non-transient.

@dopplershift
Copy link
Contributor

What happened to Appveyor?

@QuLogic
Copy link
Member

QuLogic commented Feb 6, 2017

It doesn't run on the v2.0.x branch.

@dopplershift
Copy link
Contributor

How did I not know that?

Copy link
Contributor

@dopplershift dopplershift left a comment

Choose a reason for hiding this comment

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

Looks reasonable to me. Only a minor question.

# 'unshare' the mask array to
# needed to suppress numpy warning
del out_mask
invalid_mask = ~output.mask * ~np.isnan(output.data)
Copy link
Contributor

Choose a reason for hiding this comment

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

Would & work here instead of *? Would make more sense given the boolean masks.

Copy link
Member Author

Choose a reason for hiding this comment

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

Are there performance rather than semantic advantages? I think ~(a & b) would also work and have one less temprorary.


fig, ax_grid = plt.subplots(3, 6)
for interp, ax in zip(sorted(mimage._interpd_), ax_grid.ravel()):
ax.set_title(interp)
Copy link
Member

Choose a reason for hiding this comment

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

I don't think there's any point adding a title if remove_text is True in the decorator. Otherwise this patch looks good to me.

Copy link
Member Author

Choose a reason for hiding this comment

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

The title is there for human debuggers later (I often copy-past tests into another buffer and just run them)

Copy link
Member

Choose a reason for hiding this comment

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

👍

for interp, ax in zip(sorted(mimage._interpd_), ax_grid.ravel()):
ax.set_title(interp)
ax.imshow(data, norm=n, cmap=cm, interpolation=interp)
ax.axis('off')
Copy link
Member

Choose a reason for hiding this comment

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

Same as above, prseumably pointless with remove_text == True

@dstansby dstansby changed the title Fix imshow masked interpolation [MRG+1] Fix imshow masked interpolation Feb 24, 2017
@NelleV NelleV merged commit 067f9b6 into matplotlib:v2.0.x Feb 24, 2017
@tacaswell tacaswell deleted the fix_ishow_masked_interpolation branch February 24, 2017 22:30
@QuLogic
Copy link
Member

QuLogic commented Feb 24, 2017

This makes for an ugly change in Cartopy:
v2.0.0:
regrid_image
vs v2.0.x:
result-regrid_image
and diff:
result-regrid_image-failed-diff

You might need to view the full resolution image, but it's pretty evident on the lower-most blue one. It used to match the outline, but now there's a very obvious not very straight white bit along the edge.

@dopplershift
Copy link
Contributor

sigh

@QuLogic
Copy link
Member

QuLogic commented Feb 25, 2017

The build also failed matplotlib.tests.test_image.test_rotate_image.test on 2.7 and 3.4 when this got merged, though I'm not sure why. This wasn't a troublesome test before.

@QuLogic
Copy link
Member

QuLogic commented Feb 25, 2017

Even weirder, #8144 is failling on that test on 3.5 but not other versions, even after a rebuild...

@tacaswell
Copy link
Member Author

The rotate image test did give me trouble when working on this.

@tacaswell
Copy link
Member Author

I have sorted out the reason (but not the cause) of the rotate_image failures, for some reason the set_bad from the test added here is leaking out to other tests.

@QuLogic
Copy link
Member

QuLogic commented Mar 15, 2017

Maybe it should use deepcopy instead of copy?

@tacaswell
Copy link
Member Author

That would fix it, but we should also fix ColorMap so that copy works as expected, see #8299

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants