octave_packages/m/image/autumn.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} =} autumn ()
  21 ## @deftypefnx {Function File} {@var{map} =} autumn (@var{n})
  22 ## Create color colormap.  This colormap ranges from red through orange
  23 ## to yellow.
  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 = autumn (n)
  32
  33   if (nargin == 0)
  34     n = rows (colormap);
  35   elseif (nargin == 1)
  36     if (! isscalar (n))
  37       error ("autumn: argument must be a scalar");
  38     endif
  39   else
  40     print_usage ();
  41   endif
  42
  43   if (n == 1)
  44     map = [1, 0, 0];
  45   elseif (n > 1)
  46     r = ones (n, 1);
  47     g = (0:n - 1)' ./ (n - 1);
  48     b = zeros (n, 1);
  49     map = [r, g, b];
  50   else
  51     map = [];
  52   endif
  53
  54 endfunction
  55
  56 %!demo
  57 %! ## Show the 'autumn' colormap as an image
  58 %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
  59 %! axis ([1, 64, 0, 1], "ticy", "xy")
  60 %! colormap (autumn (64))
  61