plotlp 0.1.11__tar.gz → 0.1.12__tar.gz

{plotlp-0.1.11 → plotlp-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: plotlp
-Version: 0.1.11
+Version: 0.1.12
 Summary: A library wrapper around matplotlib for custom plots.
 Requires-Dist: corelp
 Requires-Dist: cycler

{plotlp-0.1.11 → plotlp-0.1.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plotlp"
-version = "0.1.11"
+version = "0.1.12"
 description = "A library wrapper around matplotlib for custom plots."
 readme = "README.md"
 requires-python = ">=3.12"

{plotlp-0.1.11 → plotlp-0.1.12}/src/plotlp/__init__.py

@@ -18,11 +18,13 @@ sources = {
 'cmap': 'plotlp.modules.cmap_LP.cmap',
 'color': 'plotlp.modules.color_LP.color',
 'figure': 'plotlp.modules.figure_LP.figure',
+'gridsubplots': 'plotlp.modules.gridsubplots_LP.gridsubplots',
 'imgfigure': 'plotlp.modules.imgfigure_LP.imgfigure',
 'make_animation': 'plotlp.modules.make_animation_LP.make_animation',
 'plt': 'plotlp.modules.plt_LP.plt',
 'style': 'plotlp.modules.style_LP.style',
-'subplots': 'plotlp.modules.subplots_LP.subplots'
+'subplots': 'plotlp.modules.subplots_LP.subplots',
+'scalebar': 'plotlp.modules.StyledAxes_LP._functions.scalebar'
 }
 
 

{plotlp-0.1.11 → plotlp-0.1.12}/src/plotlp/modules/StyledAxes_LP/StyledAxes.py

@@ -21,6 +21,7 @@ from corelp import prop
 import numpy as np
 from matplotlib.patches import Rectangle
 from mpl_toolkits.axes_grid1.inset_locator import inset_axes
+from plotlp import scalebar as scbar
 
 
 
@@ -61,6 +62,11 @@ class StyledAxes(Axes) :
     def style(self) :
         return self.figure.style
 
+    # Legend
+    def legend(self, *args, **kwargs) :
+        with plt.style.context(self.style):
+            return super().legend(*args, **kwargs)
+
     # Imshow
     def imshow(self, X, *args, barname=None, coordinates=None, **kwargs) :
         with plt.style.context(self.style):
@@ -87,6 +93,12 @@ class StyledAxes(Axes) :
                 cmap = plt.get_cmap(plt.rcParams['image.cmap'])
             return super().pcolormesh(*args, cmap=cmap, **kwargs)
 
+    # Bar
+    def bar(self, *args, **kwargs) :
+        with plt.style.context(self.style):
+            self.polish_grids = True
+            return super().bar(*args, **kwargs)
+
     # Implot
     def implot(self, img, x, y, w, h, zorder=3, **kwargs) :
         newaxe = inset_axes(self, [x, y, w, h], transform=self.transData, zorder=zorder, axes_class=StyledAxes)
@@ -98,6 +110,17 @@ class StyledAxes(Axes) :
         im.set_clip_path(clip_rect)
         return im
 
+    # Scalebar
+    def scalebar(self, *args, **kwargs) :
+        with plt.style.context(self.style):
+            scbar(self, *args, **kwargs)
+
+    # Facecolor
+    def set_facecolor(self, *args, **kwargs) :
+        with plt.style.context(self.style):
+            super().set_facecolor(*args, **kwargs)
+    
+
 
 ### --- Polish functions ---
 
@@ -114,7 +137,7 @@ class StyledAxes(Axes) :
     # grids
     @prop()
     def polish_grids(self) :
-        return len(self.lines) > 0 or len(self.collections) > 0
+        return len(self.lines) > 0 or len(self.collections) > 0 # no grid with patches here
     grid_major = {'linestyle':'-', 'alpha':1}
     grid_minor = {'linestyle':'--', 'alpha':0.5}
     def grids(self) :

plotlp-0.1.12/src/plotlp/modules/StyledAxes_LP/_functions/scalebar.py

@@ -0,0 +1,65 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+
+
+
+# %% Libraries
+import matplotlib.pyplot as plt
+import matplotlib.patches as mpatches
+import numpy as np
+
+# Scalebar
+def scalebar(self, pixel=1., unit=None, length=None, *, loc='lower right', bar_height_frac=0.015, pad_frac=0.05, color="white", fontsize=10, zorder=5, label_pad=4, **kwargs) :
+
+    ax = self
+
+    # Get image dimensions
+    xlim = ax.get_xlim()
+    ylim = ax.get_ylim()
+    img_w = abs(xlim[1] - xlim[0]) # width in pixels
+    img_h = abs(ylim[1] - ylim[0]) # height in pixels
+    x_min, x_max = min(xlim), max(xlim)
+    y_min, y_max = min(ylim), max(ylim)
+
+    # Autoselect bar width
+    if length is None:
+        target_px = img_w * 0.15
+        magnitude = 10 ** np.floor(np.log10(target_px * pixel))
+        for step in [1, 2, 5, 10]:
+            candidate = step * magnitude
+            if candidate / pixel <= target_px * 1.5:
+                length = candidate
+                break
+        else:
+            length = magnitude
+    bar_px = length / pixel # bar length in pixels
+
+    # Bar height
+    bar_h  = img_h * bar_height_frac # bar thickness in pixels
+
+    # Bar padding from barder
+    pad = min(img_w, img_h) * pad_frac
+
+    # Anchor position
+    loc = loc.lower()
+    x0 = x_max - pad - bar_px  if "right" in loc else x_min + pad
+    y0 = y_max - pad - bar_h   if "lower" in loc else y_min + pad
+
+    # Scale bar rectangle
+    bar_rect = mpatches.Rectangle((x0, y0), bar_px, bar_h, linewidth=0, facecolor=color, zorder=zorder)
+    ax.add_patch(bar_rect)
+
+    # Label
+    label_x = x0 + bar_px / 2
+    pt_to_data = (y_max - y_min) / ax.get_window_extent().height * 72 / ax.figure.dpi
+    inverted = ax.yaxis_inverted()
+    if inverted:
+        label_y = y0 - label_pad * pt_to_data   # above bar visually (smaller y)
+        va = "top"
+    else:
+        label_y = y0 + bar_h + label_pad * pt_to_data
+        va = "bottom"
+
+    ax.text(label_x, label_y, f"{length:g} {unit}", color=color, fontsize=fontsize, ha="center", va="bottom", zorder=zorder, fontweight="bold")

{plotlp-0.1.11 → plotlp-0.1.12}/src/plotlp/modules/StyledFigure_LP/StyledFigure.py

@@ -149,6 +149,54 @@ class StyledFigure(Figure) :
     def add_axes(self, *args, **kwargs):
         with plt.style.context(self.style) :
             return super().add_axes(*args, **kwargs)
+    def subplots(self, nrows=1, ncols=1, **kwargs):
+        axs = super().subplots(nrows, ncols, **kwargs)
+        self._axes_grid = np.asarray(axs) # remember the grid
+        return axs
+
+
+
+    @property
+    def merge(self):
+        return _MergeIndexer(self)
+
+    def _normalize_indices(self, idx, size):
+        if isinstance(idx, slice):
+            return list(range(*idx.indices(size)))
+        if isinstance(idx, (list, tuple, np.ndarray)):
+            return list(idx)
+        return [idx]
+
+    def _merge_axes(self, rows, cols):
+
+        if not hasattr(self, "_axes_grid"):
+            raise RuntimeError("merge only works with fig.subplots()")
+
+        grid = self._axes_grid
+        nrows, ncols = grid.shape
+        r = self._normalize_indices(rows, nrows)
+        c = self._normalize_indices(cols, ncols)
+        axes_to_merge = [grid[i, j] for i in r for j in c]
+
+        # gridspec
+        gs = axes_to_merge[0].get_gridspec()
+        rmin, rmax = min(r), max(r) + 1
+        cmin, cmax = min(c), max(c) + 1
+
+        # remove axes
+        for ax in set(axes_to_merge):
+            if ax in self.axes:
+                self.delaxes(ax)
+
+        # create merged axis
+        new_ax = self.add_subplot(gs[rmin:rmax, cmin:cmax])
+
+        # update stored grid
+        for i in r:
+            for j in c:
+                grid[i, j] = new_ax
+
+        return new_ax
 
 
 
@@ -177,7 +225,7 @@ class StyledFigure(Figure) :
                 cax = divider.append_axes("right", **self.cax)
                 cax.is_cbar = True
             cbar = super().colorbar(mappable=mappable, cax=cax, ax=None, **kwargs)
-            if barname is not None :
+            if barname is not None and barname != '':
                 cbar.ax.set_ylabel(barname, **self.barname)
             return cbar
 
@@ -287,6 +335,22 @@ class StyledFigure(Figure) :
 
 
 
+class _MergeIndexer:
+
+    def __init__(self, fig):
+        self.fig = fig
+
+    def __getitem__(self, key):
+
+        if not isinstance(key, tuple):
+            key = (key, slice(None))
+
+        r, c = key
+
+        return self.fig._merge_axes(r, c)
+
+
+
 # %% Test function run
 if __name__ == "__main__":
     from corelp import test

{plotlp-0.1.11 → plotlp-0.1.12}/src/plotlp/modules/cmap_LP/cmap.py

@@ -107,6 +107,7 @@ class Cmap(LinearSegmentedColormap) :
             }
 
         super().__init__(self.name, cdict)
+        self.set_bad(self.bad)
 
 
 
@@ -171,6 +172,11 @@ class Cmap(LinearSegmentedColormap) :
         node = (erfinv(node)/self.nodebase + 1) / 2
         return (np.round(node * 1000)).astype(int)/1000
 
+    # Bad color
+    _bad = "greyLP" #bad color
+    @prop(variable=True)
+    def bad(self) -> str :
+        return color(auto=self._bad)
 
 
 cmaps = {

{plotlp-0.1.11 → plotlp-0.1.12}/src/plotlp/modules/color_LP/color.py

@@ -238,6 +238,10 @@ class Color(str) :
         lum = Color(k, k, k)
         return self.mix(lum, abs(fact))
 
+    # Return string without alpha (Not a color object anymore)
+    @property
+    def noalpha(self) :
+        return self[:-2]
 
 
 colors = {

plotlp-0.1.12/src/plotlp/modules/gridsubplots_LP/gridsubplots.py

@@ -0,0 +1,101 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2026-03-11
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : plotLP
+# Module        : gridsubplots
+
+"""
+Subplots functions that creates a grid of axis (typically for images plots).
+"""
+
+
+
+# %% Libraries
+import matplotlib.gridspec as gridspec
+import matplotlib.ticker as ticker
+import numpy as np
+from plotlp import figure
+
+
+
+# %% Function
+def gridsubplots(nrows, ncols, yticks=None, xticks=None, figsize_ratio=None, **kwargs) :
+    '''
+    Subplots functions that creates a grid of axis (typically for images plots).
+    
+    Parameters
+    ----------
+    nrows : int
+        Number of rows in grid.
+    ncols : int
+        Number of columns in grid.
+    yticks : list
+        List of string corresponding to y labels.
+    xticks : list
+        List of string corresponding to x labels.
+    figsize_ratio : int
+        (x / y) ratio to apply to default figure, if None will use (ncols / nrows).
+    **kwargs : dict
+        key-ward arguments to pass to plotlp.figure function.
+
+    Returns
+    -------
+    fig : StyledFigure
+        figure object.
+    axes : np.array(StyledAxes)
+        axes array.
+
+    Examples
+    --------
+    >>> from plotlp import gridsubplots
+    ...
+    >>> fig, axes = gridsubplots(2, 3, yticks=['1', '2'], xticks=['1', '2', '3'])
+    '''
+
+    figsize_ratio = ncols * 0.93 / nrows if figsize_ratio is None else figsize_ratio
+    fig = figure(figsize_ratio=figsize_ratio, **kwargs)
+    gs = gridspec.GridSpec(nrows, ncols, hspace=0, wspace=0)  # no space between axes
+    axes = np.array([[fig.add_subplot(gs[i, j]) for j in range(ncols)] for i in range(nrows)])
+    if xticks is not None and len(xticks) != ncols : raise SyntaxError('xticks do not have the length of ncols')
+    if yticks is not None and len(yticks) != nrows : raise SyntaxError('yticks do not have the length of nrows')
+
+    for i in range(nrows):
+        for j in range(ncols):
+            ax = axes[i, j]
+            ax.polish_noborders = False
+
+            # remove ticks everywhere
+            ax.xaxis.set_major_locator(ticker.NullLocator())
+            ax.yaxis.set_major_locator(ticker.NullLocator())
+            ax.tick_params(left=False, bottom=False, labelleft=False, labelbottom=False)
+            
+            # bottom border row
+            if i == nrows - 1 and xticks is not None:
+                ax.tick_params(bottom=True, labelbottom=True)
+                ax.xaxis.set_major_locator(MidpointLocator())
+                ax.xaxis.set_major_formatter(ticker.FuncFormatter(lambda x, pos, label=str(xticks[j]): label))
+
+            # left border column  
+            if j == 0 and yticks is not None:
+                ax.tick_params(left=True, labelleft=True)
+                ax.yaxis.set_major_locator(MidpointLocator())
+                ax.yaxis.set_major_formatter(ticker.FuncFormatter(lambda x, pos, label=str(yticks[i]): label))
+        
+    return fig, axes
+
+
+
+class MidpointLocator(ticker.Locator):
+    """Always places a single tick at the midpoint of the current axis limits."""
+    def __call__(self):
+        vmin, vmax = self.axis.get_view_interval()
+        return [(vmin + vmax) / 2]
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

plotlp-0.1.12/src/plotlp/modules/gridsubplots_LP/test_gridsubplots.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2026-03-11
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : plotLP
+# Module        : gridsubplots
+
+"""
+This file allows to test gridsubplots
+
+gridsubplots : Subplots functions that creates a grid of axis (typically for images plots).
+"""
+
+
+
+# %% Libraries
+from corelp import debug
+import pytest
+from plotlp import gridsubplots
+debug_folder = debug(__file__)
+
+
+
+# %% Function test
+def test_function() :
+    '''
+    Test gridsubplots function
+    '''
+    print('Hello world!')
+
+
+
+# %% Instance fixture
+@pytest.fixture()
+def instance() :
+    '''
+    Create a new instance at each test function
+    '''
+    return gridsubplots()
+
+def test_instance(instance) :
+    '''
+    Test on fixture
+    '''
+    pass
+
+
+# %% Returns test
+@pytest.mark.parametrize("args, kwargs, expected, message", [
+    #([], {}, None, ""),
+    ([], {}, None, ""),
+])
+def test_returns(args, kwargs, expected, message) :
+    '''
+    Test gridsubplots return values
+    '''
+    assert gridsubplots(*args, **kwargs) == expected, message
+
+
+
+# %% Error test
+@pytest.mark.parametrize("args, kwargs, error, error_message", [
+    #([], {}, None, ""),
+    ([], {}, None, ""),
+])
+def test_errors(args, kwargs, error, error_message) :
+    '''
+    Test gridsubplots error values
+    '''
+    with pytest.raises(error, match=error_message) :
+        gridsubplots(*args, **kwargs)
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

plotlp-0.1.12/src/plotlp/modules/subplots_LP/_functions/__template__.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+
+
+
+# %% Libraries
+
+
+
+
+# %% Function
+def temp(**kwargs) :
+    '''
+    TODO
+    '''
+
+    print('Hello world!')

{plotlp-0.1.11 → plotlp-0.1.12}/src/plotlp/modules/subplots_LP/subplots.py

@@ -34,8 +34,8 @@ def subplots(*args, **kwargs) :
     -------
     fig : StyledFigure
         Figure.
-    axes : tuple[StyledAxes]
-        tuple of axes.
+    axes : numpy.ndarray[StyledAxes]
+        array of axes.
 
     Examples
     --------