octave_packages/image-1.0.15/mean2.m

   1 ## Copyright (C) 2000  Kai Habel
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation; either version 2 of the License, or
   6 ## (at your option) any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful,
   9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 ## GNU General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this program; If not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} @var{m}= mean2 (@var{I})
  18 ## Returns the mean value for a 2d real type matrix.
  19 ## Uses @code{mean(I(:))}
  20 ## @seealso{std2,mean}
  21 ## @end deftypefn
  22
  23
  24 ## Author:      Kai Habel <kai.habel@gmx.de>
  25 ## Date:        01/08/2000
  26
  27 function m = mean2 (I)
  28
  29   if !(nargin == 1)
  30     print_usage();
  31   endif
  32
  33   if !(ismatrix(I) && isreal(I))
  34         error("mean2: argument must be a real type matrix");
  35   endif
  36
  37   m = mean (I(:));
  38 endfunction