octave_packages/m/image/colormap.m

   1 ## Copyright (C) 1994-2012 John W. Eaton
   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} {} colormap (@var{map})
  21 ## @deftypefnx {Function File} {} colormap ("default")
  22 ## Set the current colormap.
  23 ##
  24 ## @code{colormap (@var{map})} sets the current colormap to @var{map}.  The
  25 ## color map should be an @var{n} row by 3 column matrix.  The columns
  26 ## contain red, green, and blue intensities respectively.  All entries
  27 ## should be between 0 and 1 inclusive.  The new colormap is returned.
  28 ##
  29 ## @code{colormap ("default")} restores the default colormap (the
  30 ## @code{jet} map with 64 entries).  The default colormap is returned.
  31 ##
  32 ## With no arguments, @code{colormap} returns the current color map.
  33 ## @seealso{jet}
  34 ## @end deftypefn
  35
  36 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
  37 ## Created: July 1994
  38 ## Adapted-By: jwe
  39
  40 function cmap = colormap (map)
  41
  42   if (nargin > 1)
  43     print_usage ();
  44   endif
  45
  46   if (nargin == 1)
  47
  48     if (ischar (map))
  49       if (strcmp (map, "default"))
  50         map = jet (64);
  51       else
  52         map = feval (map);
  53       endif
  54     endif
  55
  56     if (! isempty (map))
  57       if (columns (map) != 3)
  58         error ("colormap: MAP must have 3 columns: [R,G,B]");
  59       endif
  60       if (min (min (map)) < 0 || max (max (map)) > 1)
  61         error ("colormap: MAP must have values in [0,1]");
  62       endif
  63       ## Set the new color map
  64       set (gcf (), "colormap", map);
  65     endif
  66
  67   endif
  68
  69   ## Return current color map.
  70   if (nargout > 0 || (nargout == 0 && nargin == 0))
  71     cmap = get (gcf (), "colormap");
  72   endif
  73
  74 endfunction