diplotocus 0.6.0__tar.gz → 0.6.4__tar.gz

{diplotocus-0.6.0 → diplotocus-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diplotocus
-Version: 0.6.0
+Version: 0.6.4
 Summary: A python package to generate animations of matplotlib objects.
 Author-email: Tristan Boin <tristan.boin@obspm.fr>
 License-Expression: MIT

{diplotocus-0.6.0 → diplotocus-0.6.4}/docs/source/notebooks/GUI.ipynb

@@ -13,7 +13,7 @@
     "\n",
     "```{warning}\n",
     "\n",
-    "The GUI might not be as stable as the python interface. Feel free to report any issues you encounters.\n",
+    "The GUI might not be as stable as the python interface and is currently lacking recently added features. Feel free to report any issues you encounter or features you want to see be added in priority.\n",
     "```\n",
     "\n",
     "When running diplotocus through this mode, you will make edit your animation through a local web page in your browser. This page communicates with a python server, which links the GUI and diplotocus objects in the background. Hence, everything you can do through python, you can do through the GUI, and vice versa.\n",

{diplotocus-0.6.0 → diplotocus-0.6.4}/docs/source/notebooks/animations.ipynb

@@ -39,14 +39,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "id": "8292940a",
    "metadata": {},
    "outputs": [
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "e81b7a3356ae4f16a27fae17363df670",
+       "model_id": "2eaf909a7fe44442baed97f7da7c03ed",
        "version_major": 2,
        "version_minor": 0
       },
@@ -74,7 +74,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/animations/anim_translate.mp4?randId=449\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_translate.mp4?randId=322\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -503,6 +503,84 @@
     "tl.save_video('../_static/animations/anim_morph.mp4')"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "543e2a0d",
+   "metadata": {},
+   "source": [
+    "### Subdraw\n",
+    "\n",
+    "```{eval-rst}\n",
+    ".. automethod:: diplotocus.animations.plotObject.subdraw\n",
+    "    :noindex:\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "46a8632c",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "9bfc289f510045839c333aefaa210fdc",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "  0%|          | 0/60 [00:00<?, ?it/s]"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/markdown": [
+       "Saved video ../_static/animations/anim_subdraw.mp4"
+      ],
+      "text/plain": [
+       "<IPython.core.display.Markdown object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/html": [
+       "\n",
+       "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
+       "                <source src=\"../_static/animations/anim_subdraw.mp4?randId=2913\" type=\"video/mp4\">\n",
+       "                </video>\n",
+       "            "
+      ],
+      "text/plain": [
+       "<IPython.core.display.HTML object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "import diplotocus as dpl\n",
+    "import numpy as np\n",
+    "\n",
+    "x = np.linspace(0,2*np.pi,60)\n",
+    "y = np.cos(x)\n",
+    "\n",
+    "tl = dpl.Timeline(xlim=(-1,7),ylim=(-2,2))\n",
+    "\n",
+    "p = dpl.plot(x=x,y=y)\n",
+    "p.subdraw(start_index=0,end_index=5,duration=60)\n",
+    "\n",
+    "tl.animate(p)\n",
+    "tl.save_video('../_static/animations/anim_subdraw.mp4')"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "7d3c9b15",
@@ -513,6 +591,12 @@
     "```{eval-rst}\n",
     ".. automethod:: diplotocus.animations.plotObject.draw\n",
     "    :noindex:\n",
+    "```\n",
+    "\n",
+    "```{note}\n",
+    "\n",
+    "`draw()` is a shorthand animation that subdraws every datapoint from 0 to the current_frame (or reversed if `reverse=True`). It is equivalent to `subdraw('start',0)`.\n",
+    "\n",
     "```"
    ]
   },
@@ -591,6 +675,12 @@
     "```{eval-rst}\n",
     ".. automethod:: diplotocus.animations.plotObject.sequence\n",
     "    :noindex:\n",
+    "```\n",
+    "\n",
+    "```{note}\n",
+    "\n",
+    "`sequence()` is a shorthand animation that only subdraws the datapoint at the current frame index (or reversed if `reverse=True`). It is equivalent to `subdraw(0,0)`.\n",
+    "\n",
     "```"
    ]
   },

