Mercurial > octave-nkf
annotate scripts/image/hsv.m @ 19867:9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Try to trim long lines to < 80 chars.
Use '##' for single line comments.
Use '(...)' around tests for if/elseif/switch/while.
Abut cell indexing operator '{' next to variable.
Abut array indexing operator '(' next to variable.
Use space between negation operator '!' and following expression.
Use two newlines between endfunction and start of %!test or %!demo code.
Remove unnecessary parens grouping between short-circuit operators.
Remove stray extra spaces (typos) between variables and assignment operators.
Remove stray extra spaces from ends of lines.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 23 Feb 2015 14:54:39 -0800 |
parents | 4197fc428c7d |
children | 7503499a252b |
rev | line source |
---|---|
19731
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19647
diff
changeset
|
1 ## Copyright (C) 1999-2015 Kai Habel |
6788 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
6788 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
6788 | 18 |
19 ## -*- texinfo -*- | |
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 | 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 | 30 ## @seealso{colormap} |
31 ## @end deftypefn | |
32 | |
33 ## Author: Kai Habel <kai.habel@gmx.de> | |
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 |
19647
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
38 function map = hsv (n = rows (colormap ())) |
6788 | 39 |
19647
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
40 if (nargin > 1) |
6788 | 41 print_usage (); |
19647
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
42 elseif (! isscalar (n)) |
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
43 error ("hsv: N must be a scalar"); |
6788 | 44 endif |
19647
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
45 n = double (n); |
6788 | 46 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
47 if (n == 1) |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
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) |
16353
ca395af72d88
hsv.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
50 hue = [0:n-1]' / n; |
14279
f205d0074687
Update colormap files with faster code.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
51 map = hsv2rgb ([hue, ones(n,1), ones(n,1)]); |
6788 | 52 else |
14641
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
53 map = zeros (0, 3); |
6788 | 54 endif |
55 | |
56 endfunction | |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
8920
diff
changeset
|
57 |
19867
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
58 |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
8920
diff
changeset
|
59 %!demo |
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
8920
diff
changeset
|
60 %! ## 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
|
61 %! 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
|
62 %! 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
|
63 %! colormap (hsv (64)); |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
8920
diff
changeset
|
64 |