Polygons

Polygons(array: _Polygons, normalized: bool = False)

• Description:

  Polygons is a class used to represent multiple polygons. This class provides various methods for manipulating the coordinates of multiple polygons, including normalization, denormalization, clipping, shifting, scaling, converting to convex polygons, converting to minimum bounding rectangles, converting to bounding boxes, and more.

• Parameters

  • array (_Polygons): The coordinates of multiple polygons.
  • normalized (bool): Whether the coordinates of the polygons are normalized, a boolean attribute flag. Defaults to False.

• Attributes

  • normalized: Get the normalization status of the polygons.
  • moments: Get the moments of the polygons.
  • area: Get the total area of the polygons.
  • arclength: Get the total perimeter of the polygons.
  • centroid: Get the centroid of the polygons.
  • boundingbox: Get the bounding box enclosing all polygons.
  • min_circle: Get the minimum enclosing circle of the polygons.
  • min_box: Get the minimum bounding rectangle enclosing all polygons.
  • orientation: Get the orientation of the polygons.
  • min_box_wh: Get the width and height of the minimum bounding rectangle enclosing all polygons.
  • extent: Get the extent of the polygons.
  • solidity: Get the solidity of the polygons.

• Methods

  • copy(): Copy the polygons object.
  • numpy(): Convert the polygons object to a numpy array.
  • normalize(w: float, h: float): Normalize the coordinates of the polygons.
  • denormalize(w: float, h: float): Denormalize the coordinates of the polygons.
  • clip(xmin: int, ymin: int, xmax: int, ymax: int): Clip the polygons.
  • shift(shift_x: float, shift_y: float): Shift the polygons.
  • scale(distance: int, join_style: JOIN_STYLE = JOIN_STYLE.mitre): Scale the polygons.
  • to_convexhull(): Convert the polygons to convex polygons.
  • to_min_boxpoints(): Convert the polygons to the coordinates of the minimum bounding rectangles.
  • to_box(box_mode: str = 'xyxy'): Convert the polygons to bounding boxes.
  • to_list(flatten: bool = False): Convert the polygons to a list.
  • is_empty(threshold: int = 3): Determine if the polygons are empty.

• Class Constructors

  • from_image(image: np.ndarray, mode: int = cv2.RETR_EXTERNAL, method: int = cv2.CHAIN_APPROX_SIMPLE): Get the coordinates of polygons from an image.
  • cat(polygons_list: List["Polygons"]): Concatenate multiple lists of polygons into one list of polygons.

• Example

  import docsaidkit as D
  
  polygons = D.Polygons([
      [[10., 20.], [50, 20.], [50, 80.], [10., 80.]],
      [[60., 20.], [100, 20.], [100, 80.], [60., 80.]]
  ])
  print(polygons)
  # >>> Polygons(
  #   [
  #       Polygon([
  #           [10. 20.]
  #           [50. 20.]
  #           [50. 80.]
  #           [10. 80.]
  #       ]),
  #       Polygon([
  #           [60. 20.]
  #           [100. 20.]
  #           [100. 80.]
  #           [60. 80.]
  #       ])
  #   ]
  # )
  
  polygon1 = polygons.normalize(100, 100)
  print(polygon1)
  # >>> Polygons(
  #   [
  #       Polygon([
  #           [0.1 0.2]
  #           [0.5 0.2]
  #           [0.5 0.8]
  #           [0.1 0.8]
  #       ]),
  #       Polygon([
  #           [0.6 0.2]
  #           [1.  0.2]
  #           [1.  0.8]
  #           [0.6 0.8]
  #       ])
  #   ]
  # )
  
  polygon2 = polygons.denormalize(100, 100)
  print(polygon2)
  # >>> Polygons(
  #   [
  #       Polygon([
  #           [1000. 2000.]
  #           [5000. 2000.]
  #           [5000. 8000.]
  #           [1000. 8000.]
  #       ]),
  #       Polygon([
  #           [6000. 2000.]
  #           [10000. 2000.]
  #           [10000. 8000.]
  #           [6000. 8000.]
  #       ])
  #   ]
  # )
  
  polygon3 = polygons.clip(20, 20, 60, 60)
  print(polygon3)
  # >>> Polygons(
  #   [
  #       Polygon([
  #           [20. 20.]
  #           [50. 20.]
  #           [50. 60.]
  #           [20. 60.]
  #       ]),
  #       Polygon([
  #           [60. 20.]
  #           [60. 20.]
  #           [60. 60.]
  #           [60. 60.]
  #       ])
  #   ]
  # )
  
  polygon4 = polygons.shift(10, 10)
  print(polygon4)
  # >>> Polygons(
  #   [
  #       Polygon([
  #           [20. 30.]
  #           [60. 30.]
  #           [60. 90.]
  #           [20. 90.]
  #       ]),
  #       Polygon([
  #           [ 70.  30.]
  #           [110.  30.]
  #           [110.  90.]
  #           [ 70.  90.]
  #       ])
  #   ]
  # )
  
  
  polygon5 = polygons.scale(10)
  print(polygon5)
  # >>> Polygons(
  #   [
  #       Polygon([
  #           [ 0. 10.]
  #           [60. 10.]
  #           [60. 90.]
  #           [ 0. 90.]
  #       ]),
  #       Polygon([
  #           [ 50.  10.]
  #           [110.  10.]
  #           [110.  90.]
  #           [ 50.  90.]
  #       ])
  #   ]
  # )
  
  polygon6 = polygons.to_convexhull()
  print(polygon6)
  # >>> Polygons(
  #   [
  #       Polygon([
  #           [50. 80.],
  #           [10. 80.],
  #           [10. 20.],
  #           [50. 20.]
  #       ]),
  #       Polygon([
  #           [100.  80.],
  #           [ 60.  80.],
  #           [ 60.  20.],
  #           [100.  20.]
  #       ])
  #   ]
  # )
  
  polygon7 = polygons.to_min_boxpoints()
  print(polygon7)
  # >>> Polygons(
  #   [
  #       Polygon([
  #           [10. 20.]
  #           [50. 20.]
  #           [50. 80.]
  #           [10. 80.]
  #       ]),
  #       Polygon([
  #           [ 60.  20.]
  #           [100.  20.]
  #           [100.  80.]
  #           [ 60.  80.]
  #       ])
  #   ]
  # )
  
  polygon8 = polygons.to_boxes() # notice that the method name is different from Polygon
  print(polygon8)
  # >>> Boxes([[ 10.  20.  50.  80.], [ 60.  20. 100.  80.]]), BoxMode.XYXY
  
  polygon9 = polygons.to_list()
  print(polygon9)
  # >>> [
  #   [
  #       [10.0, 20.0],
  #       [50.0, 20.0],
  #       [50.0, 80.0],
  #       [10.0, 80.0]
  #   ],
  #   [
  #       [60.0, 20.0],
  #       [100.0, 20.0],
  #       [100.0, 80.0],
  #       [60.0, 80.0]
  #   ]
  # ]
  
  polygon10 = polygons.is_empty()
  print(polygon10)
  # >>> [False, False]