Skip to content

MNT: Move all Colormap extremes setter logic into a single _set_extremes() #30577

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 2 commits into from
Sep 18, 2025
Merged

MNT: Move all Colormap extremes setter logic into a single _set_extremes() #30577

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84954b0
Move all Colormap extremes setter logic into a single _set_extremes()
timhoffm Sep 17, 2025
f16ebec
Update lib/matplotlib/colors.py
timhoffm Sep 18, 2025
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
43 changes: 24 additions & 19 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,9 +877,7 @@ def get_bad(self):

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

def get_under(self):
"""Get the color for low out-of-range values."""
Expand All @@ -889,9 +887,7 @@ def get_under(self):

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

def get_over(self):
"""Get the color for high out-of-range values."""
Expand All @@ -901,21 +897,14 @@ def get_over(self):

def set_over(self, color='k', alpha=None):
"""Set the color for high out-of-range values."""
self._rgba_over = to_rgba(color, alpha)
if self._isinit:
self._set_extremes()
self._set_extremes(over=(color, alpha))

def set_extremes(self, *, bad=None, under=None, over=None):
"""
Set the colors for masked (*bad*) values and, when ``norm.clip =
False``, low (*under*) and high (*over*) out-of-range values.
"""
if bad is not None:
self.set_bad(bad)
if under is not None:
self.set_under(under)
if over is not None:
self.set_over(over)
self._set_extremes(bad=bad, under=under, over=over)

def with_extremes(self, *, bad=None, under=None, over=None):
"""
Expand All @@ -924,10 +913,26 @@ def with_extremes(self, *, bad=None, under=None, over=None):
out-of-range values, have been set accordingly.
"""
new_cm = self.copy()
new_cm.set_extremes(bad=bad, under=under, over=over)
new_cm._set_extremes(bad=bad, under=under, over=over)
return new_cm

def _set_extremes(self):
def _set_extremes(self, bad=None, under=None, over=None):
"""
Set the colors for masked (*bad*) and out-of-range (*under* and *over*) values.

Parameters that are None are left unchanged.
"""
if bad is not None:
self._rgba_bad = to_rgba(bad)
if under is not None:
self._rgba_under = to_rgba(under)
if over is not None:
self._rgba_over = to_rgba(over)
if self._isinit:
self._update_lut_extremes()

def _update_lut_extremes(self):
"""Ensure than an existing lookup table has the correct extreme values."""
if self._rgba_under:
self._lut[self._i_under] = self._rgba_under
else:
Expand Down Expand Up @@ -1154,7 +1159,7 @@ def _init(self):
self._lut[:-3, 3] = _create_lookup_table(
self.N, self._segmentdata['alpha'], 1)
self._isinit = True
self._set_extremes()
self._update_lut_extremes()

def set_gamma(self, gamma):
"""Set a new gamma value and regenerate colormap."""
Expand Down Expand Up @@ -1346,7 +1351,7 @@ def _init(self):
self._lut = np.zeros((self.N + 3, 4), float)
self._lut[:-3] = to_rgba_array(self.colors)
self._isinit = True
self._set_extremes()
self._update_lut_extremes()

@property
def monochrome(self):
Expand Down
Loading