octave: scripts/image/hsv.m annotate

annotate scripts/image/hsv.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

rev	line source
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8543 diff changeset	1 ## Copyright (C) 1999, 2000, 2007, 2009 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})
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	21 ## Create color colormap. This colormap begins with red, changes through
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	22 ## yellow, green, cyan, blue, and magenta, before returning to red.
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	23 ## It is useful for displaying periodic functions. It is obtained by linearly
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	24 ## varying the hue through all possible values while keeping constant maximum
8543 fda06702bf71 hsv.m: doc fix John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	25 ## saturation and value and is equivalent to
fda06702bf71 hsv.m: doc fix John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	26 ## @code{hsv2rgb ([linspace(0,1,N)', ones(N,2)])}.
fda06702bf71 hsv.m: doc fix John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	27 ##
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	28 ## The argument @var{n} must be a scalar.
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
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	35 function map = hsv (n)
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	36
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	37 if (nargin == 0)
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	38 n = rows (colormap);
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	39 elseif (nargin == 1)
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	40 if (! isscalar (n))
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	41 error ("hsv: argument must be a scalar");
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	42 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	43 else
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	44 print_usage ();
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
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	47 if (n == 1)
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	48 map = [1, 0, 0];
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	49 elseif (n > 1)
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	50 h = linspace (0, 1, n)';
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	51 map = hsv2rgb ([h, ones(n, 1), ones(n, 1)]);
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	52 else
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	53 map = [];
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	54 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	55
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	56 endfunction
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	57
2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	58 %!demo
2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	59 %! ## Show the 'hsv' colormap as an image
2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	60 %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)')
2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	61 %! axis ([1, 64, 0, 1], "ticy", "xy")
11420 466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	62 %! colormap (hsv (64))
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 8920 diff changeset	63

Mercurial > octave

annotate scripts/image/hsv.m @ 11420:466ba499eff5