Generalized image_grid and border and created arrange module.

Author: henryrobbins

.gitignore

@@ -142,3 +142,6 @@ cython_debug/
 # Example output
 *.ppm
 !examples/colorspace/barn.ppm
+
+# Project planning document
+TODO.md

dmtools/__init__.py

@@ -17,3 +17,4 @@
 from . import colorspace
 from . import netpbm
 from . import sound
+from . import arrange

dmtools/arrange.py

@@ -0,0 +1,49 @@
+import numpy as np
+from typing import List
+
+def image_grid(images: List[np.ndarray], w: int, h: int, b: int,
+               color: int = "white", k: int = 255) -> np.ndarray:
+    """Create a w * h grid of images with a border of width b.
+
+    Args:
+        images (List[np.ndarray]): images (of same dimension) for grid.
+        w (int): number of images in each row of the grid.
+        h (int): number of images in each column of the grid.
+        b (int): width of the border/margin.
+        color (int): color of border {'white', 'black'} (defaults to white).
+        k (int): white point (defaults to 255).
+
+    Returns:
+        np.ndarray: grid layout of the images.
+    """
+    n,m = images[0].shape
+    c = {'white': k, 'black': 0}[color]
+    h_border = c*np.ones((b, w*m + (w+1)*b))
+    v_border = c*np.ones((n, b))
+    grid_layout = h_border
+    p = 0
+    for i in range(h):
+        row = v_border
+        for j in range(w):
+            row = np.hstack((row, images[p]))
+            row = np.hstack((row, v_border))
+            p += 1
+        grid_layout = np.vstack((grid_layout, row))
+        grid_layout = np.vstack((grid_layout, h_border))
+    return grid_layout.astype(int)
+
+
+def border(image: np.ndarray, b: int,
+           color: int = "white", k: int = 255) -> np.ndarray:
+    """Add a border of width b to the image.
+
+    Args:
+        image (Netpbm): Netpbm image to add a border to
+        b (int): width of the border/margin.
+        color (int): color of border {'white', 'black'} (defaults to white).
+        k (int): white point (defaults to 255).
+
+    Returns:
+        np.ndarray: Image with border added.
+    """
+    return image_grid([image], w=1, h=1, b=b, color=color, k=k)

dmtools/netpbm.py

@@ -202,49 +202,3 @@ def read_netpbm(path: str) -> Netpbm:
     else:
         # P4, P5, P6 are the binary (raw) formats
         return _parse_binary_netpbm(path)
-
-
-def image_grid(images: List[Netpbm], w: int, h: int, b: int,
-               color: int = "white") -> Netpbm:
-    """Create a w * h grid of images with a border of width b.
-
-    Args:
-        images (List[Netpbm]): images to be put in the grid (same dimensions).
-        w (int): number of images in each row of the grid.
-        h (int): number of images in each column of the grid.
-        b (int): width of the border/margin.
-        color (int): color of border {'white', 'black'} (defaults to white).
-
-    Returns:
-        Netpbm: grid layout of the images.
-    """
-    n,m = images[0].M.shape
-    k = images[0].k
-    c = {'white': k, 'black': 0}[color]
-    h_border = c*np.ones((b, w*m + (w+1)*b))
-    v_border = c*np.ones((n, b))
-    grid_layout = h_border
-    p = 0
-    for i in range(h):
-        row = v_border
-        for j in range(w):
-            row = np.hstack((row, images[p].M))
-            row = np.hstack((row, v_border))
-            p += 1
-        grid_layout = np.vstack((grid_layout, row))
-        grid_layout = np.vstack((grid_layout, h_border))
-    return Netpbm(P=images[0].P, k=k, M=grid_layout.astype(int))
-
-
-def border(image: Netpbm, b: int, color: int = "white") -> Netpbm:
-    """Add a border of width b to the image
-
-    Args:
-        image (Netpbm): Netpbm image to add a border to
-        b (int): width of the border/margin.
-        color (int): color of border {'white', 'black'} (defaults to white).
-
-    Returns:
-        Netpbm: Image with border added.
-    """
-    return image_grid([image], w=1, h=1, b=b, color=color)

docs/dmtools.rst

@@ -40,3 +40,12 @@ dmtools.sound module
    :members:
    :undoc-members:
    :show-inheritance:
+
+
+dmtools.arrange module
+----------------------
+
+.. automodule:: dmtools.arrange
+   :members:
+   :undoc-members:
+   :show-inheritance: