annotate scripts/geometry/inpolygon.m @ 10549:95c3e38098bf

Untabify .m scripts
author Rik <code@nomad.inbox5.com>
date Fri, 23 Apr 2010 11:28:50 -0700
parents 1bf0ce0930be
children c776f063fefe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
1 ## Copyright (C) 2006, 2007, 2008, 2009 Frederick (Rick) A Niles
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
2 ## and S�ren Hauberg
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
3 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
4 ## This file is part of Octave.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
5 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
6 ## 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
7 ## 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
8 ## 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
9 ## your option) any later version.
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
10 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
11 ## 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
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
14 ## General Public License for more details.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
15 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
16 ## 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
17 ## 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
18 ## <http://www.gnu.org/licenses/>.
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
19
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
20 ## -*- texinfo -*-
7650
eb7bdde776f2 Texinfo fixes
John W. Eaton <jwe@octave.org>
parents: 7125
diff changeset
21 ## @deftypefn {Function File} {[@var{in}, @var{on}] =} inpolygon (@var{x}, @var{y}, @var{xv}, @var{xy})
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
22 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
23 ## 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
24 ## if the points @code{(@var{x}, @var{y})} are inside or outside the polygon.
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
25 ## The variables @var{x}, @var{y}, must have the same dimension. The optional
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
26 ## 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
27 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
28 ## @end deftypefn
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
29
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
30 ## Author: Frederick (Rick) A Niles <niles@rickniles.com>
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
31 ## Created: 14 November 2006
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
32
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
33 ## Vectorized by S�ren Hauberg <soren@hauberg.org>
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
34
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
35 ## 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
36 ## the algorithm shown on
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
37 ## 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
38 ## credited to Randolph Franklin.
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
39
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
40 function [IN, ON] = inpolygon (X, Y, xv, yv)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
41
7125
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
42 if (nargin != 4)
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
43 print_usage ();
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
44 endif
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
45
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
46 if (! (isreal (X) && isreal (Y) && ismatrix (Y) && ismatrix (Y)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
47 && size_equal (X, Y)))
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
48 error ("inpolygon: first two arguments must be real matrices of same size");
7125
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
49 elseif (! (isreal (xv) && isreal (yv) && isvector (xv) && isvector (yv)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
50 && size_equal (xv, yv)))
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
51 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
52 endif
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
53
7125
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
54 npol = length (xv);
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
55 do_boundary = (nargout >= 2);
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 IN = zeros (size(X), "logical");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
58 if (do_boundary)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
59 ON = zeros (size(X), "logical");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
60 endif
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
61
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
62 j = npol;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
63 for i = 1 : npol
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
64 delta_xv = xv(j) - xv(i);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
65 delta_yv = yv(j) - yv(i);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
66 ## distance = [distance from (X,Y) to edge] * length(edge)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
67 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
68 ##
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
69 ## is Y between the y-values of edge i,j
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
70 ## AND (X,Y) on the left of the edge ?
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7650
diff changeset
71 idx1 = (((yv(i) <= Y & Y < yv(j)) | (yv(j) <= Y & Y < yv(i)))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
72 & 0 < distance.*delta_yv);
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
73 IN (idx1) = !IN (idx1);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
74
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
75 ## 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
76 if (do_boundary)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7650
diff changeset
77 idx2 = (((yv(i) <= Y & Y <= yv(j)) | (yv(j) <= Y & Y <= yv(i)))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
78 & ((xv(i) <= X & X <= xv(j)) | (xv(j) <= X & X <= xv(i)))
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
79 & (0 == distance | !delta_xv));
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
80 ON (idx2) = true;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
81 endif
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
82 j = i;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
83 endfor
7125
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
84
6847
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
85 endfunction
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
86
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
87 %!demo
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
88 %! 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
89 %! 1.94545, 2.16477, 1.87639, 1.18218, 0.27615, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
90 %! 0.05840 ];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
91 %! 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
92 %! 0.18161, 0.78850, 1.13589, 1.33781, 1.04650, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
93 %! 0.60628 ];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
94 %! xa=[0:0.1:2.3];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
95 %! ya=[0:0.1:1.4];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
96 %! [x,y]=meshgrid(xa,ya);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
97 %! [IN,ON]=inpolygon(x,y,xv,yv);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
98 %!
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
99 %! inside=IN & !ON;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
100 %! plot(xv,yv)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
101 %! hold on
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
102 %! plot(x(inside),y(inside),"@g")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
103 %! plot(x(~IN),y(~IN),"@m")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
104 %! plot(x(ON),y(ON),"@b")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
105 %! hold off
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
106 %! disp("Green points are inside polygon, magenta are outside,");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
107 %! disp("and blue are on boundary.");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
108
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
109 %!demo
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
110 %! 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
111 %! 1.94545, 2.16477, 1.87639, 1.18218, 0.27615, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
112 %! 0.05840, 0.73295, 1.28913, 1.74221, 1.16023, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
113 %! 0.73295, 0.05840 ];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
114 %! 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
115 %! 0.18161, 0.78850, 1.13589, 1.33781, 1.04650, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
116 %! 0.60628, 0.82096, 0.67155, 0.96114, 1.14833, \
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
117 %! 0.82096, 0.60628];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
118 %! xa=[0:0.1:2.3];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
119 %! ya=[0:0.1:1.4];
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
120 %! [x,y]=meshgrid(xa,ya);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
121 %! [IN,ON]=inpolygon(x,y,xv,yv);
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
122 %!
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
123 %! inside=IN & ~ ON;
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
124 %! plot(xv,yv)
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
125 %! hold on
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
126 %! plot(x(inside),y(inside),"@g")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
127 %! plot(x(~IN),y(~IN),"@m")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
128 %! plot(x(ON),y(ON),"@b")
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
129 %! hold off
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
130 %! disp("Green points are inside polygon, magenta are outside,");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
131 %! disp("and blue are on boundary.");
956148c0d388 [project @ 2007-08-30 07:39:32 by dbateman]
dbateman
parents:
diff changeset
132