Mercurial > hg > octave-kai
changeset 8543:fda06702bf71
hsv.m: doc fix
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 20 Jan 2009 10:57:18 -0500 |
parents | ef2dfe33e5b5 |
children | c0d71b4deeb7 |
files | scripts/ChangeLog scripts/image/hsv.m |
diffstat | 2 files changed, 10 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,5 +1,7 @@ 2009-01-20 John W. Eaton <jwe@octave.org> + * image/hsv.m: Doc fix from Francesco Potorti` <Potorti@isti.cnr.it>. + * testfun/assert.m: Use isfield instead of struct_contains. 2009-01-17 Ben Abbott <bpabbott@mac.com>
--- a/scripts/image/hsv.m +++ b/scripts/image/hsv.m @@ -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