Skip to content

FIX: Image scaling for large dynamic range ints#10133

Merged
dopplershift merged 1 commit intomatplotlib:masterfrom
jklymak:fix-image-scaling
Jan 15, 2018
Merged

FIX: Image scaling for large dynamic range ints#10133
dopplershift merged 1 commit intomatplotlib:masterfrom
jklymak:fix-image-scaling

Conversation

@jklymak
Copy link
Copy Markdown
Member

@jklymak jklymak commented Dec 30, 2017

PR Summary

This fixes #10072.

The problem was that for a uint32 image, the dynamic range was too high for a float32 to properly represent. Simply changing to float64 fixes the issue. I suppose someone could use a unit64 image, but...

Test coming: code:

import matplotlib.pyplot as plt
import numpy as np

img = np.load('/Users/jklymak/downloads/test_image.npy')
img = np.array([[1, 2, 3], [1, 2, 10000000000]], dtype=np.uint32)
#Display full image
plt.imshow(img, interpolation = 'nearest')
plt.clim(0, 5.)
plt.show()

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer
Copy link
Copy Markdown
Contributor

anntzer commented Dec 30, 2017

That's not going to help the efforts on trying to reduce the memory footprint of imshow... (#6952, #8143, etc.). Not a blocker, but should be kept in mind.

@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Dec 30, 2017

Yeah, understood. This is the dumbest solution.

I don't quite understand why this rescaling is necessary, despite the nice comments....

@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Dec 30, 2017

OK, I only used the bigger float64 if the amin-amax > 1e8.

@anntzer
Copy link
Copy Markdown
Contributor

anntzer commented Dec 30, 2017

I think(?) you probably care more about maxabs/minabs.

@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Dec 30, 2017

Hmmm, not at all sure, because I once understood all the low-level reps of floats etc, but not so good at it anymore. Happy if someone wants to pick this up and do it better.

But, I think the error comes in when we do:

matplotlib/lib/matplotlib/image.py

Lines 389 to 390 in 884060a

if a_min != a_max:
A_scaled /= ((a_max - a_min) / 0.8)

and the resulting float doesn't preserve all the bits in the unit32.

@jklymak jklymak added this to the v2.1.2 milestone Dec 30, 2017
@tacaswell
Copy link
Copy Markdown
Member

tacaswell commented Dec 30, 2017

This is a reasonable approach.

The scaling is to be able to track the over/under pixels and get around ringing in the interpolations.

@tacaswell
Copy link
Copy Markdown
Member

tacaswell commented Jan 8, 2018

Discussed this on the phone call. Will investigate

  • delaying conversion to float as long as possible
  • avoiding float128 due to platform-dependence
  • add a test

@jklymak jklymak force-pushed the fix-image-scaling branch from 5415e6a to 9ba75dc Compare January 9, 2018 01:38
@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Jan 9, 2018

Test added, and changes requested above made... Thanks!

@jklymak jklymak mentioned this pull request Jan 11, 2018
Merged
dopplershift
dopplershift approved these changes Jan 15, 2018
View reviewed changes
Copy link
Copy Markdown
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.

Working and slow is better than broken and fast. Happy to merge a future PR that keeps things working and makes it faster.

@dopplershift dopplershift merged commit b511bb2 into matplotlib:master Jan 15, 2018
lumberbot-app bot pushed a commit that referenced this pull request Jan 15, 2018
@dopplershift
Backport PR #10133: FIX: Image scaling for large dynamic range ints
f5611f5
@lumberbot-app lumberbot-app bot mentioned this pull request Jan 15, 2018
Merged
@jklymak jklymak deleted the fix-image-scaling branch January 15, 2018 21:06
jklymak added a commit that referenced this pull request Jan 16, 2018
@jklymak
Merge pull request #10255 from matplotlib/auto-backport-of-pr-10133
b503d6a 
Backport PR #10133 on branch v2.1.x
@jklymak jklymak mentioned this pull request Feb 22, 2018
Closed
@tacaswell tacaswell mentioned this pull request Mar 26, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tacaswell tacaswell tacaswell approved these changes

@dopplershift dopplershift dopplershift approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v2.1.2

Development

Successfully merging this pull request may close these issues.

imshow doesn't properly display some images

4 participants

@jklymak @anntzer @tacaswell @dopplershift