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