Anim example simplify

Author: AntSimi

examples/08_tracking_manipulation/pet_track_anim.py

@@ -5,11 +5,8 @@
 Run in a terminal this script, which allow to watch eddy evolution
 
 """
-from matplotlib import pyplot as plt
-from matplotlib.collections import LineCollection
-from numpy import arange
 from py_eddy_tracker.observations.tracking import TrackEddiesObservations
-from py_eddy_tracker.poly import create_vertice
+from py_eddy_tracker.appli import Anim
 import py_eddy_tracker_sample
 
 # %%
@@ -18,51 +15,18 @@
     py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Anticyclonic.zarr")
 )
 eddy = a.extract_ids([9672])
-t0, t1 = eddy.period
-t = eddy.time
-x = eddy["contour_lon_s"]
-y = eddy["contour_lat_s"]
 
 # %%
-# General value
-T = 25.0
-cmap = plt.get_cmap("viridis")
-COLORS = cmap(arange(T + 1) / T)
-
-
-# %%
-# plot
-fig = plt.figure(figsize=(12, 5))
-ax = fig.add_axes((0.05, 0.05, 0.9, 0.9))
-ax.set_xlim(16.5, 23)
-ax.set_ylim(34.5, 37)
-ax.set_aspect("equal")
-ax.grid()
-# init mappable
-txt = ax.text(16.6, 36.8, "", zorder=10)
-segs = list()
-c = LineCollection([], zorder=1)
-ax.add_collection(c)
-
-fig.canvas.draw()
-plt.show(block=False)
-# save background for future bliting
-bg_cache = fig.canvas.copy_from_bbox(ax.bbox)
-# display contour every 2 day
-for t_ in range(t0, t1 + 1, 2):
-    fig.canvas.restore_region(bg_cache)
-    # select contour for this time step
-    m = t == t_
-    segs.append(create_vertice(x[m][0], y[m][0]))
-    c.set_paths(segs)
-    c.set_color(COLORS[-len(segs) :])
-    txt.set_text(f"{t0} -> {t_} -> {t1}")
-    ax.draw_artist(c)
-    ax.draw_artist(txt)
-    # Remove first segment to keep only T contour
-    if len(segs) > T:
-        segs.pop(0)
-    # paint updated artist
-    fig.canvas.blit(ax.bbox)
-
-    fig.canvas.start_event_loop(1e-10)
+# Run animation
+# Key shortcut
+#   Escape => exit
+#   SpaceBar => pause
+#   left arrow => t - 1
+#   right arrow => t + 1
+#   + => speed increase of 10 %
+#   - => speed decrease of 10 %
+a = Anim(eddy, sleep_event=1e-10, intern=True, figsize=(8, 3.5), cmap="viridis")
+a.txt.set_position((17, 34.6))
+a.ax.set_xlim(16.5, 23)
+a.ax.set_ylim(34.5, 37)
+a.show(infinity_loop=False)

notebooks/python_module/08_tracking_manipulation/pet_track_anim.ipynb

@@ -26,7 +26,7 @@
       },
       "outputs": [],
       "source": [
-        "from matplotlib import pyplot as plt\nfrom matplotlib.collections import LineCollection\nfrom numpy import arange\nfrom py_eddy_tracker.observations.tracking import TrackEddiesObservations\nfrom py_eddy_tracker.poly import create_vertice\nimport py_eddy_tracker_sample"
+        "from py_eddy_tracker.observations.tracking import TrackEddiesObservations\nfrom py_eddy_tracker.appli import Anim\nimport py_eddy_tracker_sample"
       ]
     },
     {
@@ -44,14 +44,14 @@
       },
       "outputs": [],
       "source": [
-        "a = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Anticyclonic.zarr\")\n)\neddy = a.extract_ids([9672])\nt0, t1 = eddy.period\nt = eddy.time\nx = eddy[\"contour_lon_s\"]\ny = eddy[\"contour_lat_s\"]"
+        "a = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Anticyclonic.zarr\")\n)\neddy = a.extract_ids([9672])"
       ]
     },
     {
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "General value\n\n"
+        "Run animation\nKey shortcut\n  Escape => exit\n  SpaceBar => pause\n  left arrow => t - 1\n  right arrow => t + 1\n  + => speed increase of 10 %\n  - => speed decrease of 10 %\n\n"
       ]
     },
     {
@@ -62,25 +62,7 @@
       },
       "outputs": [],
       "source": [
-        "T = 25.0\ncmap = plt.get_cmap(\"viridis\")\nCOLORS = cmap(arange(T + 1) / T)"
-      ]
-    },
-    {
-      "cell_type": "markdown",
-      "metadata": {},
-      "source": [
-        "plot\n\n"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "collapsed": false
-      },
-      "outputs": [],
-      "source": [
-        "fig = plt.figure(figsize=(12, 5))\nax = fig.add_axes((0.05, 0.05, 0.9, 0.9))\nax.set_xlim(16.5, 23)\nax.set_ylim(34.5, 37)\nax.set_aspect(\"equal\")\nax.grid()\n# init mappable\ntxt = ax.text(16.6, 36.8, \"\", zorder=10)\nsegs = list()\nc = LineCollection([], zorder=1)\nax.add_collection(c)\n\nfig.canvas.draw()\nplt.show(block=False)\n# save background for future bliting\nbg_cache = fig.canvas.copy_from_bbox(ax.bbox)\n# display contour every 2 day\nfor t_ in range(t0, t1 + 1, 2):\n    fig.canvas.restore_region(bg_cache)\n    # select contour for this time step\n    m = t == t_\n    segs.append(create_vertice(x[m][0], y[m][0]))\n    c.set_paths(segs)\n    c.set_color(COLORS[-len(segs) :])\n    txt.set_text(f\"{t0} -> {t_} -> {t1}\")\n    ax.draw_artist(c)\n    ax.draw_artist(txt)\n    # Remove first segment to keep only T contour\n    if len(segs) > T:\n        segs.pop(0)\n    # paint updated artist\n    fig.canvas.blit(ax.bbox)\n\n    fig.canvas.start_event_loop(1e-10)"
+        "a = Anim(eddy, sleep_event=1e-10, intern=True, figsize=(8, 3.5), cmap=\"viridis\")\na.txt.set_position((17, 34.6))\na.ax.set_xlim(16.5, 23)\na.ax.set_ylim(34.5, 37)\na.show(infinity_loop=False)"
       ]
     }
   ],

src/py_eddy_tracker/appli.py

@@ -73,7 +73,7 @@ def __init__(self, eddy, intern=False, sleep_event=0.1, **kwargs):
         self.sleep_event = sleep_event
         self.setup(**kwargs)
 
-    def setup(self, cmap="jet", nb_step=25):
+    def setup(self, cmap="jet", nb_step=25, figsize=(8, 6)):
         cmap = pyplot.get_cmap(cmap)
         self.colors = cmap(arange(nb_step + 1) / nb_step)
         self.nb_step = nb_step
@@ -88,7 +88,7 @@ def setup(self, cmap="jet", nb_step=25):
         y_max += 0.05 * d_y
 
         # plot
-        self.fig = pyplot.figure()
+        self.fig = pyplot.figure(figsize=figsize)
         self.ax = self.fig.add_axes((0.05, 0.05, 0.9, 0.9))
         self.ax.set_xlim(x_min, x_max), self.ax.set_ylim(y_min, y_max)
         self.ax.set_aspect("equal")
@@ -113,6 +113,7 @@ def setup(self, cmap="jet", nb_step=25):
     def show(self, infinity_loop=False):
         pyplot.show(block=False)
         # save background for future bliting
+        self.fig.canvas.draw()
         self.bg_cache = self.fig.canvas.copy_from_bbox(self.ax.bbox)
         loop = True
         t0, t1 = self.period