iplotx 1.5.1__tar.gz → 1.6.0__tar.gz

{iplotx-1.5.1 → iplotx-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iplotx
-Version: 1.5.1
+Version: 1.6.0
 Summary: Plot networkx from igraph and networkx.
 Project-URL: Homepage, https://github.com/fabilab/iplotx
 Project-URL: Documentation, https://readthedocs.org/iplotx

{iplotx-1.5.1 → iplotx-1.6.0}/docs/source/sg_execution_times.rst

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.069** total execution time for 85 files **from all galleries**:
+**00:00.136** total execution time for 87 files **from all galleries**:
 
 .. container::
 
@@ -32,8 +32,8 @@ Computation times
    * - Example
      - Time
      - Mem (MB)
-   * - :ref:`sphx_glr_gallery_style_plot_custom_vertex.py` (``../../gallery/style/plot_custom_vertex.py``)
-     - 00:00.069
+   * - :ref:`sphx_glr_gallery_style_plot_curved_waypoints.py` (``../../gallery/style/plot_curved_waypoints.py``)
+     - 00:00.136
      - 0.0
    * - :ref:`sphx_glr_gallery_basic_plot_3d.py` (``../../gallery/basic/plot_3d.py``)
      - 00:00.000
@@ -152,6 +152,9 @@ Computation times
    * - :ref:`sphx_glr_gallery_other_plot_animation.py` (``../../gallery/other/plot_animation.py``)
      - 00:00.000
      - 0.0
+   * - :ref:`sphx_glr_gallery_other_plot_bundles.py` (``../../gallery/other/plot_bundles.py``)
+     - 00:00.000
+     - 0.0
    * - :ref:`sphx_glr_gallery_other_plot_constellation.py` (``../../gallery/other/plot_constellation.py``)
      - 00:00.000
      - 0.0
@@ -161,9 +164,6 @@ Computation times
    * - :ref:`sphx_glr_gallery_other_plot_feedbacks.py` (``../../gallery/other/plot_feedbacks.py``)
      - 00:00.000
      - 0.0
-   * - :ref:`sphx_glr_gallery_other_plot_filled_edges.py` (``../../gallery/other/plot_filled_edges.py``)
-     - 00:00.000
-     - 0.0
    * - :ref:`sphx_glr_gallery_other_plot_geomap.py` (``../../gallery/other/plot_geomap.py``)
      - 00:00.000
      - 0.0
@@ -182,6 +182,9 @@ Computation times
    * - :ref:`sphx_glr_gallery_style_plot_arrows.py` (``../../gallery/style/plot_arrows.py``)
      - 00:00.000
      - 0.0
+   * - :ref:`sphx_glr_gallery_style_plot_custom_vertex.py` (``../../gallery/style/plot_custom_vertex.py``)
+     - 00:00.000
+     - 0.0
    * - :ref:`sphx_glr_gallery_style_plot_depthshade.py` (``../../gallery/style/plot_depthshade.py``)
      - 00:00.000
      - 0.0
@@ -194,6 +197,9 @@ Computation times
    * - :ref:`sphx_glr_gallery_style_plot_elements.py` (``../../gallery/style/plot_elements.py``)
      - 00:00.000
      - 0.0
+   * - :ref:`sphx_glr_gallery_style_plot_filled_edges.py` (``../../gallery/style/plot_filled_edges.py``)
+     - 00:00.000
+     - 0.0
    * - :ref:`sphx_glr_gallery_style_plot_four_grids.py` (``../../gallery/style/plot_four_grids.py``)
      - 00:00.000
      - 0.0

iplotx-1.6.0/gallery/style/plot_curved_waypoints.py

@@ -0,0 +1,43 @@
+"""
+Curved waypoints
+================
+
+This example demonstrates the use of curved edge waypoints.
+For straight waypoints, the edge will pass through each waypoint.
+For curved waypoints, they are used as cubic Bezier points to
+interpolate smoothly between.
+
+
+.. tip:
+  The edge will actually pass through the midpoints between two consecutive waypoints.
+"""
+
+import matplotlib.pyplot as plt
+import numpy as np
+import iplotx as ipx
+
+g = {
+    "edges": [
+        ("A", "B"),
+    ],
+}
+layout = {
+    "A": (0, 0),
+    "B": (1, 2),
+}
+
+fig, axs = plt.subplots(1, 2, figsize=(8, 4))
+for ax, curved in zip(axs, [False, True]):
+    ipx.network(
+        g,
+        layout=layout,
+        ax=ax,
+        vertex_labels=True,
+        edge_waypoints=[[[1, 1], [0, 1.5]]],
+        edge_curved=curved,
+    )
+    if not curved:
+        ax.set_title("Straight waypoints")
+    else:
+        ax.set_title("Curved waypoints")
+fig.tight_layout()

{iplotx-1.5.1 → iplotx-1.6.0}/iplotx/edge/__init__.py

@@ -367,21 +367,13 @@ class EdgeCollection(mpl.collections.PatchCollection):
 
             # Leaf rotation
             edge_stylei = rotate_style(self._style, index=i, key=(v1, v2))
-            if edge_stylei.get("curved", False):
-                tension = edge_stylei.get("tension", 5)
-                ports = edge_stylei.get("ports", (None, None))
-            elif edge_stylei.get("arc", False):
-                tension = edge_stylei.get("tension", 1)
-                ports = None
-            else:
-                tension = 0
-                ports = None
 
             # Scale shrink by dpi
             dpi = self.figure.dpi if hasattr(self, "figure") else 72.0
             shrink = dpi / 72.0 * edge_stylei.pop("shrink", 0)
 
-            # False is a synonym for "none"
+            # Edge geometry and waypoints
+            # waypoints: False is a synonym for "none"
             waypoints = edge_stylei.get("waypoints", "none")
             if waypoints is False or waypoints is np.False_:
                 waypoints = "none"
@@ -391,10 +383,32 @@ class EdgeCollection(mpl.collections.PatchCollection):
                 raise ValueError(
                     "Could not determine automatically type of edge waypoints.",
                 )
-            if waypoints != "none":
-                ports = edge_stylei.get("ports", (None, None))
 
+            # Waypoints, curved, and arc have a complex logic
+            # TODO: This could be simplified I suppose
+            has_waypoints = waypoints != "none"
+            curved = edge_stylei.get("curved", False)
             arc = edge_stylei.get("arc", False)
+            ports = edge_stylei.get("ports", (None, None))
+
+            # For now, we establish a hierarchy from the most specialised to
+            # the most common cases. Each specialisation silences lower levels
+            # Tension and ports are entirely enslaved to the
+            # waypoint/arc/curved geometry settings.
+            # NOTE: The idea here is to not punish users for slight style
+            # inconsistencies that may well stem from fallback libraries
+            if has_waypoints:
+                tension = 0
+                arc = False
+            elif arc:
+                tension = edge_stylei.get("tension", 1)
+                ports = None
+                curved = False
+            elif curved:
+                tension = edge_stylei.get("tension", 5)
+            else:
+                tension = 0
+                ports = None
 
             # Compute actual edge path
             path, angles = _compute_edge_path(
@@ -406,6 +420,7 @@ class EdgeCollection(mpl.collections.PatchCollection):
                 tension=tension,
                 waypoints=waypoints,
                 ports=ports,
+                curved=curved,
                 arc=arc,
                 layout_coordinate_system=self._vertex_collection.get_layout_coordinate_system(),
                 shrink=shrink,

{iplotx-1.5.1 → iplotx-1.6.0}/iplotx/edge/geometry.py

@@ -239,6 +239,7 @@ def _compute_edge_path_straight(
 
 def _compute_edge_path_waypoints(
     waypoints,
+    curved,
     vcoord_data,
     vpath_fig,
     vsize_fig,
@@ -277,8 +278,19 @@ def _compute_edge_path_waypoints(
                 + vcoord_fig[i]
             )
 
-        points = [vshorts[0]] + list(waypoints) + [vshorts[1]]
-        codes = ["MOVETO"] + ["LINETO"] * len(waypoints) + ["LINETO"]
+        if not curved:
+            points = [vshorts[0]] + list(waypoints) + [vshorts[1]]
+            codes = ["MOVETO"] + ["LINETO"] * len(waypoints) + ["LINETO"]
+        else:
+            points = [vshorts[0]]
+            for i, waypoint in enumerate(waypoints):
+                if i != 0:
+                    points.append(0.5 * (points[-1] + waypoint))
+                points.append(waypoint)
+                points.append(waypoint)
+            points.append(vshorts[1])
+            codes = ["MOVETO"] + ["CURVE4"] * (len(points) - 1)
+
         angles = tuple(thetas)
 
     elif waypoints in ("x0y1", "y0x1"):
@@ -587,6 +599,7 @@ def _compute_edge_path(
     tension: float = 0,
     waypoints: str | tuple[float, float] | Sequence[tuple[float, float]] | np.ndarray = "none",
     ports: Pair[Optional[str]] = (None, None),
+    curved: bool = False,
     arc: bool = False,
     layout_coordinate_system: str = "cartesian",
     **kwargs,
@@ -600,6 +613,7 @@ def _compute_edge_path(
     if waypoints != "none":
         return _compute_edge_path_waypoints(
             waypoints,
+            curved,
             *args,
             layout_coordinate_system=layout_coordinate_system,
             ports=ports,

{iplotx-1.5.1 → iplotx-1.6.0}/iplotx/version.py

@@ -2,4 +2,4 @@
 iplotx version information module.
 """
 
-__version__ = "1.5.1"
+__version__ = "1.6.0"

{iplotx-1.5.1 → iplotx-1.6.0}/tests/test_edge_geometry.py

@@ -62,6 +62,7 @@ def test_compute_waypoints(args_make_paths, waypoints, expected):
     vpath, trans, trans_inv = args_make_paths
     epath, angles = geometry._compute_edge_path_waypoints(
         waypoints,
+        False,
         [[0, 0], [10, 5]],
         [vpath] * 2,
         (2, 2),
@@ -77,6 +78,7 @@ def test_compute_waypoints_port(args_make_paths):
     vpath, trans, trans_inv = args_make_paths
     epath, angles = geometry._compute_edge_path_waypoints(
         "x0y1",
+        False,
         [[0, 0], [10, 5]],
         [vpath] * 2,
         (2, 2),
@@ -100,6 +102,7 @@ def test_double_waypoints(args_make_paths, waypoints, expected):
     vpath, trans, trans_inv = args_make_paths
     epath, angles = geometry._compute_edge_path_waypoints(
         waypoints,
+        False,
         [[0, 0], [10, 5]],
         [vpath] * 2,
         (2, 2),
@@ -123,6 +126,7 @@ def test_double_waypoints_ports(args_make_paths, waypoints, expected, port):
     vpath, trans, trans_inv = args_make_paths
     epath, angles = geometry._compute_edge_path_waypoints(
         waypoints,
+        False,
         [[0, 0], [10, 5]],
         [vpath] * 2,
         (2, 2),

{iplotx-1.5.1 → iplotx-1.6.0}/tests/test_simple_network_provider.py

@@ -134,3 +134,25 @@ class GraphTestRunner(unittest.TestCase):
                 }
             },
         )
+
+    @image_comparison(baseline_images=["curved_waypoints"], remove_text=True)
+    def test_curved_waypoints(self):
+        g = {
+            "edges": [
+                ("A", "B"),
+            ],
+        }
+        layout = {
+            "A": (0, 0),
+            "B": (1, 2),
+        }
+
+        fig, ax = plt.subplots(figsize=(3, 3))
+        ipx.network(
+            g,
+            layout=layout,
+            ax=ax,
+            vertex_labels=True,
+            edge_waypoints=[[[1, 1], [0, 1.5]]],
+            edge_curved=True,
+        )