Skip to content

DOC: Added blurb for colorizer objects in what's new for 3.10 #29478

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 3 commits into from
Jan 22, 2025
Merged

DOC: Added blurb for colorizer objects in what's new for 3.10 #29478

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d3821d
Added blurb for colorizer objects in what's new for 3.10
trygvrad Jan 17, 2025
1d98f42
Update doc/users/prev_whats_new/whats_new_3.10.0.rst
trygvrad Jan 17, 2025
8c97f38
Text updates to the colorizer blurb from QuLogic
trygvrad Jan 22, 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
56 changes: 56 additions & 0 deletions doc/users/prev_whats_new/whats_new_3.10.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,62 @@ the ``set_data`` method, enabling e.g. resampling
fig.savefig("after.png")


Added ``matplotlib.colorizer.Colorizer`` as a container for ``norm`` and ``cmap``
-------------------------------------------------------------------------------
Comment thread
trygvrad marked this conversation as resolved.
Resolved

`matplotlib.colorizer.Colorizer` encapsulates the data-to-color pipeline. It makes reuse of colormapping easier, e.g. across multiple images. Plotting methods that support ``norm`` and ``cmap`` keyword arguments now also accept a ``colorizer`` keyword argument.
Comment thread
trygvrad marked this conversation as resolved.
Resolved

In the following example the norm and cmap are changed on multiple plots simultaneously:


.. plot::
:include-source: true
:alt: Example use of a matplotlib.colorizer.Colorizer object

import matplotlib.pyplot as plt
import matplotlib as mpl
import numpy as np

x = np.linspace(-2, 2, 50)[np.newaxis, :]
y = np.linspace(-2, 2, 50)[:, np.newaxis]
im_0 = 1 * np.exp( - (x**2 + y**2 - x * y))
im_1 = 2 * np.exp( - (x**2 + y**2 + x * y))

colorizer = mpl.colorizer.Colorizer()
fig, axes = plt.subplots(1, 2, figsize=(6, 2))
cim_0 = axes[0].imshow(im_0, colorizer=colorizer)
fig.colorbar(cim_0)
cim_1 = axes[1].imshow(im_1, colorizer=colorizer)
fig.colorbar(cim_1)

colorizer.vmin = 0.5
colorizer.vmax = 2
colorizer.cmap = 'RdBu'

All plotting methods that use a data-to-color pipeline now create a colorizer object if one is not provided. This can be re-used in by subsequent artists such that they will share a single data-to-color pipeline:
Comment thread
trygvrad marked this conversation as resolved.
Resolved

.. plot::
:include-source: true
:alt: Example of how artists that share a ``colorizer`` have coupled colormaps

import matplotlib.pyplot as plt
import matplotlib as mpl
import numpy as np

x = np.linspace(-2, 2, 50)[np.newaxis, :]
y = np.linspace(-2, 2, 50)[:, np.newaxis]
im_0 = 1 * np.exp( - (x**2 + y**2 - x * y))
im_1 = 2 * np.exp( - (x**2 + y**2 + x * y))

fig, axes = plt.subplots(1, 2, figsize=(6, 2))

cim_0 = axes[0].imshow(im_0, cmap='RdBu', vmin=0.5, vmax=2)
fig.colorbar(cim_0)
cim_1 = axes[1].imshow(im_1, colorizer=cim_0.colorizer)
fig.colorbar(cim_1)

cim_1.cmap = 'rainbow'

3D plotting improvements
========================

Expand Down