diplotocus-0.6.4/src/diplotocus/_version.py

@@ -0,0 +1 @@
+__version__ = "0.6.4"

{diplotocus-0.6.0 → diplotocus-0.6.4}/src/diplotocus/animations.py

@@ -27,6 +27,8 @@ def dealias(mpl_obj,kwargs):
     return kwargs
 
 def to_np_array(obj):
+    if type(obj) == np.ndarray:
+        return obj
     obj = np.array(obj)
     if obj.ndim == 0:
         obj = np.ravel(obj)
@@ -155,56 +157,33 @@ class plotObject:
         data_x = to_np_array(self.x)
         data_y = to_np_array(self.y)
 
-        #First pass to get frame if sequencing
-        for anim in self.anims:
-            if anim['name'] != 'sequence':
-                continue
-            if self.x is None:
-                continue
-            if x < anim['delay'] or x > anim['delay'] + anim['duration']:
-                continue
-            t = self.get_t_from_x(anim,x)
+        i_min,i_max = -1,-1
 
-            if len(data_x.shape) == 1:
-                data_x = data_x.reshape((-1,1))
-                data_y = data_y.reshape((-1,1))
-            
-            _i = max(min(round(t*len(data_x)),len(data_x)-1),0)
-            data_x = data_x[_i]
-            data_y = data_y[_i]
-            kwargs = self.resize_kwargs(kwargs,_i)
+        if 'alpha' in kwargs:
+            alpha = to_np_array(kwargs['alpha'])
+            if np.sum(alpha) == 0:
+                kwargs['alpha'] = 1
 
-        #Second pass to cut points if drawing or erasing
-        i_max = -1
         for anim in self.anims:
-            if anim['name'] != 'draw':
+            if anim['name'] != 'sample':
                 continue
             if self.x is None:
                 continue
             if x < anim['delay'] or x > anim['delay'] + anim['duration']:
                 continue
-            t = self.get_t_from_x(anim,x)
-
-            if 'alpha' in kwargs:
-                alpha = to_np_array(kwargs['alpha'])
-                if np.sum(alpha) == 0:
-                    kwargs['alpha'] = 1
 
-            if anim['reverse']:
-                i_max = max(round((1-t)*len(data_x)),0)
-            else:
-                i_max = min(round(t*len(data_x)),len(data_x))
+            i_min,i_max = self.get_i_min_i_max_sample(anim,x,len(data_x))
             break
         
-        if i_max > 0:
-            data_x = data_x[:i_max]
+        if i_min >= 0 and i_max >= 0:
+            data_x = data_x[i_min:i_max]
             if data_y is not None:
-                data_y = data_y[:i_max]
-            kwargs = self.resize_kwargs(kwargs,list(range(i_max)))
-        elif i_max == 0:
-            data_x = []
-            data_y = []
-            kwargs = self.resize_kwargs(kwargs,None)
+                data_y = data_y[i_min:i_max]
+            if data_x.shape[0] == 1:
+                data_x = data_x.reshape(-1)
+            if data_y.shape[0] == 1:
+                data_y = data_y.reshape(-1)
+            kwargs = self.resize_kwargs(kwargs,list(range(i_min,i_max)))
 
         #Third pass to morph
         for anim in self.anims:
@@ -287,6 +266,26 @@ class plotObject:
         if self.function is not None:
             self.function(data_x,data_y,x,kwargs)
 
+    def get_i_min_i_max_sample(self,anim,x,len_data):
+        if anim['reverse']:
+            _x = anim['duration'] - (x - anim['delay'])
+        else:
+            _x = x - anim['delay']
+        if type(anim['min']) == str and anim['min'] == 'start':
+            i_min = 0
+        else:
+            i_min = int((_x + anim['min'])/anim['duration']*len_data)
+            i_min = max(i_min,0)
+        if type(anim['max']) == str and anim['max'] == 'end':
+            i_max = len_data - 1
+        else:
+            if anim['max'] == anim['min']:
+                i_max = i_min + 1
+            else:
+                i_max = int((_x + anim['max'])/anim['duration']*len_data)
+                i_max = min(i_max,len_data-1)
+        return i_min,i_max
+
     def get_sequential_t(self,i,x,size,anim):
         delay = anim['delay'] + i/size*anim['duration']*(1-anim['subduration'])
         duration = anim['duration']*anim['subduration']
