transformnd 0.7.0__tar.gz → 0.7.2__tar.gz

{transformnd-0.7.0 → transformnd-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: transformnd
-Version: 0.7.0
+Version: 0.7.2
 Summary: ND coordinate transformations
 Author: Chris Barnes
 Author-email: Chris Barnes <chris.barnes@gerbi-gmb.de>
@@ -84,7 +84,7 @@ and implements these adapters for a few common types.
 
 See the [tutorial here](https://github.com/clbarnes/transformnd/blob/main/examples/tutorial.py).
 It is a [marimo](https://marimo.io) notebook.
-Open it with `uv run --group tutorial marimo edit examples/tutorial.py`.
+Open it with `uv run --group examples marimo edit examples/tutorial.py`.
 
 ## Implemented transforms
 

{transformnd-0.7.0 → transformnd-0.7.2}/README.md

@@ -29,7 +29,7 @@ and implements these adapters for a few common types.
 
 See the [tutorial here](https://github.com/clbarnes/transformnd/blob/main/examples/tutorial.py).
 It is a [marimo](https://marimo.io) notebook.
-Open it with `uv run --group tutorial marimo edit examples/tutorial.py`.
+Open it with `uv run --group examples marimo edit examples/tutorial.py`.
 
 ## Implemented transforms
 

{transformnd-0.7.0 → transformnd-0.7.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "transformnd"
-version = "0.7.0"
+version = "0.7.2"
 description = "ND coordinate transformations"
 readme = "README.md"
 authors = [{ name = "Chris Barnes", email = "chris.barnes@gerbi-gmb.de" }]
@@ -62,7 +62,7 @@ dev = [
     {include-group = "test"},
     {include-group = "lint"},
     {include-group = "doc"},
-    {include-group = "tutorial"},
+    {include-group = "examples"},
     {include-group = "bench"},
 ]
 test = [
@@ -80,10 +80,12 @@ lint = [
 doc = [
     "pdoc>=16.0.0",
 ]
-tutorial = [
+examples = [
     "marimo>=0.9",
     "matplotlib>=3.10.8",
     "pandas>=3.0.2",
+    "pooch>=1.9.0",
+    "scikit-image>=0.26.0",
 ]
 bench = [
     "pytest-benchmark>=5.2.3",

{transformnd-0.7.0 → transformnd-0.7.2}/src/transformnd/__init__.py

@@ -1,5 +1,11 @@
 """
 .. include:: ../../README.md
+
+You can find some examples here:
+
+- [Tutorial](./examples/tutorial.html)
+- [Image transformation](./examples/image.html)
+
 """
 
 from .base import Transform, TransformSequence, TransformWrapper

{transformnd-0.7.0 → transformnd-0.7.2}/src/transformnd/base.py

@@ -304,6 +304,14 @@ class TransformSequence(Transform[ArrayT], Sequence[Transform[ArrayT]]):
         if not ts:
             raise ValueError("Empty transform sequence")
 
+        for idx, (t1, t2) in enumerate(pairwise(ts)):
+            if t1.ndims.target != t2.ndims.source:
+                raise ValueError(
+                    "Incompatible dimensionality: "
+                    f"transform {idx}'s target is {t1.ndims.target}D "
+                    f"and the next source is {t2.ndims.source}D"
+                )
+
         spaces = Spaces(ts[0].spaces.source, ts[-1].spaces.target)
         ndims = NDims(ts[0].ndims.source, ts[-1].ndims.target)
 

{transformnd-0.7.0 → transformnd-0.7.2}/src/transformnd/transforms/__init__.py

@@ -5,7 +5,7 @@ from .reflection import Reflect
 from .simple import Identity, Scale, Translate
 from .map_axis import MapAxis
 from .bijection import Bijection
-from .project_axis import ProjectAxis, Insert, Remove
+from .project_axis import ProjectAxis
 from .by_dimension import ByDimension, SubTransform
 from .vector_field import Coordinates, Displacements
 from .moving_least_squares import MovingLeastSquares
@@ -15,8 +15,6 @@ __all__ = [
     "Affine",
     "Identity",
     "ProjectAxis",
-    "Insert",
-    "Remove",
     "Reflect",
     "Scale",
     "Translate",

{transformnd-0.7.0 → transformnd-0.7.2}/src/transformnd/transforms/project_axis.py

@@ -1,69 +1,14 @@
 from __future__ import annotations
-from abc import ABC, abstractmethod
-from copy import copy
-from typing import Self, Sequence
+from typing import Self
 
 import numpy as np
 from array_api_compat import array_namespace
 from transformnd.transforms import Affine
 from transformnd.types import NDims, Spaces
-from dataclasses import dataclass
 from ..base import Transform
 from ..types import ArrayT
 
 
-@dataclass(frozen=True, eq=True)
-class BaseOperation(ABC):
-    idx: int
-    """Which axis to apply the operation to."""
-
-    def __post_init__(self):
-        if self.idx < 0:
-            raise ValueError("insert/remove idx must be positive")
-
-    @abstractmethod
-    def check(self, ndim: int) -> int: ...
-
-    @abstractmethod
-    def invert(self) -> BaseOperation: ...
-
-
-@dataclass(frozen=True, eq=True)
-class Insert(BaseOperation):
-    """Component of the `ProjectAxis` transform which inserts a new axis."""
-
-    def check(self, ndim: int) -> int:
-        if self.idx > ndim or self.idx <= -ndim:
-            raise ValueError(
-                f"Index {self.idx} is out of range for dimensionality {ndim}"
-            )
-        return ndim + 1
-
-    def invert(self) -> Remove:
-        return Remove(self.idx)
-
-
-@dataclass(frozen=True, eq=True)
-class Remove(BaseOperation):
-    """Component of the `ProjectAxis` transform which removes an existing axis."""
-
-    def check(self, ndim: int) -> int:
-        if self.idx >= ndim or self.idx <= -ndim:
-            raise ValueError(
-                f"Index {self.idx} is out of range for dimensionality {ndim}"
-            )
-        return ndim - 1
-
-    def invert(self) -> Insert:
-        if self.idx == -1:
-            raise ValueError("Removal of the -1th axis is not invertible")
-        return Insert(self.idx)
-
-
-Operation = Insert | Remove
-"""Insert or remove an axis."""
-
-
 class ProjectAxis(Transform):
     """Transform for adding and removing axes.
 
@@ -72,7 +17,8 @@ class ProjectAxis(Transform):
 
     def __init__(
         self,
-        operations: Sequence[Operation],
+        dropped: set[int] | None = None,
+        created: set[int] | None = None,
         source_ndim: int | None = None,
         target_ndim: int | None = None,
         *,
@@ -84,8 +30,10 @@ class ProjectAxis(Transform):
 
         Parameters
         ----------
-        operations
-            Sequence of operations to apply.
+        dropped
+            Set of INPUT dimension indices to drop, if any.
+        created
+            Set of OUTPUT dimension indices which are new, if any.
         source_ndim
             If omitted, can be inferred from `target_ndim`.
         target_ndim
@@ -99,22 +47,18 @@ class ProjectAxis(Transform):
             Operations are inconsistent with given dimensionality,
             or insufficient dimensionality information was given.
         """
-        self.operations = []
-        self._has_inserts = False
+        self.dropped = dropped or set()
+        self.created = created or set()
 
         if source_ndim is not None:
-            nd = source_ndim
-            for op in operations:
-                nd = op.check(nd)
+            nd = source_ndim - len(self.dropped) + len(self.created)
             if target_ndim is None:
                 target_ndim = nd
             elif target_ndim != nd:
                 raise ValueError("Operations do not match expected target ndim")
 
         elif target_ndim is not None:
-            nd = target_ndim
-            for op in reversed(operations):
-                nd = op.invert().check(nd)
+            nd = target_ndim - len(self.created) + len(self.dropped)
             if source_ndim is None:
                 source_ndim = nd
             elif source_ndim != nd:
@@ -124,20 +68,17 @@ class ProjectAxis(Transform):
             raise ValueError("At least one of source_ndim or target_ndim must be given")
 
         idxs: list[int | None] = list(range(source_ndim))
-        for op in operations:
-            if isinstance(op, Insert):
-                self._has_inserts = True
-                idxs.insert(op.idx, None)
-            elif isinstance(op, Remove):
-                idxs.pop(op.idx)
-            self.operations.append(op)
+        for drop in sorted(self.dropped, reverse=True):
+            idxs.pop(drop)
+        for create in sorted(self.created):
+            idxs.insert(create, None)
         self._idxs = idxs
 
         super().__init__(NDims(source_ndim, target_ndim), spaces=spaces)
 
     def apply(self, coords: ArrayT) -> ArrayT:
         coords = self._validate_coords(coords)
-        if self._has_inserts:
+        if self.created:
             xp = array_namespace(coords)
             out = xp.zeros_like(coords, shape=(xp.shape(coords)[0], self.ndims.target))
             for idx, orig_idx in enumerate(self._idxs):
@@ -149,15 +90,7 @@ class ProjectAxis(Transform):
         return out
 
     def is_identity(self) -> bool:
-        orig: list[int | None] = list(range(self.ndims.source))
-        dims = copy(orig)
-        for op in self.operations:
-            if isinstance(op, Insert):
-                dims.insert(op.idx, None)
-            elif isinstance(op, Remove):
-                dims.pop(op.idx)
-
-        return dims == orig
+        return not self.created and not self.dropped
 
     def to_affine(self) -> Affine | None:
         m = np.eye(self.ndims.source)
@@ -166,7 +99,8 @@ class ProjectAxis(Transform):
 
     def invert(self) -> Self | None:
         return type(self)(
-            [op.invert() for op in reversed(self.operations)],
+            self.created,
+            self.dropped,
             source_ndim=self.ndims.target,
             target_ndim=self.ndims.source,
             spaces=self.spaces.invert(),