✨ add functions for working with centroids (#93)

Author: ianardee

README.md

@@ -4,7 +4,7 @@ Quickly and easily connect to Mindee's API services using Python.
 ## Quick Start
 Here's the TL;DR of getting started.
 
-First, get an [API Key](https://developers.mindee.com/docs/make-your-first-request#create-an-api-key)
+First, get an [API Key](https://developers.mindee.com/docs/create-api-key)
 
 Then, install this library:
 ```shell

mindee/geometry.py

@@ -8,6 +8,51 @@
 Quadrilateral = Tuple[Point, Point, Point, Point]
 
 
+def get_centroid(polygon: Polygon) -> Point:
+    """
+    Get the central point (centroid) given a list of points.
+
+    :param polygon: List of Points
+    :return: Point
+    """
+    numb_vertices = len(polygon)
+    x_sum = sum([x for x, _ in polygon])
+    y_sum = sum([y for _, y in polygon])
+    return x_sum / numb_vertices, y_sum / numb_vertices
+
+
+def get_min_max_y(vertices: Polygon) -> Point:
+    """
+    Get the maximum and minimum Y value given a list of points.
+
+    :param vertices: List of points
+    """
+    points = [y for _, y in vertices]
+    return min(points), max(points)
+
+
+def is_point_in_polygon_y(point: Point, polygon: Polygon) -> bool:
+    """
+    Determine if the Point is in the Polygon's Y-axis.
+
+    :param point: Point to compare
+    :param polygon: Polygon to look into
+    """
+    min_y, max_y = get_min_max_y(polygon)
+    return is_point_in_y(point, min_y, max_y)
+
+
+def is_point_in_y(point: Point, min_y: float, max_y: float) -> bool:
+    """
+    Determine if the Point is in the Polygon's Y-axis.
+
+    :param point: Point to compare
+    :param min_y: Minimum Y-axis value
+    :param max_y: Maximum Y-axis value
+    """
+    return min_y <= point[1] <= max_y
+
+
 def get_bbox_as_polygon(polygon: Polygon) -> Quadrilateral:
     """
     Given a sequence of points, calculate a polygon that encompasses all points.

tests/test_geometry.py

@@ -46,3 +46,22 @@ def test_bbox_polygon(polygon_a, polygon_b, polygon_c):
         (0.381, 0.43),
         (0.205, 0.43),
     )
+
+
+def test_is_point_in_polygon_y(polygon_a, polygon_b, polygon_c):
+    # Should be in polygon A & B, since polygons overlap
+    point_a = (0.125, 0.535)
+    # Should only be in polygon C
+    point_b = (0.300, 0.420)
+
+    assert geometry.is_point_in_polygon_y(point_a, polygon_a)
+    assert geometry.is_point_in_polygon_y(point_a, polygon_b)
+    assert geometry.is_point_in_polygon_y(point_a, polygon_c) is False
+
+    assert geometry.is_point_in_polygon_y(point_b, polygon_a) is False
+    assert geometry.is_point_in_polygon_y(point_b, polygon_b) is False
+    assert geometry.is_point_in_polygon_y(point_b, polygon_c)
+
+
+def test_get_centroid(polygon_a):
+    assert geometry.get_centroid(polygon_a) == (0.149, 0.538)