@@ -568,28 +567,7 @@ class plotObject:
         persistent : bool, default=True
             if True, the plot object will continue to be plotted after its last animation has played.
         """
-        if sort is not None:
-            if sort[-1] == 'x':
-                idx = np.argsort(self.x)
-            else:
-                idx = np.argsort(self.y)
-            if sort[0] == '-':
-                idx = idx[::-1]
-            self.x = self.x[idx]
-            self.y = self.y[idx]
-            self.kwargs = self.resize_kwargs(self.kwargs,idx)
-
-        self.anims.append({
-            'name':'draw',
-            'duration':duration,
-            'delay':delay,
-            'easing':easing,
-            'reverse':reverse,
-            'persistent':persistent,
-            'played':False
-        })
-        self.compute_timings()
-        return self
+        return self.subdraw('start',0,duration,reverse,sort,delay,easing,persistent)
     
     def scale(self,start_scale,end_scale,duration,center=None,delay=0,easing=None,persistent=True):
         """Scale a plot object from one size to another.
@@ -820,13 +798,17 @@ class plotObject:
         self.compute_timings()
         return self
     
-    def sequence(self,duration,delay=0,easing=None,persistent=True):
+    def sequence(self,duration,reverse=False,sort=None,delay=0,easing=None,persistent=True):
         """Plot one datapoint or row of the dataset per frame.
 
         Parameters
         ----------
         duration : float
             the number of frames the animation runs from.
+        reverse : bool, default=False
+            if True, removes points sequentially instead of adding points.
+        sort : str, default=None
+            sorts the data to draw it in order. Can be 'x','-x','y','-y' to sort in ascending or descending order.
         delay : float, default=0
             the number of frames after what the animation starts playing.
         easing : callable, optional
@@ -836,11 +818,44 @@ class plotObject:
 
         If the dataset is 1-dimensional, this plots a single datapoint per frame, if 2D, it will plot one row per frame. This animation can be used if you have a predefined list of datapoints you want to animate frame-by-frame.
         """
+        return self.subdraw(0,0,duration,reverse,sort,delay,easing,persistent)
+    
+    def subdraw(self,start_index,end_index,duration,reverse=False,sort=None,delay=0,easing=None,persistent=True):
+        """Plot multiple datapoints or rows of the dataset per frame, in the range 
+        [current_frame_index - start_index;current_frame_index + end_index]
+
+        Parameters
+        ----------
+        start_index : int or str
+            start index around the current frame index for the datapoints to plot. If str, can be 'start' to force
+            the range to start at 0 or 'end' to force it to end at the last datapoint.
+        end_index : int or str
+            end index around the current frame index for the datapoints to plot. If str, can be 'start' to force
+            the range to start at 0 or 'end' to force it to end at the last datapoint.
+        duration : float
+            the number of frames the animation runs from.
+        reverse : bool, default=False
+            if True, removes points sequentially instead of adding points.
+        sort : str, default=None
+            sorts the data to draw it in order. Can be 'x','-x','y','-y' to sort in ascending or descending order.
+        delay : float, default=0
+            the number of frames after what the animation starts playing.
+        easing : callable, optional
+            the easing used for this animation. If None, a linear easing is applied.
+        persistent : bool, default=True
+            if True, the plot object will continue to be plotted after its last animation has played.
+        """
+        if sort is not None:
+            self.sort_data(sort)
+        
         self.anims.append({
-            'name':'sequence',
+            'name':'sample',
+            'min':start_index,
+            'max':end_index,
             'duration':duration,
             'delay':delay,
             'easing':easing,
+            'reverse':reverse,
             'persistent':persistent,
             'played':False
         })
@@ -851,6 +866,8 @@ class plotObject:
         if self.obj is not None and self.base_color is None:
             if isinstance(self.obj,(list,np.ndarray)):
                 self.base_color = self.obj[0].get_color()
+            elif isinstance(self.obj,mpl.patches.Polygon):
+                self.base_color = self.obj.get_fc()
             elif isinstance(self.obj,mpl.container.BarContainer):
                 self.base_color = self.obj[0].get_fc()
             elif hasattr(self.obj,'get_color'):
