update packages

[CreaPhase.git] / octave_packages / m / image / colormap.m

diff --git a/octave_packages/m/image/colormap.m b/octave_packages/m/image/colormap.m
new file mode 100644 (file)
index 0000000..51c1dbe
--- /dev/null
+++ b/octave_packages/m/image/colormap.m
@@ -0,0 +1,74 @@
+## Copyright (C) 1994-2012 John W. Eaton
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn  {Function File} {} colormap (@var{map})
+## @deftypefnx {Function File} {} colormap ("default")
+## Set the current colormap.
+##
+## @code{colormap (@var{map})} sets the current colormap to @var{map}.  The
+## color map should be an @var{n} row by 3 column matrix.  The columns
+## contain red, green, and blue intensities respectively.  All entries
+## should be between 0 and 1 inclusive.  The new colormap is returned.
+##
+## @code{colormap ("default")} restores the default colormap (the
+## @code{jet} map with 64 entries).  The default colormap is returned.
+##
+## With no arguments, @code{colormap} returns the current color map.
+## @seealso{jet}
+## @end deftypefn
+
+## Author: Tony Richardson <arichard@stark.cc.oh.us>
+## Created: July 1994
+## Adapted-By: jwe
+
+function cmap = colormap (map)
+
+  if (nargin > 1)
+    print_usage ();
+  endif
+
+  if (nargin == 1)
+
+    if (ischar (map))
+      if (strcmp (map, "default"))
+        map = jet (64);
+      else
+        map = feval (map);
+      endif
+    endif
+
+    if (! isempty (map))
+      if (columns (map) != 3)
+        error ("colormap: MAP must have 3 columns: [R,G,B]");
+      endif
+      if (min (min (map)) < 0 || max (max (map)) > 1)
+        error ("colormap: MAP must have values in [0,1]");
+      endif
+      ## Set the new color map
+      set (gcf (), "colormap", map);
+    endif
+
+  endif
+
+  ## Return current color map.
+  if (nargout > 0 || (nargout == 0 && nargin == 0))
+    cmap = get (gcf (), "colormap");
+  endif
+
+endfunction