update packages

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

diff --git a/octave_packages/m/image/hsv.m b/octave_packages/m/image/hsv.m
new file mode 100644 (file)
index 0000000..94cd09a
--- /dev/null
+++ b/octave_packages/m/image/hsv.m
@@ -0,0 +1,63 @@
+## Copyright (C) 1999-2012 Kai Habel
+##
+## 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} {} hsv (@var{n})
+## Create color colormap.  This colormap begins with red, changes through
+## yellow, green, cyan, blue, and magenta, before returning to red.
+## It is useful for displaying periodic functions.  It is obtained by linearly
+## varying the hue through all possible values while keeping constant maximum
+## saturation and value and is equivalent to
+## @code{hsv2rgb ([linspace(0,1,N)', ones(N,2)])}.
+##
+## The argument @var{n} must be a scalar.
+## If unspecified, the length of the current colormap, or 64, is used.
+## @seealso{colormap}
+## @end deftypefn
+
+## Author:  Kai Habel <kai.habel@gmx.de>
+
+function map = hsv (n)
+
+  if (nargin == 0)
+    n = rows (colormap);
+  elseif (nargin == 1)
+    if (! isscalar (n))
+      error ("hsv: argument must be a scalar");
+    endif
+  else
+    print_usage ();
+  endif
+
+  if (n == 1)
+    map = [1, 0, 0];
+  elseif (n > 1)
+    h = linspace (0, 1, n)';
+    map = hsv2rgb ([h, ones(n, 1), ones(n, 1)]);
+  else
+    map = [];
+  endif
+
+endfunction
+
+%!demo
+%! ## Show the 'hsv' colormap as an image
+%! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
+%! axis ([1, 64, 0, 1], "ticy", "xy")
+%! colormap (hsv (64))
+