@@ -933,23 +950,8 @@ class plotObject:
             bbox = mpl.transforms.Bbox.union(bboxes)
             cx = (bbox.x0 + bbox.x1) / 2
             cy = (bbox.y0 + bbox.y1) / 2
-        elif self.mpl_obj_type == mpl.collections.Collection:
-            offsets = self.obj.get_offsets()
-            if len(offsets) == 0:
-                cx,cy = 0,0
-            else:
-                cx = np.mean(offsets[:, 0])
-                cy = np.mean(offsets[:, 1])
-        elif self.mpl_obj_type == mpl.collections.QuadMesh:
-            coords = self.obj.get_coordinates()
-            x0 = np.nanmin(coords[..., 0])
-            x1 = np.nanmax(coords[..., 0])
-            y0 = np.nanmin(coords[..., 1])
-            y1 = np.nanmax(coords[..., 1])
-
-            cx = 0.5 * (x0 + x1)
-            cy = 0.5 * (y0 + y1)
-        elif self.mpl_obj_type == mpl.patches.Rectangle:
+        elif self.mpl_obj_type == mpl.patches.Rectangle and \
+              (self.mpl_plot_type == plt.hist or self.mpl_plot_type == plt.bar):
             rects = self.obj.patches
             if isinstance(rects, list) and len(rects) > 0:
                 centers_x = []
@@ -966,15 +968,51 @@ class plotObject:
                 bbox = self.obj.get_bbox()
                 cx = (bbox.x0 + bbox.x1) / 2
                 cy = (bbox.y0 + bbox.y1) / 2
+        elif self.mpl_obj_type == mpl.patches.Polygon or \
+            self.mpl_obj_type == mpl.patches.Arrow or \
+            self.mpl_obj_type == mpl.patches.Rectangle or \
+            self.mpl_obj_type == mpl.patches.RegularPolygon or \
+            self.mpl_obj_type == mpl.patches.Wedge or \
+            self.mpl_obj_type == mpl.patches.FancyArrow:
+            bbox = self.obj.get_extents()
+            cx = (bbox.x0 + bbox.x1) / 2
+            cy = (bbox.y0 + bbox.y1) / 2
+        elif self.mpl_obj_type == mpl.collections.Collection:
+            offsets = self.obj.get_offsets()
+            if len(offsets) == 0:
+                cx,cy = 0,0
+            else:
+                cx = np.mean(offsets[:, 0])
+                cy = np.mean(offsets[:, 1])
+        elif self.mpl_obj_type == mpl.collections.QuadMesh:
+            coords = self.obj.get_coordinates()
+            x0 = np.nanmin(coords[..., 0])
+            x1 = np.nanmax(coords[..., 0])
+            y0 = np.nanmin(coords[..., 1])
+            y1 = np.nanmax(coords[..., 1])
+
+            cx = 0.5 * (x0 + x1)
+            cy = 0.5 * (y0 + y1)
         elif self.mpl_obj_type == mpl.collections.FillBetweenPolyCollection:
             bboxes = [p.get_extents() for p in self.obj.get_paths() if p.vertices.size]
             bbox = mpl.transforms.Bbox.union(bboxes)
             cx = 0.5 * (bbox.x0 + bbox.x1)
             cy = 0.5 * (bbox.y0 + bbox.y1)
-        elif self.mpl_obj_type == mpl.patches.Circle:
+        elif self.mpl_obj_type == mpl.patches.Circle or self.mpl_obj_type == mpl.patches.Ellipse:
             cx,cy = self.obj.get_center()
         return (cx,cy)
 
+    def sort_data(self,sort):
+        if sort[-1] == 'x':
+            idx = np.argsort(self.x)
+        else:
+            idx = np.argsort(self.y)
+        if sort[0] == '-':
+            idx = idx[::-1]
+        self.x = self.x[idx]
+        self.y = self.y[idx]
+        self.kwargs = self.resize_kwargs(self.kwargs,idx)
+
 class axis_zoom(plotObject):
     """
     Zooms into the axis given a zoom value.
@@ -2038,7 +2076,6 @@ class plot(plotObject):
         self.mpl_obj_type = mpl.lines.Line2D
         self.mpl_plot_type = plt.plot
         super().__init__(easing=easing,axis=axis,*args, **kwargs)
-
         self.x = to_np_array(x)
         self.y = to_np_array(y)
         if self.x.size != self.y.size:
@@ -4298,7 +4335,7 @@ class Arrow(plotObject):
         properties.
     """
     def __init__(self,x,y,dx,dy,width=1.0,easing=None,axis=None, *args, **kwargs):
