octave-antonio: scripts/image/hsv.m annotate

annotate scripts/image/hsv.m @ 17170:d6499c14021c

doc: Periodic grammarcheck of documentation. * doc/interpreter/basics.txi, doc/interpreter/expr.txi, doc/interpreter/install.txi, doc/interpreter/java.txi, doc/interpreter/plot.txi, doc/interpreter/sparse.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/cellfun.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/pr-output.cc, libinterp/parse-tree/oct-parse.in.yy, liboctave/numeric/LSODE-opts.in, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imwrite.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/warning_ids.m, scripts/prefs/prefdir.m, scripts/prefs/preferences.m, scripts/signal/fftfilt.m, scripts/strings/isstrprop.m, scripts/testfun/assert.m: Periodic grammarcheck of documentation.

author	Rik <rik@octave.org>
date	Sun, 04 Aug 2013 13:08:39 -0700
parents	ca395af72d88
children	d63878346099

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 11587 diff changeset	1 ## Copyright (C) 1999-2012 Kai Habel
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	2 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	3 ## This file is part of Octave.
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	4 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6791 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6791 diff changeset	8 ## your option) any later version.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	9 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	13 ## General Public License for more details.
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	14 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6791 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6791 diff changeset	17 ## <http://www.gnu.org/licenses/>.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	18
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	19 ## -- texinfo --
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	20 ## @deftypefn {Function File} {} hsv (@var{n})
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	21 ## Create color colormap. This colormap begins with red, changes through
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	22 ## yellow, green, cyan, blue, and magenta, before returning to red.
14279 f205d0074687 Update colormap files with faster code. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	23 ## It is useful for displaying periodic functions. The map is obtained by
f205d0074687 Update colormap files with faster code. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	24 ## linearly varying the hue through all possible values while keeping constant
f205d0074687 Update colormap files with faster code. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	25 ## maximum saturation and value. The equivalent code is
16353 ca395af72d88 hsv.m: Make colormap compatible with Matlab (bug #36473). Rik <rik@octave.org> parents: 15720 diff changeset	26 ## @code{hsv2rgb ([(0:N-1)'/N, ones(N,2)])}.
8543 fda06702bf71 hsv.m: doc fix John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	27 ##
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	28 ## The argument @var{n} must be a scalar.
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	29 ## If unspecified, the length of the current colormap, or 64, is used.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	30 ## @seealso{colormap}
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	31 ## @end deftypefn
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	32
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	33 ## Author: Kai Habel <kai.habel@gmx.de>
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	34
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	35 ## PKG_ADD: colormap ("register", "hsv");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	36 ## PKG_DEL: colormap ("unregister", "hsv");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	37
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	38 function map = hsv (n)
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	39
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	40 if (nargin == 0)
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	41 n = rows (colormap);
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	42 elseif (nargin == 1)
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	43 if (! isscalar (n))
15720 1a800034d443 Colormap error() calls now report the input variable which is a problem. Rik <rik@octave.org> parents: 14641 diff changeset	44 error ("hsv: N must be a scalar");
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	45 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	46 else
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	47 print_usage ();
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	48 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	49
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	50 if (n == 1)
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	51 map = [1, 0, 0];
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	52 elseif (n > 1)
16353 ca395af72d88 hsv.m: Make colormap compatible with Matlab (bug #36473). Rik <rik@octave.org> parents: 15720 diff changeset	53 hue = [0:n-1]' / n;
14279 f205d0074687 Update colormap files with faster code. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	54 map = hsv2rgb ([hue, ones(n,1), ones(n,1)]);
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	55 else
14641 5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	56 map = zeros (0, 3);
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	57 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	58
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	59 endfunction
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	60
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	61
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	62 %!demo
2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	63 %! ## Show the 'hsv' colormap as an image
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	64 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	65 %! axis ([1, 64, 0, 1], "ticy", "xy");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	66 %! colormap (hsv (64));
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	67

Mercurial > octave-antonio

annotate scripts/image/hsv.m @ 17170:d6499c14021c