summaryrefslogtreecommitdiff
path: root/src/silx/image/_boundingbox.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/silx/image/_boundingbox.py')
-rw-r--r--src/silx/image/_boundingbox.py98
1 files changed, 98 insertions, 0 deletions
diff --git a/src/silx/image/_boundingbox.py b/src/silx/image/_boundingbox.py
new file mode 100644
index 0000000..f114062
--- /dev/null
+++ b/src/silx/image/_boundingbox.py
@@ -0,0 +1,98 @@
+# /*##########################################################################
+#
+# Copyright (c) 2018 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""offer some generic 2D bounding box features
+"""
+
+__authors__ = ["H. Payno"]
+__license__ = "MIT"
+__date__ = "07/09/2019"
+
+from silx.math.combo import min_max
+import numpy
+
+
+class _BoundingBox:
+ """
+ Simple 2D bounding box
+
+ :param tuple bottom_left: (y, x) bottom left point
+ :param tuple top_right: (y, x) top right point
+ """
+
+ def __init__(self, bottom_left, top_right):
+ self.bottom_left = bottom_left
+ self.top_right = top_right
+ self.min_x = bottom_left[1]
+ self.min_y = bottom_left[0]
+ self.max_x = top_right[1]
+ self.max_y = top_right[0]
+
+ def contains(self, item):
+ """
+
+ :param item: bouding box or point. If it is bounding check check if the
+ bottom_left and top_right corner of the given bounding box
+ are inside the current bounding box
+ :type: Union[BoundingBox, tuple]
+ :return:
+ """
+ if isinstance(item, _BoundingBox):
+ return self.contains(item.bottom_left) and self.contains(item.top_right)
+ else:
+ return (self.min_x <= item[1] <= self.max_x) and (
+ self.min_y <= item[0] <= self.max_y
+ )
+
+ def collide(self, bb):
+ """
+ Check if the two bounding box collide
+
+ :param bb: bounding box to compare with
+ :type: :class:BoundingBox
+ :return: True if the two boxes collides
+ :rtype: bool
+ """
+ assert isinstance(bb, _BoundingBox)
+ return (self.min_x < bb.max_x and self.max_x > bb.min_x) and (
+ self.min_y < bb.max_y and self.max_y > bb.min_y
+ )
+
+ @staticmethod
+ def from_points(points):
+ """
+
+ :param numpy.array tuple points: list of points. Should be 2D:
+ [(y1, x1), (y2, x2), (y3, x3), ...]
+ :return: bounding box from two points
+ :rtype: _BoundingBox
+ """
+ if not isinstance(points, numpy.ndarray):
+ points_ = numpy.ndarray(points)
+ else:
+ points_ = points
+ x = points_[:, 1]
+ y = points_[:, 0]
+ x_min, x_max = min_max(x)
+ y_min, y_max = min_max(y)
+ return _BoundingBox(bottom_left=(y_min, x_min), top_right=(y_max, x_max))