octave_packages/geometry-1.5.0/geom2d/centroid.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{c} = } centroid (@var{points})
  36 %% @deftypefnx {Function File} {@var{c} = } centroid (@var{px}, @var{py})
  37 %% @deftypefnx {Function File} {@var{c} = } centroid (@dots{}, @var{mass})
  38 %% Compute centroid (center of mass) of a set of points.
  39 %%
  40 %%   Computes the ND-dimensional centroid of a set of points.
  41 %%   @var{points} is an array with as many rows as the number of points, and as
  42 %%   many columns as the number of dimensions.
  43 %%   @var{px} and @var{py} are two column vectors containing coordinates of the
  44 %%   2-dimensional points.
  45 %%   The result @var{c} is a row vector with ND columns.
  46 %%
  47 %%   If @var{mass} is given, computes center of mass of @var{points}, weighted by coefficient @var{mass}.
  48 %%   @var{points} is a Np-by-Nd array, @var{mass} is Np-by-1 array, and @var{px} and @var{py} are
  49 %%   also both Np-by-1 arrays.
  50 %%
  51 %%   Example:
  52 %%
  53 %% @example
  54 %%   pts = [2 2;6 1;6 5;2 4];
  55 %%   centroid(pts)
  56 %%   ans =
  57 %%        4     3
  58 %%@end example
  59 %%
  60 %%   @seealso{points2d, polygonCentroid}
  61 %% @end deftypefn
  62
  63 function center = centroid(varargin)
  64
  65   %% extract input arguments
  66
  67   % use empty mass by default
  68   mass = [];
  69
  70   if nargin==1
  71       % give only array of points
  72       pts = varargin{1};
  73
  74   elseif nargin==2
  75       % either POINTS+MASS or PX+PY
  76       var = varargin{1};
  77       if size(var, 2)>1
  78           % arguments are POINTS, and MASS
  79           pts = var;
  80           mass = varargin{2};
  81       else
  82           % arguments are PX and PY
  83           pts = [var varargin{2}];
  84       end
  85
  86   elseif nargin==3
  87       % arguments are PX, PY, and MASS
  88       pts = [varargin{1} varargin{2}];
  89       mass = varargin{3};
  90   end
  91
  92   %% compute centroid
  93
  94   if isempty(mass)
  95       % no weight
  96       center = mean(pts);
  97
  98   else
  99       % format mass to have sum equal to 1, and column format
 100       mass = mass(:)/sum(mass(:));
 101
 102       % compute weighted centroid
 103       center = sum(bsxfun(@times, pts, mass), 1);
 104       % equivalent to:
 105       % center = sum(pts .* mass(:, ones(1, size(pts, 2))));
 106   end
 107
 108 endfunction
 109
 110 %!test
 111 %!  points = [0 0;10 0;10 10;0 10];
 112 %!  centro = centroid(points);
 113 %!   assert ([5 5], centro, 1e-6);
 114
 115 %!test
 116 %!  points = [0 0;10 0;10 10;0 10];
 117 %!  centro = centroid(points(:,1), points(:,2));
 118 %!   assert ([5 5], centro, 1e-6);
 119
 120 %!test
 121 %!  points = [0 0;30 0;30 30;0 30];
 122 %!  centro = centroid(points, [1;1;1;3]);
 123 %!   assert ([10 20], centro, 1e-6);
 124
 125 %!test
 126 %!  points = [0 0;30 0;30 30;0 30];
 127 %!  centro = centroid(points(:,1), points(:,2), [1;1;1;3]);
 128 %!   assert ([10 20], centro, 1e-6);
 129