kplot 1.1.31__tar.gz → 1.1.32__tar.gz

{kplot-1.1.31 → kplot-1.1.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kplot
-Version: 1.1.31
+Version: 1.1.32
 Summary: a matplotlib wrapper for keyan :-)
 Author: Keyan Gootkin
 Author-email: Keyan Gootkin <keyangootkin@gmail.com>

{kplot-1.1.31 → kplot-1.1.32}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kplot"
-version = "1.1.31"
+version = "1.1.32"
 description = "a matplotlib wrapper for keyan :-)"
 readme = "README.md"
 authors = [

{kplot-1.1.31 → kplot-1.1.32}/src/kplot/cmaps.py

@@ -4,10 +4,12 @@
 from kbasic.typing import Number, Array
 from collections.abc import Iterable
 from typing import Optional
-from matplotlib.pyplot import cm
+from matplotlib.pyplot import cm, gca
 from matplotlib.colors import Colormap, LinearSegmentedColormap, ListedColormap, \
         hex2color, Normalize, LogNorm, FuncNorm, AsinhNorm, PowerNorm, SymLogNorm, \
-        BoundaryNorm, CenteredNorm, TwoSlopeNorm 
+        BoundaryNorm, CenteredNorm, TwoSlopeNorm, ScalarMappable
+from matplotlib.axes_grid1 import make_axes_locatable
+from matplotlib.axes import Axes
 from numpy import uint8, zeros, ndarray, inf, nanmin, nanmax, nanquantile, nanmean, \
         nanstd, absolute, log10, ones, linspace
 from numpy.typing import NDArray
@@ -33,7 +35,9 @@ blue = "#7350E6"
 lightblue = "#AE9FE3"
 shadow = "#B8B7B8"
 manoaskies = LinearSegmentedColormap.from_list("manoaskies", [pink, blue])
-manoaskies_centered = LinearSegmentedColormap.from_list("manoaskies_centered", [lightpink, pink, "#000000", blue, lightblue])
+manoaskies_centered = LinearSegmentedColormap.from_list(
+    "manoaskies_centered", [lightpink, pink, "#000000", blue, lightblue]
+)
 manoaskies_background_blue = "#0C0524"
 pink2grey = LinearSegmentedColormap.from_list("p2g", [pink, shadow])
 grey2black = LinearSegmentedColormap.from_list("g2b", [shadow, "#000000"])
@@ -47,15 +51,56 @@ default_cmap = cm.plasma
 # !==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==
 # >-|===|>                            Functions                            <|===|-<
 # !==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==!==
+def colorbar(
+    z: Optional[Array] = None,
+    cmap: Cmap = default_cmap,
+    norm: Norm | str = 'linear',
+    ax: Optional[Axes] = None,
+    location: str = 'right',
+    size: str | Number = '7%',
+    pad: float = 0.05,
+    ticks: Optional[list] = None,
+    units: Optional[str] = None
+    ) -> None:
+    """docstring"""
+    n = auto_norm(norm, z)
+    ax = ax if ax else gca()
+    divider = make_axes_locatable(ax)
+    cax = divider.append_axes(location, size=size, pad=pad)
+    ax.get_figure().colorbar(
+        ScalarMappable(norm=n, cmap=cmap),
+        cax=cax, ax=ax, ticks=ticks, label=units,
+        orientation = 'vertical' if location in ('right', 'left') else 'horizontal'
+        )
+    if location=='top':
+        cax.xaxis.set_ticks_position('top')
+        cax.xaxis.set_label_position('top')
+
+def parse_color(
+    color,
+    norm='linear',
+    cmap=default_cmap,
+    ):
+    """docstring"""
+    match color:
+        # given an rgb(a)
+        case ((r, g, b) | (r, g, b, a)) if all(type(x) in Number.types for x in color):
+            return color
+        # otherwise assume arrays of numbers want to be color-mapped
+        case x if type(color) in Array.types and type(color[0]) in Number.types:
+            color = [cmap(norm(c)) for c in color]
+        case _:
+            raise NotImplementedError(f"bad color: {color}")
+
 def auto_norm(
-    norm: str,
+    norm: Norm | str,
     frames: Optional[NDArray] = None,
-    vmin: Optional[Number] = None, 
+    vmin: Optional[Number] = None,
     vcenter: Optional[Number] = None,
     vmax: Optional[Number] = None,
-    linear_threshold: Optional[Number] = None,  
+    linear_threshold: Optional[Number] = None,
     saturate: Optional[Number] = None
-) -> Norm:
+    ) -> Norm:
     """A function to create a matplotlib normalization given a set images.
 
     Args:
@@ -69,7 +114,7 @@ def auto_norm(
     Returns:
         matplotlib normalization
     """
-    if type(norm) in Cmap.types: return norm
+    if type(norm) in Norm.types: return norm
     frames = frames[(-inf < frames)&(frames < inf)]
     # set min/max 
     match (frames, vmin, vmax, saturate):

{kplot-1.1.31 → kplot-1.1.32}/src/kplot/image.py

@@ -98,7 +98,9 @@ def show(
     # colorbar
     if colorbar: 
         divider = make_axes_locatable(ax)
-        colorbar_location = colorbar_style.pop("location") if "location" in colorbar_style.keys() else "right"
+        colorbar_location = colorbar_style.pop("location")\
+                            if "location" in colorbar_style.keys()\
+                            else "right"
         cax = divider.append_axes(colorbar_location, **colorbar_style)
         fig.colorbar(img, cax=cax, ax=ax, ticks=cticks, label=units, orientation = 'vertical' if colorbar_location in ('right', 'left') else 'horizontal')
         if colorbar_location=='top':