matplotlib-multicolored-line 0.1.1__tar.gz → 0.2.0__tar.gz

{matplotlib_multicolored_line-0.1.1 → matplotlib_multicolored_line-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matplotlib-multicolored-line
-Version: 0.1.1
+Version: 0.2.0
 Summary: Plot multicolored lines in Matplotlib
 Author-email: 34j <34j.95a2p@simplelogin.com>
 License-Expression: CC0-1.0
@@ -88,13 +88,22 @@ x = 0.9 * np.sin(t)
 y = 0.9 * np.cos(1.6 * t)
 
 fig, ax = plt.subplots()
-lc = colored_line(x, y, t, ax, linewidth=5)
+lc = colored_line(x, y, c=t, ax=ax, linewidth=10)
 fig.colorbar(lc)
 ```
 
 ![Result](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example.jpg)
 
-![Result 2](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example_small.jpg)
+```python
+y = np.random.normal(size=(5, 2))
+c = np.random.normal(size=(5, 2))
+
+fig, ax = plt.subplots()
+lc = colored_line(y, c=c, ax=ax, linewidth=10)
+fig.colorbar(lc)
+```
+
+![Result 2](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example_multiple.jpg)
 
 ## Contributors ✨
 

{matplotlib_multicolored_line-0.1.1 → matplotlib_multicolored_line-0.2.0}/README.md

@@ -62,13 +62,22 @@ x = 0.9 * np.sin(t)
 y = 0.9 * np.cos(1.6 * t)
 
 fig, ax = plt.subplots()
-lc = colored_line(x, y, t, ax, linewidth=5)
+lc = colored_line(x, y, c=t, ax=ax, linewidth=10)
 fig.colorbar(lc)
 ```
 
 ![Result](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example.jpg)
 
-![Result 2](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example_small.jpg)
+```python
+y = np.random.normal(size=(5, 2))
+c = np.random.normal(size=(5, 2))
+
+fig, ax = plt.subplots()
+lc = colored_line(y, c=c, ax=ax, linewidth=10)
+fig.colorbar(lc)
+```
+
+![Result 2](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example_multiple.jpg)
 
 ## Contributors ✨
 

{matplotlib_multicolored_line-0.1.1 → matplotlib_multicolored_line-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "setuptools" ]
 
 [project]
 name = "matplotlib-multicolored-line"
-version = "0.1.1"
+version = "0.2.0"
 description = "Plot multicolored lines in Matplotlib"
 readme = "README.md"
 license = "CC0-1.0"

{matplotlib_multicolored_line-0.1.1 → matplotlib_multicolored_line-0.2.0}/src/matplotlib_multicolored_line/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 from ._main import colored_line
 
 __all__ = ["colored_line"]

{matplotlib_multicolored_line-0.1.1 → matplotlib_multicolored_line-0.2.0}/src/matplotlib_multicolored_line/_main.py

@@ -11,12 +11,11 @@ from numpy.typing import ArrayLike
 
 
 def colored_line(
-    x: ArrayLike,
-    y: ArrayLike,
+    *args: ArrayLike,
     c: ArrayLike,
+    start: ArrayLike = 0.5,
+    end: ArrayLike = 0,
     ax: Axes | None = None,
-    scalex: bool = True,
-    scaley: bool = True,
     **kwargs: Any,
 ) -> LineCollection:
     """
@@ -29,15 +28,19 @@ def colored_line(
 
     Parameters
     ----------
-    x, y : array-like
-        The horizontal and vertical coordinates of the data points.
+    *args : array-like
+        The horizontal and vertical coordinates of the data points
+        of shape (N,) or (N, m).
     c : array-like
         The color values, which should be the same size as x and y.
     ax : matplotlib.axes.Axes, optional
         The axes to plot on. If not provided, the current axes will be used.
-    scalex, scaley : bool
-        These parameters determine if the view limits are adapted to the data limits.
-        The values are passed on to autoscale_view.
+    start : array-like, optional
+        The ratio of the point where the color starts.
+        Should be between 0 and 1.
+    end : array-like, optional
+        The ratio of the point where the color changes.
+        Should be between 0 and 1.
     **kwargs : Any
         Any additional arguments to pass to matplotlib.collections.LineCollection
         constructor. This should not include the array keyword argument because
@@ -56,25 +59,42 @@ def colored_line(
             stacklevel=2,
         )
 
+    # parse args
+    if len(args) == 1:
+        y = args[0]
+        x = np.arange(len(y))
+    elif len(args) == 2:
+        x, y = args
+    else:
+        raise ValueError("Invalid number of arguments. Provide either x and y or just y.")
+
+    # ensure x, y, c are 1D or 2D arrays
+    x, y, c = map(np.asarray, (x, y, c))
+    if x.ndim == 1:
+        x = x[:, None]
+    if y.ndim == 1:
+        y = y[:, None]
+    x, y = np.broadcast_arrays(x, y)
+
+    # (N, m, 2)
     xy = np.stack((x, y), axis=-1)
-    xy_mid = np.concat(
-        (xy[0, :][None, :], (xy[:-1, :] + xy[1:, :]) / 2, xy[-1, :][None, :]), axis=0
+    # (N, m, 2)
+    xy_start = np.concat(
+        (xy[0, :, :][None, :, :], xy[:-1, :, :] * (1 - start) + xy[1:, :, :] * start), axis=0
+    )
+    xy_end = np.concat(
+        (xy[:-1, :, :] * end + xy[1:, :, :] * (1 - end), xy[-1, :][None, :, :]), axis=0
     )
-    segments = np.stack((xy_mid[:-1, :], xy, xy_mid[1:, :]), axis=-2)
-    # Note that segments is [
-    #   [[x[0], y[0]], [x[0], y[0]], [mean(x[0], x[1]), mean(y[0], y[1])]],
-    #   [[mean(x[0], x[1]), mean(y[0], y[1])], [x[1], y[1]], [mean(x[1], x[2]), mean(y[1], y[2])]],
-    #   ...
-    #   [[mean(x[-2], x[-1]), mean(y[-2], y[-1])], [x[-1], y[-1]], [x[-1], y[-1]]]
-    # ]
+    segments = np.stack((xy_start, xy, xy_end), axis=-2)
+    segments = np.reshape(segments, (-1, segments.shape[-2], segments.shape[-1]))
 
-    kwargs["array"] = c
+    kwargs["array"] = c.reshape(-1)
     lc = LineCollection(segments, **kwargs)
 
     # Plot the line collection to the axes
     ax = ax or plt.gca()
     ax.add_collection(lc)
-    ax.autoscale_view(scalex=scalex, scaley=scaley)
+    ax.autoscale_view()
 
     # Return the LineCollection object
     return lc

{matplotlib_multicolored_line-0.1.1 → matplotlib_multicolored_line-0.2.0}/src/matplotlib_multicolored_line.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matplotlib-multicolored-line
-Version: 0.1.1
+Version: 0.2.0
 Summary: Plot multicolored lines in Matplotlib
 Author-email: 34j <34j.95a2p@simplelogin.com>
 License-Expression: CC0-1.0
@@ -88,13 +88,22 @@ x = 0.9 * np.sin(t)
 y = 0.9 * np.cos(1.6 * t)
 
 fig, ax = plt.subplots()
-lc = colored_line(x, y, t, ax, linewidth=5)
+lc = colored_line(x, y, c=t, ax=ax, linewidth=10)
 fig.colorbar(lc)
 ```
 
 ![Result](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example.jpg)
 
-![Result 2](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example_small.jpg)
+```python
+y = np.random.normal(size=(5, 2))
+c = np.random.normal(size=(5, 2))
+
+fig, ax = plt.subplots()
+lc = colored_line(y, c=c, ax=ax, linewidth=10)
+fig.colorbar(lc)
+```
+
+![Result 2](https://raw.githubusercontent.com/34j/matplotlib-multicolored-line/main/example_multiple.jpg)
 
 ## Contributors ✨
 

{matplotlib_multicolored_line-0.1.1 → matplotlib_multicolored_line-0.2.0}/tests/test_main.py

@@ -20,7 +20,7 @@ def test_main() -> None:
     y = 0.9 * np.cos(1.6 * t)
 
     fig, ax = plt.subplots()
-    lc = colored_line(x, y, t, ax, linewidth=10)
+    lc = colored_line(x, y, c=t, ax=ax, linewidth=10)
     fig.colorbar(lc)
     fig.savefig(CACHE_PATH / "example.jpg")
 
@@ -31,6 +31,17 @@ def test_main_small() -> None:
     c = [1, 2, 3, 4, 5]
 
     fig, ax = plt.subplots()
-    lc = colored_line(x, y, c, ax, linewidth=10)
+    lc = colored_line(x, y, c=c, ax=ax, linewidth=10)
     fig.colorbar(lc)
     fig.savefig(CACHE_PATH / "example_small.jpg")
+
+
+def test_multiple() -> None:
+    np.random.seed(0)
+    y = np.random.normal(size=(5, 2))
+    c = np.random.normal(size=(5, 2))
+
+    fig, ax = plt.subplots()
+    lc = colored_line(y, c=c, ax=ax, linewidth=10)
+    fig.colorbar(lc)
+    fig.savefig(CACHE_PATH / "example_multiple.jpg")