Merge pull request #27622 from meeseeksmachine/auto-backport-of-pr-27620-on-v3.8.x

QuLogic · web-flow · commit a78c00d29ad9 · 2024-01-09T17:49:01.000-05:00
Backport PR #27620 on branch v3.8.x (DOC: simplify histogram animation example)
diff --git a/galleries/examples/animation/animated_histogram.py b/galleries/examples/animation/animated_histogram.py
@@ -7,43 +7,42 @@
 histogram.
 """
 
+import functools
+
 import matplotlib.pyplot as plt
 import numpy as np
 
 import matplotlib.animation as animation
 
-# Fixing random state for reproducibility
-np.random.seed(19680801)
-# Fixing bin edges
+# Setting up a random number generator with a fixed state for reproducibility.
+rng = np.random.default_rng(seed=19680801)
+# Fixing bin edges.
 HIST_BINS = np.linspace(-4, 4, 100)
 
-# histogram our data with numpy
-data = np.random.randn(1000)
+# Histogram our data with numpy.
+data = rng.standard_normal(1000)
 n, _ = np.histogram(data, HIST_BINS)
 
 # %%
 # To animate the histogram, we need an ``animate`` function, which generates
-# a random set of numbers and updates the heights of rectangles. We utilize a
-# python closure to track an instance of `.BarContainer` whose `.Rectangle`
-# patches we shall update.
+# a random set of numbers and updates the heights of rectangles. The ``animate``
+# function updates the `.Rectangle` patches on an instance of `.BarContainer`.
 
 
-def prepare_animation(bar_container):
+def animate(frame_number, bar_container):
+    # Simulate new data coming in.
+    data = rng.standard_normal(1000)
+    n, _ = np.histogram(data, HIST_BINS)
+    for count, rect in zip(n, bar_container.patches):
+        rect.set_height(count)
 
-    def animate(frame_number):
-        # simulate new data coming in
-        data = np.random.randn(1000)
-        n, _ = np.histogram(data, HIST_BINS)
-        for count, rect in zip(n, bar_container.patches):
-            rect.set_height(count)
-        return bar_container.patches
-    return animate
+    return bar_container.patches
 
 # %%
 # Using :func:`~matplotlib.pyplot.hist` allows us to get an instance of
-# `.BarContainer`, which is a collection of `.Rectangle` instances. Calling
-# ``prepare_animation`` will define ``animate`` function working with supplied
-# `.BarContainer`, all this is used to setup `.FuncAnimation`.
+# `.BarContainer`, which is a collection of `.Rectangle` instances.  Since
+# `.FuncAnimation` will only pass the frame number parameter to the animation
+# function, we use `functools.partial` to fix the ``bar_container`` parameter.
 
 # Output generated via `matplotlib.animation.Animation.to_jshtml`.
 
@@ -52,6 +51,6 @@ def animate(frame_number):
                               ec="yellow", fc="green", alpha=0.5)
 ax.set_ylim(top=55)  # set safe limit to ensure that all data is visible.
 
-ani = animation.FuncAnimation(fig, prepare_animation(bar_container), 50,
-                              repeat=False, blit=True)
+anim = functools.partial(animate, bar_container=bar_container)
+ani = animation.FuncAnimation(fig, anim, 50, repeat=False, blit=True)
 plt.show()
