octave_packages/m/image/white.m

   1 ## Copyright (C) 1999-2012 Kai Habel
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {@var{map} =} white ()
  21 ## @deftypefnx {Function File} {@var{map} =} white (@var{n})
  22 ## Create color colormap.  This colormap is completely white.
  23 ## The argument @var{n} should be a scalar.  If it
  24 ## is omitted, the length of the current colormap or 64 is assumed.
  25 ## @seealso{colormap}
  26 ## @end deftypefn
  27
  28 ## Author:  Kai Habel <kai.habel@gmx.de>
  29
  30 function map = white (n)
  31
  32   if (nargin == 0)
  33     n = rows (colormap);
  34   elseif (nargin == 1)
  35     if (! isscalar (n))
  36       error ("white: argument must be a scalar");
  37     endif
  38   else
  39     print_usage ();
  40   endif
  41
  42   if (n > 0)
  43     map = ones (n, 3);
  44   else
  45     map = [];
  46   endif
  47
  48 endfunction
  49
  50 %!demo
  51 %! ## Show the 'white' colormap as an image
  52 %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
  53 %! axis ([1, 64, 0, 1], "ticy", "xy")
  54 %! colormap (white (64))
  55