get_rectangle_centroid

pyhelpers.geom.get_rectangle_centroid(rectangle, as_geom=False)

Gets coordinates of the centroid of a rectangle.

Parameters:

• rectangle (list | tuple | numpy.ndarray | shapely.geometry.Polygon | shapely.geometry.MultiPolygon) – Variable/object representing a rectangle.

• as_geom (bool) – Whether to return a shapely.geometry.Point object; defaults to False.

Returns:

Coordinates of the centroid of the rectangle.

Return type:

numpy.ndarray | shapely.geometry.Point

Examples:

>>> from pyhelpers.geom import get_rectangle_centroid
>>> from shapely.geometry import Polygon
>>> import numpy
>>> coords_1 = [[0, 0], [0, 1], [1, 1], [1, 0]]
>>> rectangle = Polygon(coords_1)
>>> rectangle_centroid = get_rectangle_centroid(rectangle)
>>> rectangle_centroid
array([0.5, 0.5])
>>> rectangle = numpy.array(coords_1)
>>> rectangle_centroid = get_rectangle_centroid(rectangle)
>>> rectangle_centroid
array([0.5, 0.5])
>>> rectangle_centroid = get_rectangle_centroid(rectangle, as_geom=True)
>>> type(rectangle_centroid)
shapely.geometry.point.Point
>>> rectangle_centroid.wkt
'POINT (0.5 0.5)'
>>> rectangle = [[(0, 0), (0, 1), (1, 1), (1, 0)], [(1, 1), (1, 2), (2, 2), (2, 1)]]
>>> rectangle_centroid = get_rectangle_centroid(rectangle)
>>> rectangle_centroid
array([1., 1.])