Add getters and _repr_html_ for over/under/bad values of Colormap objects. by bdice · Pull Request #17900 · matplotlib/matplotlib · GitHub
Skip to content

Add getters and _repr_html_ for over/under/bad values of Colormap objects. #17900

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
timhoffm merged 20 commits into from
Aug 19, 2020
Merged

Add getters and _repr_html_ for over/under/bad values of Colormap objects. #17900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
924aa61
Add get_bad, get_under, get_over.
bdice Jul 12, 2020
c7115f0
Add missing docstring to is_gray.
bdice Jul 12, 2020
2fd8ed0
Add under/over/bad colors to Colormap _repr_html_.
bdice Jul 12, 2020
4514171
Add tests for getters.
bdice Jul 12, 2020
90dc80e
Add What's New.
bdice Jul 12, 2020
8dcb3ea
Fix flake8, reorder words.
bdice Jul 12, 2020
c6fc989
Use same_color for testing.
bdice Jul 13, 2020
feb1f87
Apply suggestions from code review
bdice Jul 12, 2020
642477e
Use values outside [0, 1] for testing under/over.
bdice Jul 13, 2020
c43cceb
Remove reference to norm.clip in docstrings.
bdice Jul 14, 2020
9ca1893
Move under/bad/over below the colormap.
bdice Aug 9, 2020
12fd588
Apply CSS suggestions from @greglucas.
bdice Aug 10, 2020
df1cd26
Fix references to documentation.
bdice Aug 10, 2020
64faef0
Use max-width to make content more responsive.
bdice Aug 10, 2020
a55cbf7
Use one line for short docstrings.
bdice Aug 16, 2020
5b095f9
Use f-strings and implicit continuations.
bdice Aug 16, 2020
4581ab8
Use private module constant for PNG representation size.
bdice Aug 16, 2020
057dc55
Improve HTML repr tests.
bdice Aug 16, 2020
e398f92
Assert base64 encoded png is in HTML representation.
bdice Aug 16, 2020
977677a
Fix flake8.
bdice Aug 16, 2020
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
7 changes: 7 additions & 0 deletions doc/users/next_whats_new/colormap_get_under_over_bad.rst
View file
Open in desktop
69 changes: 55 additions & 14 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ def __delitem__(self, key):
_colors_full_map.update(BASE_COLORS)
_colors_full_map = _ColorMapping(_colors_full_map)

_REPR_PNG_SIZE = (512, 64)


def get_named_colors_mapping():
"""Return the global mapping of names to named colors."""
Expand Down Expand Up @@ -614,26 +616,40 @@ def __copy__(self):
cmapobject._global = False
return cmapobject

def get_bad(self):
"""Get the color for masked values."""
if not self._isinit:
self._init()
return self._lut[self._i_bad]

def set_bad(self, color='k', alpha=None):
"""Set the color for masked values."""
_warn_if_global_cmap_modified(self)
self._rgba_bad = to_rgba(color, alpha)
if self._isinit:
self._set_extremes()

def get_under(self):
"""Get the color for low out-of-range values."""
if not self._isinit:
self._init()
return self._lut[self._i_under]

def set_under(self, color='k', alpha=None):
"""
Set the color for low out-of-range values when ``norm.clip = False``.
"""
"""Set the color for low out-of-range values."""
_warn_if_global_cmap_modified(self)
self._rgba_under = to_rgba(color, alpha)
if self._isinit:
self._set_extremes()

def get_over(self):
"""Get the color for high out-of-range values."""
if not self._isinit:
self._init()
return self._lut[self._i_over]

def set_over(self, color='k', alpha=None):
"""
Set the color for high out-of-range values when ``norm.clip = False``.
"""
"""Set the color for high out-of-range values."""
_warn_if_global_cmap_modified(self)
self._rgba_over = to_rgba(color, alpha)
if self._isinit:
Expand All @@ -655,6 +671,7 @@ def _init(self):
raise NotImplementedError("Abstract class only")

def is_gray(self):
"""Return whether the color map is grayscale."""
if not self._isinit:
self._init()
return (np.all(self._lut[:, 0] == self._lut[:, 1]) and
Expand Down Expand Up @@ -685,8 +702,8 @@ def reversed(self, name=None):

def _repr_png_(self):
"""Generate a PNG representation of the Colormap."""
IMAGE_SIZE = (400, 50)
X = np.tile(np.linspace(0, 1, IMAGE_SIZE[0]), (IMAGE_SIZE[1], 1))
X = np.tile(np.linspace(0, 1, _REPR_PNG_SIZE[0]),
(_REPR_PNG_SIZE[1], 1))
pixels = self(X, bytes=True)
png_bytes = io.BytesIO()
title = self.name + ' color map'
Expand All @@ -703,12 +720,36 @@ def _repr_html_(self):
"""Generate an HTML representation of the Colormap."""
png_bytes = self._repr_png_()
png_base64 = base64.b64encode(png_bytes).decode('ascii')
return ('<strong>' + self.name + '</strong>' +
'<img ' +
'alt="' + self.name + ' color map" ' +
'title="' + self.name + '"' +
'style="border: 1px solid #555;" ' +
'src="data:image/png;base64,' + png_base64 + '">')
def color_block(color):
hex_color = to_hex(color, keep_alpha=True)
return (f'<div title="{hex_color}" '
'style="display: inline-block; '
'width: 1em; height: 1em; '
'margin: 0; '
'vertical-align: middle; '
'border: 1px solid #555; '
f'background-color: {hex_color};"></div>')

return ('<div style="vertical-align: middle;">'
f'<strong>{self.name}</strong> '
'</div>'
'<div class="cmap"><img '
f'alt="{self.name} color map" '
f'title="{self.name}" '
'style="border: 1px solid #555;" '
f'src="data:image/png;base64,{png_base64}"></div>'
'<div style="vertical-align: middle; '
f'max-width: {_REPR_PNG_SIZE[0]+2}px; '
'display: flex; justify-content: space-between;">'
'<div style="float: left;">'
f'{color_block(self.get_under())} under'
'</div>'
'<div style="margin: 0 auto; display: inline-block;">'
f'bad {color_block(self.get_bad())}'
'</div>'
'<div style="float: right;">'
f'over {color_block(self.get_over())}'
'</div>')


class LinearSegmentedColormap(Colormap):
Expand Down
19 changes: 19 additions & 0 deletions lib/matplotlib/tests/test_colors.py
View file
Open in desktop