octave_packages/geometry-1.5.0/geom2d/medianLine.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2003-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{line} = } medianLine (@var{p1}, @var{p2})
  36 %% @deftypefnx {Function File} {@var{line} = } medianLine (@var{pts})
  37 %% @deftypefnx {Function File} {@var{line} = } medianLine (@var{edge})
  38 %% Create a median line between two points.
  39 %%
  40 %%   Create the median line of points @var{p1} and @var{p2}, that is the line containing
  41 %%   all points located at equal distance of @var{p1} and @var{p2}.
  42 %%
  43 %%   Creates the median line of 2 points, given as a 2*2 array @var{pts}. Array has
  44 %%   the form:
  45 %%   [ [ x1 y1 ] ; [ x2 y2 ] ]
  46 %%
  47 %%   Creates the median of the @var{edge}. @var{edge} is a 1*4 array, containing [X1 Y1]
  48 %%   coordinates of first point, and [X2 Y2], the coordinates of the second
  49 %%   point.
  50 %%
  51 %%   Example
  52 %%
  53 %%  @example
  54 %%   % Draw the median line of two points
  55 %%     P1 = [10 20];
  56 %%     P2 = [30 50];
  57 %%     med = medianLine(P1, P2);
  58 %%     figure; axis square; axis([0 100 0 100]);
  59 %%     drawEdge([P1 P2], 'linewidth', 2, 'color', 'k');
  60 %%     drawLine(med)
  61 %%
  62 %%   % Draw the median line of an edge
  63 %%     P1 = [50 60];
  64 %%     P2 = [80 30];
  65 %%     edge = createEdge(P1, P2);
  66 %%     figure; axis square; axis([0 100 0 100]);
  67 %%     drawEdge(edge, 'linewidth', 2)
  68 %%     med = medianLine(edge);
  69 %%     drawLine(med)
  70 %% @end example
  71 %%
  72 %%   @seealso{lines2d, createLine, orthogonalLine}
  73 %% @end deftypefn
  74
  75 function lin = medianLine(varargin)
  76
  77   nargs = length(varargin);
  78   x0 = 0;
  79   y0 = 0;
  80   dx = 0;
  81   dy = 0;
  82
  83   if nargs == 1
  84       tab = varargin{1};
  85       if size(tab, 2)==2
  86           % input is an array of two points
  87           x0 = tab(1,1);
  88           y0 = tab(1,2);
  89           dx = tab(2,1)-x0;
  90           dy = tab(2,2)-y0;
  91       else
  92           % input is an edge
  93           x0 = tab(:, 1);
  94           y0 = tab(:, 2);
  95           dx = tab(:, 3) - tab(:, 1);
  96           dy = tab(:, 4) - tab(:, 2);
  97       end
  98
  99   elseif nargs==2
 100       % input is given as two points, or two point arrays
 101       p1 = varargin{1};
 102       p2 = varargin{2};
 103       x0 = p1(:, 1);
 104       y0 = p1(:, 2);
 105       dx = bsxfun(@minus, p2(:, 1), x0);
 106       dy = bsxfun(@minus, p2(:, 2), y0);
 107
 108   else
 109       error('Too many input arguments');
 110   end
 111
 112   % compute median using middle point of the edge, and the direction vector
 113   % rotated by 90 degrees counter-clockwise
 114   lin = [bsxfun(@plus, x0, dx/2), bsxfun(@plus, y0, dy/2), -dy, dx];
 115
 116 endfunction
 117
 118 %!shared privpath
 119 %! privpath = [fileparts(which('geom2d_Contents')) filesep() 'private'];
 120
 121 %!test
 122 %!  addpath (privpath,'-end')
 123 %!  p1 = [0 0];
 124 %!  p2 = [10 0];
 125 %!  exp = [5 0 0 10];
 126 %!  lin = medianLine(p1, p2);
 127 %!  assertElementsAlmostEqual(exp, lin);
 128 %!  rmpath (privpath);
 129
 130 %!test
 131 %!  addpath (privpath,'-end')
 132 %!  p1 = [0 0];
 133 %!  p2 = [10 0];
 134 %!  exp = [5 0 0 10];
 135 %!  lin = medianLine([p1 p2]);
 136 %!  assertElementsAlmostEqual(exp, lin);
 137 %!  rmpath (privpath);
 138
 139 %!test
 140 %!  addpath (privpath,'-end')
 141 %!  p1 = [0 0; 10 10];
 142 %!  p2 = [10 0;10 20];
 143 %!  exp = [5 0 0 10; 10 15 -10 0];
 144 %!  lin = medianLine(p1, p2);
 145 %!  assertElementsAlmostEqual(exp, lin);
 146 %!  rmpath (privpath);