octave_packages/m/image/flag.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} =} flag ()
  21 ## @deftypefnx {Function File} {@var{map} =} flag (@var{n})
  22 ## Create color colormap.  This colormap cycles through red, white, blue
  23 ## and black with each index change.
  24 ## The argument @var{n} must be a scalar.
  25 ## If unspecified, the length of the current colormap, or 64, is used.
  26 ## @seealso{colormap}
  27 ## @end deftypefn
  28
  29 ## Author:  Kai Habel <kai.habel@gmx.de>
  30
  31 function map = flag (n)
  32
  33   if (nargin == 0)
  34     n = rows (colormap);
  35   elseif (nargin == 1)
  36     if (! isscalar (n))
  37       error ("flag: argument must be a scalar");
  38     endif
  39   else
  40     print_usage ();
  41   endif
  42
  43   p = [1, 0, 0; 1, 1, 1; 0, 0, 1; 0, 0, 0];
  44   if (rem(n,4) == 0)
  45     map = kron (ones (n / 4, 1), p);
  46   else
  47     m1 = kron (ones (fix (n / 4), 1), p);
  48     m2 = p(1:rem (n, 4), :);
  49     map = [m1; m2];
  50   endif
  51
  52 endfunction
  53
  54 %!demo
  55 %! ## Show the 'flag' colormap as an image
  56 %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
  57 %! axis ([1, 64, 0, 1], "ticy", "xy")
  58 %! colormap (flag (64))
  59