diff scripts/image/copper.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/copper.m	Tue Dec 28 20:46:17 2010 +0100
+++ b/scripts/image/copper.m	Tue Dec 28 13:08:23 2010 -0800
@@ -17,31 +17,33 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} copper (@var{n})
-## Create color colormap.  This colormap is black to a light copper tone.
-## 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} =} copper ()
+## @deftypefnx {Function File} {@var{map} =} copper (@var{n})
+## Create color colormap.  This colormap varies from black to
+## a light copper tone.
+## 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 = copper (number)
+function map = copper (n)
 
   if (nargin == 0)
-    number = rows (colormap);
+    n = rows (colormap);
   elseif (nargin == 1)
-    if (! isscalar (number))
+    if (! isscalar (n))
       error ("copper: argument must be a scalar");
     endif
   else
     print_usage ();
   endif
 
-  if (number == 1)
+  if (n == 1)
     map = [0, 0, 0];  
-  elseif (number > 1)
-    x = linspace (0, 1, number)';
+  elseif (n > 1)
+    x = linspace (0, 1, n)';
     r = (x < 4/5) .* (5/4 * x) + (x >= 4/5);
     g = 4/5 * x;
     b = 1/2 * x;
@@ -56,5 +58,5 @@
 %! ## Show the 'copper' colormap as an image
 %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
 %! axis ([1, 64, 0, 1], "ticy", "xy")
-%! colormap copper
+%! colormap (copper (64))