-        self.mpl_obj_type = mpl.patches.Circle
+        self.mpl_obj_type = mpl.patches.Arrow
         kwargs['x'] = x
         kwargs['y'] = y
         kwargs['dx'] = dx
@@ -4331,7 +4368,7 @@ class Ellipse(plotObject):
         Rotation in degrees anti-clockwise.
     """
     def __init__(self,xy,width,height,angle=0,easing=None,axis=None, *args, **kwargs):
-        self.mpl_obj_type = mpl.patches.Circle
+        self.mpl_obj_type = mpl.patches.Ellipse
         kwargs['xy'] = xy
         kwargs['width'] = width
         kwargs['height'] = height
@@ -4386,7 +4423,7 @@ class FancyArrow(plotObject):
                  length_includes_head=False,head_width=None,head_length=None,
                  shape='full',overhang=0,head_starts_at_zero=False,
                  easing=None,axis=None, *args, **kwargs):
-        self.mpl_obj_type = mpl.patches.Circle
+        self.mpl_obj_type = mpl.patches.FancyArrow
         kwargs['x'] = x
         kwargs['y'] = y
         kwargs['dx'] = dx
@@ -4429,7 +4466,7 @@ class Polygon(plotObject):
         points).
     """
     def __init__(self,xy,closed=True,easing=None,axis=None, *args, **kwargs):
-        self.mpl_obj_type = mpl.patches.Circle
+        self.mpl_obj_type = mpl.patches.Polygon
         kwargs['xy'] = xy
         kwargs['closed'] = closed
         super().__init__(easing=easing,axis=axis,*args, **kwargs)
@@ -4477,7 +4514,7 @@ class Rectangle(plotObject):
         coordinate.
     """
     def __init__(self,xy,width,height,angle=0.0,rotation_point='xy',easing=None,axis=None, *args, **kwargs):
-        self.mpl_obj_type = mpl.patches.Circle
+        self.mpl_obj_type = mpl.patches.Rectangle
         kwargs['xy'] = xy
         kwargs['width'] = width
         kwargs['height'] = height
@@ -4518,7 +4555,7 @@ class RegularPolygon(plotObject):
         The polygon rotation angle (in radians).
     """
     def __init__(self,xy,numVertices,radius=5,orientation=0,easing=None,axis=None, *args, **kwargs):
-        self.mpl_obj_type = mpl.patches.Circle
+        self.mpl_obj_type = mpl.patches.RegularPolygon
         kwargs['xy'] = xy
         kwargs['numVertices'] = numVertices
         kwargs['radius'] = radius
@@ -4548,7 +4585,7 @@ class Wedge(plotObject):
     to outer radius *r*.
     """
     def __init__(self,center,r,theta1,theta2,width=None,easing=None,axis=None, *args, **kwargs):
-        self.mpl_obj_type = mpl.patches.Circle
+        self.mpl_obj_type = mpl.patches.Wedge
         kwargs['center'] = center
         kwargs['r'] = r
         kwargs['theta1'] = theta1
@@ -4757,5 +4794,7 @@ class bar(plotObject):
         if len(data_x) == 0:
             data_x = [0]
             data_y = [0]
+            kwargs['width'] = [0]
+            kwargs['bottom'] = [0]
         obj = self.axis.bar(data_x,data_y,**kwargs)
         self.obj = obj

{diplotocus-0.6.0 → diplotocus-0.6.4}/src/diplotocus.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diplotocus
-Version: 0.6.0
+Version: 0.6.4
 Summary: A python package to generate animations of matplotlib objects.
 Author-email: Tristan Boin <tristan.boin@obspm.fr>
 License-Expression: MIT

diplotocus-0.6.0/src/diplotocus/_version.py

@@ -1 +0,0 @@
-__version__ = "0.6.0"