Skip to content

Update to docs with regards to colorbar and colorizer #30112

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
Jun 2, 2025
Merged

Update to docs with regards to colorbar and colorizer #30112

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
4af03f4
Update to docs with regards to colorbar and colorizer
trygvrad May 26, 2025
155ae8a
Updates based on code review
trygvrad Jun 1, 2025
150165b
Tiny update from code review
trygvrad Jun 2, 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
Prev Previous commit
Next Next commit
Updates based on code review
  • Loading branch information
@trygvrad
trygvrad committed Jun 1, 2025
commit 155ae8a496e6a3faad6a9d7b3c7f5aa2853532b5
10 changes: 5 additions & 5 deletions galleries/examples/images_contours_and_fields/multi_image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
import matplotlib.pyplot as plt
import numpy as np

import matplotlib as mpl
import matplotlib.colorizer as mcolorizer
import matplotlib.colors as mcolors

np.random.seed(19680801)

Expand All @@ -32,9 +33,9 @@
fig, axs = plt.subplots(2, 2)
fig.suptitle('Multiple images')

# create a single norm and colorizer to be shared across all images
norm = mpl.colors.Normalize(vmin=np.min(datasets), vmax=np.max(datasets))
colorizer = mpl.colorizer.Colorizer(norm=norm)
# create a colorizer with a predefined norm to be shared across all images
norm = mcolors.Normalize(vmin=np.min(datasets), vmax=np.max(datasets))
colorizer = mcolorizer.Colorizer(norm=norm)

images = []
for ax, data in zip(axs.flat, datasets):
Expand All @@ -61,4 +62,3 @@
# - `matplotlib.figure.Figure.colorbar` / `matplotlib.pyplot.colorbar`
# - `matplotlib.colorizer.Colorizer`
# - `matplotlib.colors.Normalize`
# - `matplotlib.cbook.CallbackRegistry.connect`
8 changes: 4 additions & 4 deletions galleries/users_explain/colors/colorbar_only.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
This tutorial shows how to build and customize standalone colorbars, i.e.
without an attached plot.

A `~.Figure.colorbar` needs a "mappable" (`matplotlib.colorizer.ColorizingArtist`)
object (typically, an image) which contains a colorizer
(`matplotlib.colorizer.Colorizer`) that holds the data-to-color pipeline (norm and
colormap). In order to create a colorbar without an attached image, one can instead
A `~.Figure.colorbar` requires a `matplotlib.colorizer.ColorizingArtist` which
contains a `matplotlib.colorizer.Colorizer` that holds the data-to-color pipeline
(norm and colormap). To create a colorbar without an attached plot one can
use a `.ColorizingArtist` with no associated data.

"""

import matplotlib.pyplot as plt
Expand Down