octave_packages/image-1.0.15/std2.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{s}= std2 (@var{I})
  18 ## Returns the standard deviation for a 2d real type matrix.
  19 ## Uses @code{std (I(:))}
  20 ## @seealso{mean2,std}
  21 ## @end deftypefn
  22
  23 ## Author:      Kai Habel <kai.habel@gmx.de>
  24 ## Date:        01/08/2000
  25
  26 function s = std2 (I)
  27
  28   if !(nargin == 1)
  29     print_usage ();
  30   endif
  31
  32   if !(ismatrix(I) && isreal(I))
  33         error("std2: argument must be a real type matrix");
  34   endif
  35
  36   s = std (I(:));
  37 endfunction