Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 72a6532

Browse filesBrowse files
greglucasgreglucas
committed
ENH: Adding callbacks to Norms for update signals
This adds a callback registry to Norm instances that can be connected to by other objects to be notified when the Norm is updated. This is particularly relevant for ScalarMappables to be notified when the vmin/vmax are changed on the Norm. Quadcontourset overrides ScalarMappable's `changed()` function, which meant that autoscaling would get called with the wrong data too early. Therefore, we force an autoscale with the proper data earlier in the `Quadcontourset.changed()` function. The Quadcontourset.changed() method assumes some attributes to be there. If we called changed from a parent class, the object may not have been initialized with those attributes yet, so skip that portion of the update. Remove the ScalarMappable callback from axes_grid as the state isn't fully cleared when updating the axes.
1 parent 14b34fd commit 72a6532
Copy full SHA for 72a6532

File tree

Expand file treeCollapse file tree

8 files changed

+185
-21
lines changed
Filter options
Expand file treeCollapse file tree

8 files changed

+185
-21
lines changed

‎doc/users/next_whats_new/callbacks_on_norms.rst

Copy file name to clipboard
+7Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
A callback registry has been added to Normalize objects
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
`.colors.Normalize` objects now have a callback registry, ``callbacksNorm``,
5+
that can be connected to by other objects to be notified when the norm is
6+
updated. `.cm.ScalarMappable` is now a listener and will register a change
7+
when the norm's vmin, vmax or other attributes are changed.

‎lib/matplotlib/cm.py

Copy file name to clipboardExpand all lines: lib/matplotlib/cm.py
+31-10Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ def __init__(self, norm=None, cmap=None):
257257
The colormap used to map normalized data values to RGBA colors.
258258
"""
259259
self._A = None
260-
self.norm = None # So that the setter knows we're initializing.
260+
self._norm = None # So that the setter knows we're initializing.
261261
self.set_norm(norm) # The Normalize instance of this ScalarMappable.
262262
self.cmap = None # So that the setter knows we're initializing.
263263
self.set_cmap(cmap) # The Colormap instance of this ScalarMappable.
@@ -413,6 +413,8 @@ def set_clim(self, vmin=None, vmax=None):
413413
414414
.. ACCEPTS: (vmin: float, vmax: float)
415415
"""
416+
# If the norm's limits are updated self.changed() will be called
417+
# through the callbacks attached to the norm
416418
if vmax is None:
417419
try:
418420
vmin, vmax = vmin
@@ -422,7 +424,6 @@ def set_clim(self, vmin=None, vmax=None):
422424
self.norm.vmin = colors._sanitize_extrema(vmin)
423425
if vmax is not None:
424426
self.norm.vmax = colors._sanitize_extrema(vmax)
425-
self.changed()
426427

427428
def get_alpha(self):
428429
"""
@@ -448,6 +449,30 @@ def set_cmap(self, cmap):
448449
if not in_init:
449450
self.changed() # Things are not set up properly yet.
450451

452+
@property
453+
def norm(self):
454+
return self._norm
455+
456+
@norm.setter
457+
def norm(self, norm):
458+
_api.check_isinstance((colors.Normalize, None), norm=norm)
459+
if norm is None:
460+
norm = colors.Normalize()
461+
462+
if norm is self.norm:
463+
# We aren't updating anything
464+
return
465+
466+
in_init = self.norm is None
467+
# Remove the current callback and connect to the new one
468+
if not in_init:
469+
self.norm.callbacksNorm.disconnect(self._id_norm)
470+
self._norm = norm
471+
self._id_norm = self.norm.callbacksNorm.connect('changed',
472+
self.changed)
473+
if not in_init:
474+
self.changed()
475+
451476
def set_norm(self, norm):
452477
"""
453478
Set the normalization instance.
@@ -462,13 +487,7 @@ def set_norm(self, norm):
462487
the norm of the mappable will reset the norm, locator, and formatters
463488
on the colorbar to default.
464489
"""
465-
_api.check_isinstance((colors.Normalize, None), norm=norm)
466-
in_init = self.norm is None
467-
if norm is None:
468-
norm = colors.Normalize()
469490
self.norm = norm
470-
if not in_init:
471-
self.changed() # Things are not set up properly yet.
472491

473492
def autoscale(self):
474493
"""
@@ -477,8 +496,9 @@ def autoscale(self):
477496
"""
478497
if self._A is None:
479498
raise TypeError('You must first set_array for mappable')
499+
# If the norm's limits are updated self.changed() will be called
500+
# through the callbacks attached to the norm
480501
self.norm.autoscale(self._A)
481-
self.changed()
482502

483503
def autoscale_None(self):
484504
"""
@@ -487,8 +507,9 @@ def autoscale_None(self):
487507
"""
488508
if self._A is None:
489509
raise TypeError('You must first set_array for mappable')
510+
# If the norm's limits are updated self.changed() will be called
511+
# through the callbacks attached to the norm
490512
self.norm.autoscale_None(self._A)
491-
self.changed()
492513

493514
def changed(self):
494515
"""

