octave_packages/geometry-1.5.0/geom2d/angleSort.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2005-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} {varargout =} angleSort (@var{pts}, varargin)
  36 %% Sort points in the plane according to their angle to origin
  37 %%
  38 %%
  39 %%   PTS2 = angleSort(PTS);
  40 %%   Computes angle of points with origin, and sort points with increasing
  41 %%   angles in Counter-Clockwise direction.
  42 %%
  43 %%   PTS2 = angleSort(PTS, PTS0);
  44 %%   Computes angles between each point of PTS and PT0, which can be
  45 %%   different from origin.
  46 %%
  47 %%   PTS2 = angleSort(..., THETA0);
  48 %%   Specifies the starting angle for sorting.
  49 %%
  50 %%   [PTS2, I] = angleSort(...);
  51 %%   Also returns in I the indices of PTS, such that PTS2 = PTS(I, :);
  52 %%
  53 %% @seealso{points2d, angles2d, angle2points, normalizeAngle}
  54 %% @end deftypefn
  55
  56 function varargout = angleSort(pts, varargin)
  57
  58   % default values
  59   pt0 = [0 0];
  60   theta0 = 0;
  61
  62   if length(varargin)==1
  63       var = varargin{1};
  64       if size(var, 2)==1
  65           % specify angle
  66           theta0 = var;
  67       else
  68           pt0 = var;
  69       end
  70   elseif length(varargin)==2
  71       pt0 = varargin{1};
  72       theta0 = varargin{2};
  73   end
  74
  75
  76   n = size(pts, 1);
  77   pts2 = pts - repmat(pt0, [n 1]);
  78   angle = lineAngle([zeros(n, 2) pts2]);
  79   angle = mod(angle - theta0 + 2*pi, 2*pi);
  80
  81   [dummy, I] = sort(angle);
  82
  83   % format output
  84   if nargout<2
  85       varargout{1} = pts(I, :);
  86   elseif nargout==2
  87       varargout{1} = pts(I, :);
  88       varargout{2} = I;
  89   end
  90
  91 endfunction
  92
  93 %!shared p1,p2,p3,p4,pts,center
  94 %! p1 = [0 0];
  95 %! p2 = [10 0];
  96 %! p3 = [10 10];
  97 %! p4 = [0 10];
  98 %! pts = [p1;p2;p3;p4];
  99 %! center = [5 5];
 100
 101 %!test
 102 %! expected = pts([3 4 1 2], :);
 103 %! assert (expected, angleSort (pts, center), 1e-6);
 104
 105 %!assert (pts, angleSort (pts, center, -pi), 1e-6);
 106