Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MNT: Pending-deprecate setting colormap extremes in-place #30531

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+33 −0
Open

MNT: Pending-deprecate setting colormap extremes in-place #30531

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e2090f4
MNT: Pending-deprecate setting colormap extremes
timhoffm Sep 8, 2025
4c3343e
Update doc/api/next_api_changes/deprecations/30531-TH.rst
timhoffm Sep 9, 2025
bf856a0
Update doc/api/next_api_changes/deprecations/30531-TH.rst
timhoffm Sep 9, 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
16 changes: 16 additions & 0 deletions doc/api/next_api_changes/deprecations/30531-TH.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
In-place modifications of colormaps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Colormaps are planned to become immuatable in the long term.

As a first step, in-place modifications of colormaps are now pending-deprecated.
This affects the following methods of `.Colormap`:

- `.Colormap.set_bad` - use ``cmap.with_extremes(bad=...)`` instead
- `.Colormap.set_under` - use ``cmap.with_extremes(under=...)`` instead
- `.Colormap.set_over` - use ``cmap.with_extremes(over=...)`` instead
- `.Colormap.set_extremes` - use ``cmap.with_extremes(...)`` instead

Use the respective `.Colormap.with_extremes` and appropriate keyword arguments
instead with returns a copy of the colormap (available since matplotlib 3.4).
Alternatively, if you create the colormap yourself, you can also pass the
respective arguments to the constructor (available since matplotlib 3.11).
17 changes: 17 additions & 0 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -875,6 +875,10 @@ def get_bad(self):
self._init()
return np.array(self._lut[self._i_bad])

@_api.deprecated(
"3.11",
pending=True,
alternative="cmap.with_extremes(bad=...) or Colormap(bad=...)")
def set_bad(self, color='k', alpha=None):
"""Set the color for masked values."""
self._rgba_bad = to_rgba(color, alpha)
Expand All @@ -887,6 +891,10 @@ def get_under(self):
self._init()
return np.array(self._lut[self._i_under])

@_api.deprecated(
"3.11",
pending=True,
alternative="cmap.with_extremes(under=...) or Colormap(under=...)")
def set_under(self, color='k', alpha=None):
"""Set the color for low out-of-range values."""
self._rgba_under = to_rgba(color, alpha)
Expand All @@ -899,12 +907,21 @@ def get_over(self):
self._init()
return np.array(self._lut[self._i_over])

@_api.deprecated(
"3.11",
pending=True,
alternative="cmap.with_extremes(over=...) or Colormap(over=...)")
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()

@_api.deprecated(
"3.11",
pending=True,
alternative="cmap.with_extremes(bad=..., under=..., over=...) or "
"Colormap(bad=..., under=..., over=...)")
def set_extremes(self, *, bad=None, under=None, over=None):
"""
Set the colors for masked (*bad*) values and, when ``norm.clip =
Expand Down
Loading