wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-07-25 13:30:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add doc string to point in polygon functions

Browse Source
This commit is contained in:
Johannes Schönberger
2012-08-21 15:49:18 +02:00
parent 878554ac35
commit 20afa7edae
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/_shared/geometry.pyx
+26
View File
@@ -6,6 +6,17 @@
cdef inline unsigned char point_in_polygon(int nr_verts, double *xp, double *yp,
double x, double y):
"""Test whether point lies inside a polygon.
Parameters
----------
nr_verts : int
Number of vertices of polygon.
xp, yp : double array
Coordinates of polygon with length nr_verts.
x, y : double
Coordinates of point.
"""
cdef int i
cdef unsigned char c = 0
cdef int j = nr_verts - 1
@@ -22,6 +33,21 @@ cdef inline unsigned char point_in_polygon(int nr_verts, double *xp, double *yp,
cdef void points_in_polygon(int nr_verts, double *xp, double *yp,
int nr_points, double *x, double *y,
unsigned char *result):
"""Test whether points lie inside a polygon.
Parameters
----------
nr_verts : int
Number of vertices of polygon.
xp, yp : double array
Coordinates of polygon with length nr_verts.
nr_points : int
Number of points to test.
x, y : double array
Coordinates of points.
result : unsigned char array
Test results for each point.
"""
cdef int n
for n in range(nr_points):
result[n] = point_in_polygon(nr_verts, xp, yp, x[n], y[n])