octave_packages/geometry-1.5.0/geom2d/lineAngle.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{theta} =} lineAngle(varargin)
  36 %% Computes angle between two straight lines
  37 %%
  38 %%   A = lineAngle(LINE);
  39 %%   Returns the angle between horizontal, right-axis and the given line.
  40 %%   Angle is fiven in radians, between 0 and 2*pi, in counter-clockwise
  41 %%   direction.
  42 %%
  43 %%   A = lineAngle(LINE1, LINE2);
  44 %%   Returns the directed angle between the two lines. Angle is given in
  45 %%   radians between 0 and 2*pi, in counter-clockwise direction.
  46 %%
  47 %% @seealso{lines2d, angles2d, createLine, normalizeAngle}
  48 %% @end deftypefn
  49
  50 function theta = lineAngle(varargin)
  51
  52   nargs = length(varargin);
  53   if nargs == 1
  54       % angle of one line with horizontal
  55       line = varargin{1};
  56       theta = mod(atan2(line(:,4), line(:,3)) + 2*pi, 2*pi);
  57
  58   elseif nargs==2
  59       % angle between two lines
  60       theta1 = lineAngle(varargin{1});
  61       theta2 = lineAngle(varargin{2});
  62       theta = mod(bsxfun(@minus, theta2, theta1)+2*pi, 2*pi);
  63   end
  64
  65 endfunction
  66
  67 % horizontal
  68 %!test
  69 %! line1 = createLine([2 3 1 0]);
  70 %! assert (lineAngle(line1), 0, 1e-6);
  71
  72 %!test
  73 %! line1 = createLine([2 3 0 1]);
  74 %! assert (lineAngle(line1), pi/2, 1e-6);
  75
  76 %!test
  77 %! line1 = createLine([2 3 1 1]);
  78 %! assert (lineAngle(line1), pi/4, 1e-6);
  79
  80 %!test
  81 %! line1 = createLine([2 3 5 -1]);
  82 %! assert (lineAngle(line1), mod(atan2(-1, 5)+2*pi, 2*pi), 1e-6);
  83
  84 %!test
  85 %! line1 = createLine([2 3 5000 -1000]);
  86 %! assert (lineAngle(line1), mod(atan2(-1, 5)+2*pi, 2*pi), 1e-6);
  87
  88 %!test
  89 %! line1 = createLine([2 3 -1 0]);
  90 %! assert (lineAngle(line1), pi, 1e-6);
  91
  92 % test lineAngle with two parameters : angle between 2 lines
  93 % check for 2 orthogonal lines
  94 %!test
  95 %! line1 = createLine([1 3 1 0]);
  96 %! line2 = createLine([-2 -1 0 1]);
  97 %! assert (lineAngle(line1, line2), pi/2, 1e-6);
  98 %! assert (lineAngle(line2, line1), 3*pi/2, 1e-6);
  99
 100 % check for 2 orthogonal lines, with very different parametrizations
 101 %!test
 102 %! line1 = createLine([1 3 1 1]);
 103 %! line2 = createLine([-2 -1 -1000 1000]);
 104 %! assert (lineAngle(line1, line2), pi/2, 1e-6);
 105 %! assert (lineAngle(line2, line1), 3*pi/2, 1e-6);