colormap-complex 0.1.2__tar.gz → 0.2.0__tar.gz

{colormap_complex-0.1.2 → colormap_complex-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: colormap-complex
-Version: 0.1.2
+Version: 0.2.0
 Summary: Complex / 2d colormap / Domain coloring for matplotlib etc.
 Author-email: 34j <34j.95a2p@simplelogin.com>
 License: Apache-2.0
@@ -18,7 +18,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: colour-science>=0.4.4
@@ -84,7 +84,7 @@ import numpy as np
 lin = np.linspace(-1, 1, 100)
 x, y = np.meshgrid(lin, lin)
 z = x + 1j * y
-c = colormap(type="oklab", scale=True)(z.real, z.imag)
+c = colormap(type="oklab")(z.real, z.imag, scale=True)
 plt.imshow(c, extent=(-1, 1, -1, 1), origin='lower')
 ```
 

{colormap_complex-0.1.2 → colormap_complex-0.2.0}/README.md

@@ -57,7 +57,7 @@ import numpy as np
 lin = np.linspace(-1, 1, 100)
 x, y = np.meshgrid(lin, lin)
 z = x + 1j * y
-c = colormap(type="oklab", scale=True)(z.real, z.imag)
+c = colormap(type="oklab")(z.real, z.imag, scale=True)
 plt.imshow(c, extent=(-1, 1, -1, 1), origin='lower')
 ```
 

{colormap_complex-0.1.2 → colormap_complex-0.2.0}/pyproject.toml

@@ -4,14 +4,14 @@ requires = [ "setuptools" ]
 
 [project]
 name = "colormap-complex"
-version = "0.1.2"
+version = "0.2.0"
 description = "Complex / 2d colormap / Domain coloring for matplotlib etc."
 readme = "README.md"
 license = { text = "Apache-2.0" }
 authors = [
   { name = "34j", email = "34j.95a2p@simplelogin.com" },
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 classifiers = [
   "Development Status :: 2 - Pre-Alpha",
   "Intended Audience :: Developers",
@@ -38,7 +38,7 @@ urls.repository = "https://github.com/34j/colormap-complex"
 dev = [
   "pytest>=8,<9",
   "pytest-cov>=6,<7",
-  "matplotlib>=3.9.4",
+  "matplotlib>=3.10.1",
   "scipy>=1.13.1",
   "python-slugify>=8.0.4",
 ]
@@ -49,6 +49,12 @@ docs = [
   "sphinx-autobuild>=2024,<2025; python_version>='3.11'",
 ]
 
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+colormap_complex = ["**/*.npy"]
+
 [tool.ruff]
 line-length = 100
 lint.select = [

{colormap_complex-0.1.2 → colormap_complex-0.2.0}/src/colormap_complex/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.2"
+__version__ = "0.2.0"
 
 from ._main import ALL_COLORMAPS, ColormapType, colormap, interpnd
 

{colormap_complex-0.1.2 → colormap_complex-0.2.0}/src/colormap_complex/_main.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Any, Callable, Literal, TypeVar
+from typing import Any, Literal, Protocol, TypeVar
 
 import colour
 import numpy as np
@@ -70,6 +70,42 @@ def interpnd(base: NDArray[TBase], *indices: NDArray[np.number]) -> NDArray[TBas
     return base[indices_0] * (1 - indices_p) + base[indices_1] * indices_p
 
 
+class Colormap(Protocol):
+    """Colormap protocol."""
+
+    __name__: str
+
+    def __call__(
+        self,
+        x: NDArray[np.number],
+        y: NDArray[np.number],
+        /,
+        *,
+        scale: bool = False,
+    ) -> NDArray[np.number]:
+        """
+        Colormap function.
+
+        Parameters
+        ----------
+        x : NDArray[np.number]
+            Array of shape (...,)
+        y : NDArray[np.number]
+            Array of shape (...,)
+        scale : bool
+            Whether to scale the input to the range [0, 1].
+
+        Returns
+        -------
+        NDArray[np.number]
+            Colormap of shape (..., 3).
+            The colormap is in the range [0, 1].
+            If colormap is cyclic, x axis corresponds to the cyclic
+            dimension.
+
+        """
+
+
 def colormap(
     *,
     type: Literal[
@@ -87,36 +123,26 @@ def colormap(
         "ziegler",
     ] = "bremm",
     cut_outbound: bool = True,
-    scale: bool = True,
     clip: bool = True,
-) -> Callable[[NDArray[np.number], NDArray[np.number]], NDArray[np.number]]:
+) -> Colormap:
     """
     2D colormap function.
 
     Parameters
     ----------
-    x : NDArray[np.number]
-        Array of shape (...,)
-    y : NDArray[np.number]
-        Array of shape (...,)
     type : Literal['oklab', 'oklch', 'prolab', 'prolch', 'hsv', 'ycbcr',
         'bremm', 'cubediagonal', 'schumann', 'steiger', 'teulingfig2', 'ziegler']
         Type of colormap.
     cut_outbound : bool
         If using CIE XYZ, cut colors that are out of bounds
         for the sRGB color space.
-    scale : bool
-        Whether to scale the input to the range [0, 1].
     clip : bool
         Whether to clip the output to the range [0, 1].
 
     Returns
     -------
-    NDArray[np.number]
-        Colormap of shape (..., 3).
-        The colormap is in the range [0, 1].
-        If colormap is cyclic, x axis corresponds to the cyclic
-        dimension.
+    Colrmap
+        Colormap function.
 
     """
     if type not in ALL_COLORMAPS:
@@ -124,10 +150,13 @@ def colormap(
     if type in _CACHED_COLORMAPS:
         file = Path(__file__).parent / "data" / f"{type}.npy"
         if not file.exists():
-            raise ValueError(f"Unknown colormap: {type}")
+            raise FileNotFoundError("Colormap file not found.")
         colormap = np.load(file) / 255
+        # 512 x 512 x 3
 
-    def inner(x: NDArray[np.number], y: NDArray[np.number]) -> NDArray[np.number]:
+    def inner(
+        x: NDArray[np.number], y: NDArray[np.number], /, *, scale: bool = False
+    ) -> NDArray[np.number]:
         if scale:
             xmin = np.min(x)
             xmax = np.max(x)
@@ -194,4 +223,6 @@ def colormap(
             srgb = np.clip(srgb, 0, 1)
         return srgb
 
+    inner.__name__ = type
+    inner.__doc__ = f"Colormap function of type {type}."
     return inner

colormap_complex-0.2.0/src/colormap_complex/matplotlib.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from typing import Literal
+
+import numpy as np
+from matplotlib.colors import BivarColormapFromImage, ListedColormap
+
+from ._main import Colormap
+
+
+def get_mpl_colormap(colormap: Colormap, /, N: int = 128, M: int = 128) -> BivarColormapFromImage:
+    """
+    Get a matplotlib colormap from a function.
+
+    Parameters
+    ----------
+    colormap : Colormap
+        The colormap function to use.
+    N : int
+        The number of colors in the x axis.
+    M : int
+        The number of colors in the y axis.
+
+    Returns
+    -------
+    BivarColormapFromImage
+        Matplotlib colormap.
+
+    """
+    return BivarColormapFromImage(
+        colormap(np.linspace(0, 1, N)[:, None], np.linspace(0, 1, M)[None, :]),
+        name=colormap.__name__,
+    )
+
+
+def get_mpl_1d_colormap(
+    colormap: Colormap,
+    v: float,
+    /,
+    axis: Literal[0, 1] = 0,
+    N: int = 128,
+) -> ListedColormap:
+    """
+    Get a matplotlib colormap from a function.
+
+    Parameters
+    ----------
+    colormap : Callable[[NDArray[np.number]], NDArray[np.number]]
+        The colormap function to use.
+    v : float
+        The value to use for the colormap.
+    axis : Literal[0, 1]
+        The axis to take the colormap from.
+    N : int
+        The number of colors in the colormap.
+
+    Returns
+    -------
+    BivarColormapFromImage
+        Matplotlib colormap.
+
+    """
+    if axis == 0:
+        x = np.linspace(0, 1, N)
+        y = np.full_like(x, v)
+    else:
+        y = np.linspace(0, 1, N)
+        x = np.full_like(y, v)
+    return ListedColormap(colormap(x, y), name=colormap.__name__)

{colormap_complex-0.1.2 → colormap_complex-0.2.0}/src/colormap_complex.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: colormap-complex
-Version: 0.1.2
+Version: 0.2.0
 Summary: Complex / 2d colormap / Domain coloring for matplotlib etc.
 Author-email: 34j <34j.95a2p@simplelogin.com>
 License: Apache-2.0
@@ -18,7 +18,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: colour-science>=0.4.4
@@ -84,7 +84,7 @@ import numpy as np
 lin = np.linspace(-1, 1, 100)
 x, y = np.meshgrid(lin, lin)
 z = x + 1j * y
-c = colormap(type="oklab", scale=True)(z.real, z.imag)
+c = colormap(type="oklab")(z.real, z.imag, scale=True)
 plt.imshow(c, extent=(-1, 1, -1, 1), origin='lower')
 ```
 

{colormap_complex-0.1.2 → colormap_complex-0.2.0}/src/colormap_complex.egg-info/SOURCES.txt

@@ -4,10 +4,17 @@ pyproject.toml
 setup.py
 src/colormap_complex/__init__.py
 src/colormap_complex/_main.py
+src/colormap_complex/matplotlib.py
 src/colormap_complex/py.typed
 src/colormap_complex.egg-info/PKG-INFO
 src/colormap_complex.egg-info/SOURCES.txt
 src/colormap_complex.egg-info/dependency_links.txt
 src/colormap_complex.egg-info/requires.txt
 src/colormap_complex.egg-info/top_level.txt
+src/colormap_complex/data/bremm.npy
+src/colormap_complex/data/cubediagonal.npy
+src/colormap_complex/data/schumann.npy
+src/colormap_complex/data/steiger.npy
+src/colormap_complex/data/teulingfig2.npy
+src/colormap_complex/data/ziegler.npy
 tests/test_main.py

{colormap_complex-0.1.2 → colormap_complex-0.2.0}/tests/test_main.py

@@ -1,12 +1,13 @@
+from collections.abc import Callable
 from os import environ
 from pathlib import Path
-from typing import Any, Callable
+from typing import Any
 
 import matplotlib.pyplot as plt
 import numpy as np
 import pytest
 from matplotlib.cm import ScalarMappable
-from matplotlib.colors import ListedColormap, Normalize
+from matplotlib.colors import Normalize
 from scipy.special import (
     airy,
     digamma,
@@ -23,6 +24,7 @@ from scipy.special import (
 from slugify import slugify
 
 from colormap_complex import ALL_COLORMAPS, ColormapType, colormap
+from colormap_complex.matplotlib import get_mpl_1d_colormap
 
 CI = environ.get("CI", "false").lower() == "true"
 CACHE_PATH = Path(__file__).parent / ".cache"
@@ -117,17 +119,12 @@ def test_complex_function(
         angle = np.angle(z)
         if magnitude_growth:
             r = np.fmod(np.log(r), 1)
-        c = colormap(type="oklch")(
-            angle / (2 * np.pi),
-            r,
-        )
+        cmap = colormap(type="oklch")
+        c = cmap(angle / (2 * np.pi), r, scale=True)
         ax[2].set_title("f(z) (oklch)")
         cba = fig.colorbar(
             ScalarMappable(
-                norm=Normalize(angle.min(), angle.max()),
-                cmap=ListedColormap(
-                    colormap(type="oklch", scale=False)(np.linspace(0, 1, 256), np.array(0.5))
-                ),
+                norm=Normalize(angle.min(), angle.max()), cmap=get_mpl_1d_colormap(cmap, 0.5)
             ),
             ax=ax[2],
         )
@@ -136,12 +133,7 @@ def test_complex_function(
         cbr = fig.colorbar(
             ScalarMappable(
                 norm=Normalize(0, 1) if magnitude_growth else Normalize(np.min(r), np.max(r)),
-                cmap=ListedColormap(
-                    colormap(type="oklch", scale=False)(
-                        np.array(0.5),
-                        np.linspace(0, 1, 256),
-                    )
-                ),
+                cmap=get_mpl_1d_colormap(cmap, 0.5, axis=1),
             ),
             ax=ax[2],
         )
@@ -149,7 +141,7 @@ def test_complex_function(
             cbr.set_ticks([0, 0.5, 1])
             cbr.set_ticklabels([r"$1$", r"$e^{\frac{1}{2}}$", r"$e$"])
     else:
-        c = colormap(type="oklab")(z.real, z.imag)
+        c = colormap(type="oklab")(z.real, z.imag, scale=True)
         ax[2].set_title("f(z) (oklab)")
     ax[2].imshow(c, extent=(-1, 1, -1, 1), origin="lower")
     for ax_ in ax: