jan/masque
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add documentation to Polygon.cut()

Browse Source
This commit is contained in:
jan 2017-09-06 21:03:39 -07:00
parent cea172e7f2
commit 723944018e
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
masque/shapes/polygon.py
View File

@ -177,6 +177,14 @@ class Polygon(Shape):
cut_xs: numpy.ndarray = None, cut_xs: numpy.ndarray = None,
cut_ys: numpy.ndarray = None cut_ys: numpy.ndarray = None
) -> List['Polygon']: ) -> List['Polygon']:
"""
Decomposes the polygon into a list of constituents by cutting along the
specified x and/or y coordinates.
:param cut_xs: list of x-coordinates to cut along (e.g., [1, 1.4, 6])
:param cut_ys: list of y-coordinates to cut along (e.g., [1, 3, 5.4])
:return: List of Polygon objects
"""
import float_raster import float_raster
xy = (self.offset + self.vertices).T xy = (self.offset + self.vertices).T