octave_packages/geometry-1.5.0/geom2d/angle2Points.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2007-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{alpha} =} angle2Points (@var{p1}, @var{p2})
  36 %% Compute horizontal angle between 2 points
  37 %%
  38 %% @var{p1} and @var{p2} are either [1x2] arrays, or [Nx2] arrays, in this case
  39 %% @var{alpha} is a [Nx1] array. The angle computed is the horizontal angle of
  40 %% the line (@var{p1},@var{p2}).
  41 %%
  42 %% Result is always given in radians, between 0 and 2*pi.
  43 %%
  44 %% @seealso{points2d, angles2d, angle3points, normalizeAngle, vectorAngle}
  45 %% @end deftypefn
  46
  47 function theta = angle2Points(varargin)
  48
  49   % process input arguments
  50   if length(varargin)==2
  51       p1 = varargin{1};
  52       p2 = varargin{2};
  53   elseif length(varargin)==1
  54       var = varargin{1};
  55       p1 = var(1,:);
  56       p2 = var(2,:);
  57   end
  58
  59   % ensure data have correct size
  60   n1 = size(p1, 1);
  61   n2 = size(p2, 1);
  62   if n1~=n2 && min(n1, n2)>1
  63       error('angle2Points: wrong size for inputs');
  64   end
  65
  66   % angle of line (P2 P1), between 0 and 2*pi.
  67   dp = bsxfun(@minus, p2, p1);
  68   theta = mod(atan2(dp(:,2), dp(:,1)) + 2*pi, 2*pi);
  69
  70 endfunction
  71
  72 %!test
  73 %! % all points inside window, possibly touching edges
  74 %! p1 = [0 0];
  75 %! p2 = [10 0];
  76 %! angle_ = angle2Points (p1, p2);
  77 %! assert (angle_,0,1e-6);
  78 %! angle_ = angle2Points (p2, p1);
  79 %! assert (angle_,pi,1e-6);
  80
  81
  82 %!test
  83 %! % all points inside window, possibly touching edges
  84 %! p1 = [0 0];
  85 %! p2 = [0 10];
  86 %! angle_ = angle2Points (p1, p2);
  87 %! assert (pi/2, angle_,1e-6);
  88 %! angle_ = angle2Points (p2, p1);
  89 %! assert (3*pi/2, angle_,1e-6);
  90
  91 %!test
  92 %! % all points inside window, possibly touching edges
  93 %! p1 = [0 0;0 0;0 0;0 0];
  94 %! p2 = [10 0;10 10;0 10;-10 10];
  95 %! angle_ = angle2Points (p1, p2);
  96 %! assert (size (p1, 1), size (angle_, 1));
  97 %! res = [0;pi/4;pi/2;3*pi/4];
  98 %! assert (res, angle_, 1e-6);
  99
 100 %!test
 101 %! % all points inside window, possibly touching edges
 102 %! p1 = [0 0];
 103 %! p2 = [10 0;10 10;0 10;-10 10];
 104 %! angle_ = angle2Points (p1, p2);
 105 %! assert(size (p2, 1), size (angle_, 1));
 106 %! res = [0;pi/4;pi/2;3*pi/4];
 107 %! assert(res, angle_,1e-6);
 108
 109