Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / distancePointLine.m

diff --git a/octave_packages/geometry-1.5.0/geom2d/distancePointLine.m b/octave_packages/geometry-1.5.0/geom2d/distancePointLine.m
new file mode 100644 (file)
index 0000000..604dc29
--- /dev/null
+++ b/octave_packages/geometry-1.5.0/geom2d/distancePointLine.m
@@ -0,0 +1,77 @@
+%% Copyright (c) 2011, INRA
+%% 2004-2011, David Legland <david.legland@grignon.inra.fr>
+%% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
+%%
+%% All rights reserved.
+%% (simplified BSD License)
+%%
+%% Redistribution and use in source and binary forms, with or without
+%% modification, are permitted provided that the following conditions are met:
+%%
+%% 1. Redistributions of source code must retain the above copyright notice, this
+%%    list of conditions and the following disclaimer.
+%%     
+%% 2. Redistributions in binary form must reproduce the above copyright notice, 
+%%    this list of conditions and the following disclaimer in the documentation
+%%    and/or other materials provided with the distribution.
+%%
+%% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+%% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+%% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+%% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+%% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+%% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+%% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+%% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+%% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+%% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+%% POSSIBILITY OF SUCH DAMAGE.
+%%
+%% The views and conclusions contained in the software and documentation are
+%% those of the authors and should not be interpreted as representing official
+%% policies, either expressed or implied, of copyright holder.
+
+%% -*- texinfo -*-
+%% @deftypefn {Function File} {@var{dist} = } distancePointLine (@var{point}, @var{line})
+%% Minimum distance between a point and a line
+%%
+%%   D = distancePointLine(POINT, LINE)
+%%   Return the euclidean distance between line LINE and point POINT. 
+%%
+%%   LINE has the form : [x0 y0 dx dy], and POINT is [x y].
+%%
+%%   If LINE is N-by-4 array, result is N-by-1 array computes for each line.
+%%
+%%   If POINT is N-by-2, then result is computed for each point.
+%%
+%%   If both POINT and LINE are array, result is N-by-1, computed for each
+%%   corresponding point and line.
+%%
+%%
+%%   @seealso{lines2d, points2d, distancePoints, distancePointEdge}
+%% @end deftypefn
+
+function dist = distancePointLine(point, line)
+
+  if size(line, 1)==1 && size(point, 1)>1
+      line = repmat(line, [size(point, 1) 1]);
+  end
+
+  if size(point, 1)==1 && size(line, 1)>1
+      point = repmat(point, [size(line, 1) 1]);
+  end
+
+  dx = line(:, 3);
+  dy = line(:, 4);
+
+  % compute position of points projected on line
+  tp = ((point(:, 2) - line(:, 2)).*dy + (point(:, 1) - line(:, 1)).*dx) ./ (dx.*dx+dy.*dy);
+  p0 = line(:, 1:2) + [tp tp].*[dx dy];
+
+
+  % compute distances between points and their projections
+  dx = point - p0;
+  dist  = sqrt(sum(dx.*dx, 2));
+
+endfunction
+