]> Creatis software - CreaPhase.git/blob - octave_packages/geometry-1.5.0/geom2d/edgePosition.m
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / edgePosition.m
1 %% Copyright (c) 2011, INRA
2 %% 2004-2011, David Legland <david.legland@grignon.inra.fr>
3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
4 %%
5 %% All rights reserved.
6 %% (simplified BSD License)
7 %%
8 %% Redistribution and use in source and binary forms, with or without
9 %% modification, are permitted provided that the following conditions are met:
10 %%
11 %% 1. Redistributions of source code must retain the above copyright notice, this
12 %%    list of conditions and the following disclaimer.
13 %%     
14 %% 2. Redistributions in binary form must reproduce the above copyright notice, 
15 %%    this list of conditions and the following disclaimer in the documentation
16 %%    and/or other materials provided with the distribution.
17 %%
18 %% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 %% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 %% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 %% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 %% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
23 %% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 %% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
25 %% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 %% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 %% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 %% POSSIBILITY OF SUCH DAMAGE.
29 %%
30 %% The views and conclusions contained in the software and documentation are
31 %% those of the authors and should not be interpreted as representing official
32 %% policies, either expressed or implied, of copyright holder.
33
34 %% -*- texinfo -*-
35 %% @deftypefn {Function File} {@var{d} = } edgePosition (@var{point}, @var{edge})
36 %% Return position of a point on an edge
37 %%
38 %%   POS = edgePosition(POINT, EDGE);
39 %%   Computes position of point POINT on the edge EDGE, relative to the
40 %%   position of edge vertices.
41 %%   EDGE has the form [x1 y1 x2 y2],
42 %%   POINT has the form [x y], and is assumed to belong to edge.
43 %%   The position POS has meaning:
44 %%     POS<0:    POINT is located before the first vertex
45 %%     POS=0:    POINT is located on the first vertex
46 %%     0<POS<1:  POINT is located between the 2 vertices (on the edge)
47 %%     POS=1:    POINT is located on the second vertex
48 %%     POS<0:    POINT is located after the second vertex
49 %%
50 %%   POS = edgePosition(POINT, EDGES);
51 %%   If EDGES is an array of NL edges, return NL positions, corresponding to
52 %%   each edge.
53 %%
54 %%   POS = edgePosition(POINTS, EDGE);
55 %%   If POINTS is an array of NP points, return NP positions, corresponding
56 %%   to each point.
57 %%
58 %%   POS = edgePosition(POINTS, EDGES);
59 %%   If POINTS is an array of NP points and edgeS is an array of NL edges,
60 %%   return an array of [NP NL] position, corresponding to each couple
61 %%   point-edge.
62 %%
63 %%   @seealso{edges2d, createEdge, onEdge}
64 %% @end deftypefn
65
66 function d = edgePosition(point, edge)
67
68   % number of points and of edges
69   Nl = size(edge, 1);
70   Np = size(point, 1);
71
72   if Np==Nl
73       dxl = edge(:, 3)-edge(:,1);
74       dyl = edge(:, 4)-edge(:,2);
75       dxp = point(:, 1) - edge(:, 1);
76       dyp = point(:, 2) - edge(:, 2);
77
78       d = (dxp.*dxl + dyp.*dyl)./(dxl.*dxl+dyl.*dyl);
79
80   else
81       % expand one of the array to have the same size
82       dxl = repmat((edge(:,3)-edge(:,1))', Np, 1);
83       dyl = repmat((edge(:,4)-edge(:,2))', Np, 1);
84       dxp = repmat(point(:,1), 1, Nl) - repmat(edge(:,1)', Np, 1);
85       dyp = repmat(point(:,2), 1, Nl) - repmat(edge(:,2)', Np, 1);
86
87       d = (dxp.*dxl + dyp.*dyl)./(dxl.*dxl+dyl.*dyl);
88   end
89
90 endfunction
91