feat(ProcessArea): add area

aviary/_utils/types.py

@@ -551,6 +551,14 @@ def coordinates(
 
         self._coordinates = value
 
+    @property
+    def area(self) -> int:
+        """
+        Returns:
+            area in square meters
+        """
+        return len(self) * self._tile_size ** 2
+
     @classmethod
     def from_bounding_box(
         cls,

docs/how_to_guides/api/how_to_use_the_process_area.md

@@ -124,6 +124,18 @@ We can visualize the process area.
 
 ---
 
+You can access the area of the process area with the `area` attribute.
+
+``` python
+print(process_area.area)
+```
+
+``` title="Output"
+8192
+```
+
+---
+
 A process area is an iterable object, so it supports indexing, length and iteration.
 
 You can access the coordinates of the process area with the index operator.

docs/how_to_guides/api/notebooks/how_to_use_the_process_area.ipynb

@@ -327,6 +327,20 @@
    ],
    "id": "623715cb0e58a824"
   },
+  {
+   "metadata": {},
+   "cell_type": "markdown",
+   "source": "You can access the area of the process area with the `area` attribute.",
+   "id": "f5097de6607f33c1"
+  },
+  {
+   "metadata": {},
+   "cell_type": "code",
+   "outputs": [],
+   "execution_count": null,
+   "source": "print(process_area.area)",
+   "id": "704910cd8ebbd281"
+  },
   {
    "metadata": {},
    "cell_type": "markdown",

tests/_utils/data/data_test_types.py

@@ -3,7 +3,10 @@
 import numpy as np
 
 # noinspection PyProtectedMember
-from aviary._utils.types import BoundingBox
+from aviary._utils.types import (
+    BoundingBox,
+    ProcessArea,
+)
 
 data_test_bounding_box_buffer = [
     # test case 1: buffer_size is 0
@@ -173,3 +176,27 @@
         re.escape('Invalid tile size! tile_size must be positive.'),
     ),
 ]
+
+data_test_process_area_area = [
+    # test case 1: process area has no tiles
+    (
+        ProcessArea(tile_size=128),
+        0,
+    ),
+    # test case 2: process area has one tile
+    (
+        ProcessArea(
+            coordinates=np.array([[-128, -128]], dtype=np.int32),
+            tile_size=128,
+        ),
+        16384,
+    ),
+    # test case 3: process area has four tiles
+    (
+        ProcessArea(
+            coordinates=np.array([[-128, -128], [0, -128], [-128, 0], [0, 0]], dtype=np.int32),
+            tile_size=128,
+        ),
+        65536,
+    ),
+]

tests/_utils/test_types.py

@@ -28,6 +28,7 @@
     data_test_bounding_box_properties_exceptions,
     data_test_bounding_box_quantize,
     data_test_bounding_box_quantize_exceptions,
+    data_test_process_area_area,
     data_test_process_area_init_exceptions,
     data_test_process_area_properties_exceptions,
 )
@@ -342,6 +343,14 @@ def test_process_area_properties_exceptions(
         setattr(process_area, property_, value)
 
 
+@pytest.mark.parametrize(('process_area', 'expected'), data_test_process_area_area)
+def test_process_area_area(
+    process_area: ProcessArea,
+    expected: int,
+) -> None:
+    assert process_area.area == expected
+
+
 def test_process_area_from_bounding_box() -> None:
     x_min = -128
     y_min = -128