MAINT: Provide domain property for images.

pmgbergen · Oct 31, 2023 · 71bf9bc · 71bf9bc
1 parent 6401fd1
commit 71bf9bc
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/src/darsia/image/image.py b/src/darsia/image/image.py
@@ -664,6 +664,27 @@ def subregion(
 
         return type(self)(img=img, **metadata)
 
+    @property
+    def domain(self) -> tuple:
+        """Physical domain.
+
+        Returns:
+            tuple: collection of coordinates in matrix indexing defining domain
+
+        """
+        if self.space_dim == 1:
+            return (self.origin[0], self.opposite_corner[0])
+        elif self.space_dim == 2:
+            # 1. Row interval, 2. column interval
+            return (
+                self.origin[0],
+                self.opposite_corner[0],
+                self.opposite_corner[1],
+                self.origin[1],
+            )
+        elif self.space_dim == 3:
+            raise NotImplementedError
+
     # ! ---- Arithmetics
 
     def __add__(self, other: Image) -> Image: