Allow float numpy array in BoundingBox.contains (#450)

* Allow float numpy array in BoundingBox.contains

* changelog

* add test for BoundingBox.contains

Author: fm3

webknossos/Changelog.md

@@ -15,6 +15,7 @@ For upgrade instructions, please check the respective *Breaking Changes* section
 ### Changed
 - The `Vec3Int` constructor now asserts that its components are whole numbers also in numpy case. [#434](https://github.com/scalableminds/webknossos-libs/pull/434)
 - Updated scikit-image dependency to 0.18.3. [#435](https://github.com/scalableminds/webknossos-libs/pull/435)
+- `BoundingBox.contains` now also takes float points in numpy arrays. [#450](https://github.com/scalableminds/webknossos-libs/pull/450)
 ### Fixed
 
 ## [0.8.16](https://github.com/scalableminds/webknossos-cuber/releases/tag/v0.8.16) - 2021-09-22

webknossos/tests/test_bounding_box.py

@@ -1,3 +1,4 @@
+import numpy as np
 import pytest
 
 from webknossos.geometry import BoundingBox, Mag
@@ -59,3 +60,17 @@ def test_with_bounds() -> None:
     assert BoundingBox((1, 2, 3), (5, 5, 5)).with_bounds_z(
         new_size_z=10
     ) == BoundingBox((1, 2, 3), (5, 5, 10))
+
+
+def test_contains() -> None:
+
+    assert BoundingBox((1, 1, 1), (5, 5, 5)).contains((2, 2, 2))
+    assert BoundingBox((1, 1, 1), (5, 5, 5)).contains((1, 1, 1))
+
+    # top-left is inclusive, bottom-right is exclusive
+    assert not BoundingBox((1, 1, 1), (5, 5, 5)).contains((6, 6, 6))
+    assert not BoundingBox((1, 1, 1), (5, 5, 5)).contains((20, 20, 20))
+
+    # nd-array may contain float values
+    assert BoundingBox((1, 1, 1), (5, 5, 5)).contains(np.array([5.5, 5.5, 5.5]))
+    assert not BoundingBox((1, 1, 1), (5, 5, 5)).contains(np.array([6.0, 6.0, 6.0]))

webknossos/webknossos/geometry/bounding_box.py

@@ -300,9 +300,16 @@ def align_with_mag(self, mag: Mag, ceil: bool = False) -> "BoundingBox":
             bottomright = align(self.bottomright, np.floor)
         return BoundingBox(topleft, bottomright - topleft)
 
-    def contains(self, coord: Vec3IntLike) -> bool:
-
-        coord = Vec3Int(coord).to_np()
+    def contains(self, coord: Union[Vec3IntLike, np.ndarray]) -> bool:
+        """Check whether a point is inside of the bounding box.
+        Note that the point may have float coordinates in the ndarray case"""
+
+        if isinstance(coord, np.ndarray):
+            assert coord.shape == (
+                3,
+            ), f"Numpy array BoundingBox.contains must have shape (3,), got {coord.shape}."
+        else:
+            coord = Vec3Int(coord).to_np()
 
         return cast(
             bool,