update packages

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

diff --git a/octave_packages/m/image/white.m b/octave_packages/m/image/white.m
new file mode 100644 (file)
index 0000000..13aaec8
--- /dev/null
+++ b/octave_packages/m/image/white.m
@@ -0,0 +1,55 @@
+## 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} {@var{map} =} white ()
+## @deftypefnx {Function File} {@var{map} =} white (@var{n})
+## Create color colormap.  This colormap is completely white.
+## The argument @var{n} should be a scalar.  If it
+## is omitted, the length of the current colormap or 64 is assumed.
+## @seealso{colormap}
+## @end deftypefn
+
+## Author:  Kai Habel <kai.habel@gmx.de>
+
+function map = white (n)
+
+  if (nargin == 0)
+    n = rows (colormap);
+  elseif (nargin == 1)
+    if (! isscalar (n))
+      error ("white: argument must be a scalar");
+    endif
+  else
+    print_usage ();
+  endif
+
+  if (n > 0)
+    map = ones (n, 3);
+  else
+    map = [];
+  endif
+
+endfunction
+
+%!demo
+%! ## Show the 'white' colormap as an image
+%! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
+%! axis ([1, 64, 0, 1], "ticy", "xy")
+%! colormap (white (64))
+