Skip to content

Allow Artists to show pixel data in cursor display #3989

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.

Sign up for GitHub

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
tacaswell merged 26 commits into from
May 24, 2015
Merged

Allow Artists to show pixel data in cursor display #3989

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
34854db
Add the ability for artists to display zdata in cursor
Jan 9, 2015
7e0d1ca
PEP8 fix
Jan 9, 2015
97640da
Another Pep8 fix
Jan 10, 2015
139d820
Pep8: fix trailing whitespace
Jan 10, 2015
17e4211
Style update
Jan 10, 2015
fcda62b
Standardize the hit test and zordering
Jan 19, 2015
8ea9504
Fix the artist sorting behaviour
Jan 19, 2015
02456b8
Fix syntax error
Jan 19, 2015
641304c
Specify hitlist on axes instead of figure
Jan 19, 2015
3f20d3a
Put get_zdata on the correct class
Jan 19, 2015
5850150
Ignore the axes patch
Jan 19, 2015
88b56be
Create new function to format zdata
Jan 19, 2015
aece695
Clean up string formatting
Jan 19, 2015
07745c8
Add a whats new blurb.
Jan 20, 2015
7626394
Add a test for image cursor data
Feb 21, 2015
7b0b6b1
Rename to get_pixel_data and return raw data
Feb 21, 2015
f5ff73f
Update the whats new
Feb 21, 2015
ea565c6
Fix name of method
Feb 21, 2015
1429206
Fix default pixel data and handle no pixel data
Feb 21, 2015
e62b0e3
Update test for new method name
Feb 21, 2015
34b4df4
Simplify transform
Feb 21, 2015
8f266a1
Update display
Feb 21, 2015
70983ff
Simplify format_pixel_data
Mar 8, 2015
cd0e52b
Update name to cursor_data
Mar 8, 2015
8ce3a6f
Move artist sort to within if block
Mar 10, 2015
bac8dff
Fix method name in cursor_test
Mar 17, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Create new function to format zdata
  • Loading branch information
Steven Silvester
Steven Silvester committed Mar 17, 2015
commit 88b56be198c4c47fc5976c17d105d91b3ff6e53c
15 changes: 15 additions & 0 deletions lib/matplotlib/artist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -909,6 +909,21 @@ def get_zdata(self, event):
"""
return ''

@efiring efiring Feb 17, 2015

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why do you want to use a string for this? Shouldn't "data" always be numeric?

@blink1073 blink1073 Feb 17, 2015

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This allows the Artist to control the display of numbers, similar to the existing ax.format_coord.

@joferkington joferkington Feb 20, 2015

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I agree with @efiring on this one. I can think of a lot of use cases (e.g. interactive sampling) where it would be very convenient to access a "raw" value. Returning a numerical value would make this method useful for a lot more than just display.

You already have a separate method for the formatting, so it's only slightly more verbose to flip the function calls on their head and make the displayed string using artist.format_zdata(artist.get_zdata()). In my opinion, this would be a better approach overall.

@blink1073 blink1073 Feb 21, 2015

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ha! I originally meant to do that...


def format_zdata(self, z):
"""
Return *z* string formatted.
"""
try:
is_int = isinstance(z[0], int)
except (TypeError, IndexError):
is_int = isinstance(z, int)
z = [z]
if is_int:
z = ', '.join('{:0}'.format(item) for item in z)
else:
z = ', '.join('{:0.3g}'.format(item) for item in z)
return z


class ArtistInspector(object):
"""
Expand Down
6 changes: 1 addition & 5 deletions lib/matplotlib/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -696,11 +696,7 @@ def get_zdata(self, event):
y, x = event.ydata, event.xdata
i, j = trans.transform_point([y, x]).astype(int)
z = arr[i, j]
if z.size > 1:
# Override default numpy formatting for this specific case.
# Bad idea?
z = ', '.join('{:0.3g}'.format(item) for item in z)
return 'z=%s' % z
return 'z=%s' % self.format_zdata(z)

@pelson pelson Feb 20, 2015

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should it be the image's job to say "z=" - and if so, should it say pixel-value=?



class NonUniformImage(AxesImage):
Expand Down