Mercurial > octave-nkf
diff scripts/image/hsv.m @ 8543:fda06702bf71
hsv.m: doc fix
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 20 Jan 2009 10:57:18 -0500 |
parents | a1dbe9d80eee |
children | eb63fbe60fab |
line wrap: on
line diff
--- a/scripts/image/hsv.m Tue Jan 20 10:52:34 2009 -0500 +++ b/scripts/image/hsv.m Tue Jan 20 10:57:18 2009 -0500 @@ -18,9 +18,14 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} hsv (@var{n}) -## Create color colormap. This colormap is red through yellow, green, cyan, -## blue, magenta to red. The argument @var{n} should be a scalar. If it -## is omitted, the length of the current colormap or 64 is assumed. +## Create color colormap. This colormap is red through yellow, green, +## cyan, blue, magenta to red. 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} should be a scalar. If it is omitted, the +## length of the current colormap or 64 is assumed. ## @seealso{colormap} ## @end deftypefn