Use video instead jshtml for eddy animation

Author: AntSimi

examples/08_tracking_manipulation/pet_track_anim_matplotlib_animation.py

@@ -5,13 +5,37 @@
 Run in a terminal this script, which allow to watch eddy evolution
 
 """
+import re
+
 import py_eddy_tracker_sample
 from matplotlib.animation import FuncAnimation
 from numpy import arange
 
 from py_eddy_tracker.appli.gui import Anim
 from py_eddy_tracker.observations.tracking import TrackEddiesObservations
 
+# sphinx_gallery_thumbnail_path = '_static/no_image.png'
+
+
+# %%
+class VideoAnimation(FuncAnimation):
+    def _repr_html_(self, *args, **kwargs):
+        """To get video in html and have a player"""
+        content = self.to_html5_video()
+        return re.sub(
+            r'width="[0-9]*"\sheight="[0-9]*"', 'width="100%" height="100%"', content
+        )
+
+    def save(self, *args, **kwargs):
+        if args[0].endswith("gif"):
+            # In this case gif is use to create thumbnail which are not use but consume same time than video
+            # So we create an empty file, to save time
+            with open(args[0], "w") as _:
+                pass
+            return
+        return super().save(*args, **kwargs)
+
+
 # %%
 # Load experimental atlas, and we select one eddy
 a = TrackEddiesObservations.load_file(
@@ -21,14 +45,12 @@
 
 # %%
 # Run animation
-a = Anim(eddy, intern=True, figsize=(8, 3.5), cmap="magma_r", nb_step=6)
+a = Anim(eddy, intern=True, figsize=(8, 3.5), cmap="magma_r", nb_step=5, dpi=50)
 a.txt.set_position((17, 34.6))
 a.ax.set_xlim(16.5, 23)
 a.ax.set_ylim(34.5, 37)
 
 # arguments to get full animation
-# kwargs = dict(frames=arange(*a.period), interval=50)
-# arguments to reduce compute cost for doucmentation, we display only every 10 days
-kwargs = dict(frames=arange(*a.period)[200:800:10], save_count=60, interval=200)
+kwargs = dict(frames=arange(*a.period)[300:800], interval=90)
 
-ani = FuncAnimation(a.fig, a.func_animation, **kwargs)
+ani = VideoAnimation(a.fig, a.func_animation, **kwargs)

notebooks/python_module/08_tracking_manipulation/pet_track_anim_matplotlib_animation.ipynb

@@ -26,7 +26,18 @@
       },
       "outputs": [],
       "source": [
-        "import py_eddy_tracker_sample\nfrom matplotlib.animation import FuncAnimation\nfrom numpy import arange\n\nfrom py_eddy_tracker.appli.gui import Anim\nfrom py_eddy_tracker.observations.tracking import TrackEddiesObservations"
+        "import re\n\nimport py_eddy_tracker_sample\nfrom matplotlib.animation import FuncAnimation\nfrom numpy import arange\n\nfrom py_eddy_tracker.appli.gui import Anim\nfrom py_eddy_tracker.observations.tracking import TrackEddiesObservations\n# sphinx_gallery_thumbnail_path = '_static/no_image.png'"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "class VideoAnimation(FuncAnimation):\n    def _repr_html_(self, *args, **kwargs):\n        \"\"\"To get video in html and have a player\"\"\"\n        content = self.to_html5_video()\n        return re.sub(\n            r'width=\"[0-9]*\"\\sheight=\"[0-9]*\"', 'width=\"100%\" height=\"100%\"', content\n        )\n\n    def save(self, *args, **kwargs):\n        if args[0].endswith(\"gif\"):\n            # In this case gif is use to create thumbnail which are not use but consume same time than video\n            # So we create an empty file, to save time\n            with open(args[0], \"w\") as _:\n                pass\n            return\n        return super().save(*args, **kwargs)"
       ]
     },
     {
@@ -62,7 +73,7 @@
       },
       "outputs": [],
       "source": [
-        "a = Anim(eddy, intern=True, figsize=(8, 3.5), cmap=\"magma_r\", nb_step=6)\na.txt.set_position((17, 34.6))\na.ax.set_xlim(16.5, 23)\na.ax.set_ylim(34.5, 37)\n\n# arguments to get full animation\n# kwargs = dict(frames=arange(*a.period), interval=50)\n# arguments to reduce compute cost for doucmentation, we display only every 10 days\nkwargs = dict(frames=arange(*a.period)[200:800:10], save_count=60, interval=200)\n\nani = FuncAnimation(a.fig, a.func_animation, **kwargs)"
+        "a = Anim(eddy, intern=True, figsize=(8, 3.5), cmap=\"magma_r\", nb_step=5, dpi=50)\na.txt.set_position((17, 34.6))\na.ax.set_xlim(16.5, 23)\na.ax.set_ylim(34.5, 37)\n\n# arguments to get full animation\n# arguments to reduce compute cost for doucmentation, we display only every 10 days\nkwargs = dict(frames=arange(*a.period)[300:800], interval=90)\n\nani = VideoAnimation(a.fig, a.func_animation, **kwargs)"
       ]
     }
   ],