annotate scripts/geometry/inpolygon.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 956148c0d388
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
1 ## Copyright (C) 2006 Frederick (Rick) A Niles, S�ren Hauberg
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
2 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
4 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6847
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6847
diff changeset
8 ## your option) any later version.
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
9 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
14 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6847
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6847
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
18
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefn {Function File} {[@var{in}, @var{on}] = } inpolygon (@var{x}, @var{y}, @var{xv}, @var{xy})
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
21 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
22 ## For a polygon defined by @code{(@var{xv}, @var{yv})} points, determine
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
23 ## if the points @code{(@var{x}, @var{y})} are inside or outside the polygon.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
24 ## The variables @var{x}, @var{y}, must have the same dimension. The optional
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
25 ## output @var{on} gives the points that are on the polygon.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
26 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
27 ## @end deftypefn
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
28
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
29 ## Author: Frederick (Rick) A Niles <niles@rickniles.com>
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
30 ## Created: 14 November 2006
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
31
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
32 ## Vectorized by S�ren Hauberg <soren@hauberg.org>
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
33
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
34 ## The method for determining if a point is in in a polygon is based on
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
35 ## the algorithm shown on
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
36 ## http://local.wasp.uwa.edu.au/~pbourke/geometry/insidepoly/ and is
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
37 ## credited to Randolph Franklin.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
38
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
39 function [IN, ON] = inpolygon (X, Y, xv, yv)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
40
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
41 if ( !(isreal(X) && isreal(Y) && ismatrix(Y) && ...
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
42 ismatrix(Y) && size_equal(X,Y)) )
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
43 error ("inpolygon: first two arguments must be real matrices of same size");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
44 elseif ( !(isreal(xv) && isreal(yv) && isvector(xv) && ...
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
45 isvector(yv) && size_equal(xv,yv)) )
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
46 error ("inpolygon: last two arguments must be real vectors of same size");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
47 endif
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
48
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
49 npol = length(xv);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
50 do_boundary = (nargout >= 2);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
51
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
52 IN = zeros (size(X), "logical");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
53 if (do_boundary)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
54 ON = zeros (size(X), "logical");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
55 endif
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
56
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
57 j = npol;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
58 for i = 1 : npol
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
59 delta_xv = xv(j) - xv(i);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
60 delta_yv = yv(j) - yv(i);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
61 ## distance = [distance from (X,Y) to edge] * length(edge)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
62 distance = delta_xv .* (Y - yv(i)) - (X - xv(i)) .* delta_yv;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
63 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
64 ## is Y between the y-values of edge i,j
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
65 ## AND (X,Y) on the left of the edge ?
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
66 idx1 = ((yv(i) <= Y & Y < yv(j)) | (yv(j) <= Y & Y < yv(i)) ) & ...
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
67 0 < distance.*delta_yv;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
68 IN (idx1) = !IN (idx1);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
69
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
70 ## Check if (X,Y) are actually ON the boundary of the polygon.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
71 if (do_boundary)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
72 idx2 = ((yv(i) <= Y & Y <= yv(j)) | (yv(j) <= Y & Y <= yv(i))) & ...
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
73 ((xv(i) <= X & X <= xv(j)) | (xv(j) <= X & X <= xv(i))) & ...
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
74 (0 == distance | !delta_xv);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
75 ON (idx2) = true;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
76 endif
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
77 j = i;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
78 endfor
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
79 endfunction
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
80
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
81 %!demo
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
82 %! xv=[ 0.05840, 0.48375, 0.69356, 1.47478, 1.32158, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
83 %! 1.94545, 2.16477, 1.87639, 1.18218, 0.27615, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
84 %! 0.05840 ];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
85 %! yv=[ 0.60628, 0.04728, 0.50000, 0.50000, 0.02015, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
86 %! 0.18161, 0.78850, 1.13589, 1.33781, 1.04650, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
87 %! 0.60628 ];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
88 %! xa=[0:0.1:2.3];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
89 %! ya=[0:0.1:1.4];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
90 %! [x,y]=meshgrid(xa,ya);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
91 %! [IN,ON]=inpolygon(x,y,xv,yv);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
92 %!
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
93 %! inside=IN & !ON;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
94 %! plot(xv,yv)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
95 %! hold on
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
96 %! plot(x(inside),y(inside),"@g")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
97 %! plot(x(~IN),y(~IN),"@m")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
98 %! plot(x(ON),y(ON),"@b")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
99 %! hold off
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
100 %! disp("Green points are inside polygon, magenta are outside,");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
101 %! disp("and blue are on boundary.");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
102
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
103 %!demo
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
104 %! xv=[ 0.05840, 0.48375, 0.69356, 1.47478, 1.32158, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
105 %! 1.94545, 2.16477, 1.87639, 1.18218, 0.27615, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
106 %! 0.05840, 0.73295, 1.28913, 1.74221, 1.16023, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
107 %! 0.73295, 0.05840 ];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
108 %! yv=[ 0.60628, 0.04728, 0.50000, 0.50000, 0.02015, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
109 %! 0.18161, 0.78850, 1.13589, 1.33781, 1.04650, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
110 %! 0.60628, 0.82096, 0.67155, 0.96114, 1.14833, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
111 %! 0.82096, 0.60628];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
112 %! xa=[0:0.1:2.3];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
113 %! ya=[0:0.1:1.4];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
114 %! [x,y]=meshgrid(xa,ya);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
115 %! [IN,ON]=inpolygon(x,y,xv,yv);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
116 %!
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
117 %! inside=IN & ~ ON;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
118 %! plot(xv,yv)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
119 %! hold on
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
120 %! plot(x(inside),y(inside),"@g")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
121 %! plot(x(~IN),y(~IN),"@m")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
122 %! plot(x(ON),y(ON),"@b")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
123 %! hold off
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
124 %! disp("Green points are inside polygon, magenta are outside,");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
125 %! disp("and blue are on boundary.");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
126