diff scripts/image/winter.m @ 11420:466ba499eff5

Update docstrings for colormap files.
author Rik <octave@nomad.inbox5.com>
date Tue, 28 Dec 2010 13:08:23 -0800
parents 2b0cc0b6db61
children fd0a3ac60b0e
line wrap: on
line diff
--- a/scripts/image/winter.m	Tue Dec 28 20:46:17 2010 +0100
+++ b/scripts/image/winter.m	Tue Dec 28 13:08:23 2010 -0800
@@ -17,32 +17,33 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} winter (@var{n})
-## Create color colormap.  This colormap is blue to green.
-## The argument @var{n} should be a scalar.  If it
-## is omitted, the length of the current colormap or 64 is assumed.
+## @deftypefn  {Function File} {@var{map} =} winter ()
+## @deftypefnx {Function File} {@var{map} =} winter (@var{n})
+## Create color colormap.  This colormap varies from blue to green.
+## 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 = winter (number)
+function map = winter (n)
 
   if (nargin == 0)
-    number = rows (colormap);
+    n = rows (colormap);
   elseif (nargin == 1)
-    if (! isscalar (number))
+    if (! isscalar (n))
       error ("winter: argument must be a scalar");
     endif
   else
     print_usage ();
   endif
 
-  if (number == 1)
+  if (n == 1)
     map = [0, 0, 1];  
-  elseif (number > 1)
-    r = zeros (number, 1);
-    g = (0:number - 1)' ./ (number - 1);
+  elseif (n > 1)
+    r = zeros (n, 1);
+    g = (0:n - 1)' ./ (n - 1);
     b = 1 - g ./ 2;
 
     map = [r, g, b];
@@ -56,5 +57,5 @@
 %! ## Show the 'winter' colormap as an image
 %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
 %! axis ([1, 64, 0, 1], "ticy", "xy")
-%! colormap winter
+%! colormap (winter (64))