‎lib/matplotlib/colorbar.py

Copy file name to clipboardExpand all lines: lib/matplotlib/colorbar.py
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,6 +464,7 @@ def __init__(self, ax, mappable=None, *, cmap=None,
464464
self.ax.add_collection(self.dividers)
465465

466466
self.locator = None
467+
self.minorlocator = None
467468
self.formatter = None
468469
self.__scale = None # linear, log10 for now. Hopefully more?
469470

@@ -1066,7 +1067,7 @@ def _mesh(self):
10661067
# vmax of the colorbar, not the norm. This allows the situation
10671068
# where the colormap has a narrower range than the colorbar, to
10681069
# accommodate extra contours:
1069-
norm = copy.copy(self.norm)
1070+
norm = copy.deepcopy(self.norm)
10701071
norm.vmin = self.vmin
10711072
norm.vmax = self.vmax
10721073
x = np.array([0.0, 1.0])

‎lib/matplotlib/colors.py

Copy file name to clipboardExpand all lines: lib/matplotlib/colors.py
+58-6Lines changed: 58 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1123,10 +1123,50 @@ def __init__(self, vmin=None, vmax=None, clip=False):
11231123
-----
11241124
Returns 0 if ``vmin == vmax``.
11251125
"""
1126-
self.vmin = _sanitize_extrema(vmin)
1127-
self.vmax = _sanitize_extrema(vmax)
1128-
self.clip = clip
1129-
self._scale = None # will default to LinearScale for colorbar
1126+
self._vmin = _sanitize_extrema(vmin)
1127+
self._vmax = _sanitize_extrema(vmax)
1128+
self._clip = clip
1129+
self._scale = None
1130+
self.callbacksNorm = cbook.CallbackRegistry()
1131+
1132+
@property
1133+
def vmin(self):
1134+
return self._vmin
1135+
1136+
@vmin.setter
1137+
def vmin(self, value):
1138+
value = _sanitize_extrema(value)
1139+
if value != self._vmin:
1140+
self._vmin = value
1141+
self._changed()
1142+
1143+
@property
1144+
def vmax(self):
1145+
return self._vmax
1146+
1147+
@vmax.setter
1148+
def vmax(self, value):
1149+
value = _sanitize_extrema(value)
1150+
if value != self._vmax:
1151+
self._vmax = value
1152+
self._changed()
1153+
1154+
@property
1155+
def clip(self):
1156+
return self._clip
1157+
1158+
@clip.setter
1159+
def clip(self, value):
1160+
if value != self._clip:
1161+
self._clip = value
1162+
self._changed()
1163+
1164+
def _changed(self):
1165+
"""
1166+
Call this whenever the norm is changed to notify all the
1167+
callback listeners to the 'changed' signal.
1168+
"""
1169+
self.callbacksNorm.process('changed')
11301170

11311171
@staticmethod
11321172
def process_value(value):
@@ -1273,14 +1313,24 @@ def __init__(self, vcenter, vmin=None, vmax=None):
12731313
"""
12741314

12751315
super().__init__(vmin=vmin, vmax=vmax)
1276-
self.vcenter = vcenter
1316+
self._vcenter = vcenter
12771317
if vcenter is not None and vmax is not None and vcenter >= vmax:
12781318
raise ValueError('vmin, vcenter, and vmax must be in '
12791319
'ascending order')
12801320
if vcenter is not None and vmin is not None and vcenter <= vmin:
12811321
raise ValueError('vmin, vcenter, and vmax must be in '
12821322
'ascending order')
12831323

1324+
@property
1325+
def vcenter(self):
1326+
return self._vcenter
1327+
1328+
@vcenter.setter
1329+
def vcenter(self, value):
1330+
if value != self._vcenter:
1331+
self._vcenter = value
1332+
self._changed()
1333+
12841334
def autoscale_None(self, A):
12851335
"""
12861336
Get vmin and vmax, and then clip at vcenter
@@ -1385,7 +1435,9 @@ def vcenter(self):
13851435

13861436
@vcenter.setter
13871437
def vcenter(self, vcenter):
1388-
self._vcenter = vcenter
1438+
if vcenter != self._vcenter:
1439+
self._vcenter = vcenter
1440+
self._changed()
13891441
if self.vmax is not None:
13901442
# recompute halfrange assuming vmin and vmax represent
13911443
# min and max of data

‎lib/matplotlib/contour.py

Copy file name to clipboardExpand all lines: lib/matplotlib/contour.py
+9Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1090,6 +1090,15 @@ def _make_paths(self, segs, kinds):
10901090
in zip(segs, kinds)]
10911091

10921092
def changed(self):
1093+
if not hasattr(self, "cvalues"):
1094+
# Just return after calling the super() changed function
1095+
cm.ScalarMappable.changed(self)
1096+
return
1097+
# Force an autoscale immediately because self.to_rgba() calls
1098+
# autoscale_None() internally with the data passed to it,
1099+
# so if vmin/vmax are not set yet, this would override them with
1100+
# content from *cvalues* rather than levels like we want
1101+
self.norm.autoscale_None(self.levels)
10931102
tcolors = [(tuple(rgba),)
10941103
for rgba in self.to_rgba(self.cvalues, alpha=self.alpha)]
10951104
self.tcolors = tcolors

‎lib/matplotlib/tests/test_colors.py

Copy file name to clipboardExpand all lines: lib/matplotlib/tests/test_colors.py
+71-1Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import matplotlib.cbook as cbook
1818
import matplotlib.pyplot as plt
1919
import matplotlib.scale as mscale
20-
from matplotlib.testing.decorators import image_comparison
20+
from matplotlib.testing.decorators import image_comparison, check_figures_equal
2121

2222

2323
@pytest.mark.parametrize('N, result', [
@@ -1408,3 +1408,73 @@ def test_norm_deepcopy():
14081408
norm2 = copy.deepcopy(norm)
14091409
assert norm2._scale is None
14101410
assert norm2.vmin == norm.vmin
1411+
1412+
1413+
def test_norm_callback():
1414+
norm = mcolors.Normalize()
1415+
x = 0
1416+
1417+
def increment():
1418+
nonlocal x
1419+
x += 1
1420+
1421+
norm.callbacksNorm.connect('changed', increment)
1422+
# Haven't updated anything, so x should be 0
1423+
assert x == 0
1424+
1425+
# Now change vmin and vmax to test callbacks
1426+
norm.vmin = 1
1427+
assert x == 1
1428+
norm.vmax = 5
1429+
assert x == 2
1430+
# callback shouldn't be called if setting to the same value
1431+
norm.vmin = 1
1432+
assert x == 2
1433+
norm.vmax = 5
1434+
assert x == 2
1435+
1436+
1437+
def test_scalarmappable_norm_update():
1438+
norm = mcolors.Normalize()
1439+
sm = matplotlib.cm.ScalarMappable(norm=norm, cmap='plasma')
1440+
# sm doesn't have a stale attribute at first, set it to False
1441+
sm.stale = False
1442+
# The mappable should be stale after updating vmin/vmax
1443+
norm.vmin = 5
1444+
assert sm.stale
1445+
sm.stale = False
1446+
norm.vmax = 5
1447+
assert sm.stale
1448+
sm.stale = False
1449+
norm.clip = True
1450+
assert sm.stale
1451+
# change to the CenteredNorm and TwoSlopeNorm to test those
1452+
# Also make sure that updating the norm directly and with
1453+
# set_norm both update the Norm callback
1454+
norm = mcolors.CenteredNorm()
1455+
sm.norm = norm
1456+
sm.stale = False
1457+
norm.vcenter = 1
1458+
assert sm.stale
1459+
norm = mcolors.TwoSlopeNorm(vcenter=0, vmin=-1, vmax=1)
1460+
sm.set_norm(norm)
1461+
sm.stale = False
1462+
norm.vcenter = 1
1463+
assert sm.stale
1464+
1465+
1466+
@check_figures_equal()
1467+
def test_norm_update_figs(fig_test, fig_ref):
1468+
ax_ref = fig_ref.add_subplot()
1469+
ax_test = fig_test.add_subplot()
1470+
1471+
z = np.arange(100).reshape((10, 10))
1472+
ax_ref.imshow(z, norm=mcolors.Normalize(10, 90))
1473+
1474+
# Create the norm beforehand with different limits and then update
1475+
# after adding to the plot
1476+
norm = mcolors.Normalize(0, 1)
1477+
ax_test.imshow(z, norm=norm)
1478+
# Force initial draw to make sure it isn't already stale
1479+
fig_test.canvas.draw()
1480+
norm.vmin, norm.vmax = 10, 90

‎lib/matplotlib/tests/test_image.py

Copy file name to clipboardExpand all lines: lib/matplotlib/tests/test_image.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,8 +1017,8 @@ def test_imshow_bool():
10171017
def test_full_invalid():
10181018
fig, ax = plt.subplots()
10191019
ax.imshow(np.full((10, 10), np.nan))
1020-
with pytest.warns(UserWarning):
1021-
fig.canvas.draw()
1020+
1021+
fig.canvas.draw()
10221022

10231023

10241024
@pytest.mark.parametrize("fmt,counted",

‎lib/mpl_toolkits/tests/test_axes_grid.py

Copy file name to clipboardExpand all lines: lib/mpl_toolkits/tests/test_axes_grid.py
+5-1Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,11 @@ def test_imagegrid_cbar_mode_edge():
4444
# "second" ones. To achieve this, clear out the axes first.
4545
for ax in grid:
4646
ax.cax.cla()
47-
cb = ax.cax.colorbar(ax.images[0])
47+
ax.cax.colorbar(ax.images[0])
48+
# Remove the callback here so we don't update the "first"
49+
# axes that was cleared out. This is a side effect of the test
50+
# formerly relying on updates not being sent to the old objects
51+
ax.images[0].callbacksSM.disconnect(ax.images[0].colorbar_cid)
4852

4953

5054
def test_imagegrid():

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.