Mercurial > octave

annotate scripts/image/hsv.m @ 33596:96a203bc7e17 bytecode-interpreter tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Merge default to bytecode-interpreter
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Fri, 17 May 2024 22:49:58 -0400
parents d8e5e55c3cf5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
32632
2e484f9f1f18 maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 31706
diff changeset
3 ## Copyright (C) 1999-2024 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
7 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
8 ## This file is part of Octave.
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 ## (at your option) any later version.
6788
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 ## 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
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
18 ## GNU General Public License for more details.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
19 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
20 ## 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
21 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
25
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
26 ## -*- texinfo -*-
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
27 ## @deftypefn {} {@var{map} =} hsv ()
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
28 ## @deftypefnx {} {@var{map} =} hsv (@var{n})
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
29 ## 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
30 ## yellow, green, cyan, blue, and magenta, before returning to red.
20158
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
31 ##
14279
f205d0074687 Update colormap files with faster code.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
32 ## 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
33 ## 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
34 ## 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
35 ## @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
36 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
37 ## The argument @var{n} must be a scalar.
32647
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
38 ## If @var{n} is not specified the length of the current colormap is used. If
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
39 ## there is no current colormap the default value of 256 is used.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
40 ## @seealso{colormap}
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
41 ## @end deftypefn
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
42
24800
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
43 function map = hsv (n)
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
44
28789
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files.
Rik <rik@octave.org>
parents: 27978
diff changeset
45 if (nargin == 1)
32737
d8e5e55c3cf5 Tighten input validation for all colormaps (bug #65011).
Rik <rik@octave.org>
parents: 32653
diff changeset
46 if (! (isscalar (n) && isreal (n) && n == fix (n)))
d8e5e55c3cf5 Tighten input validation for all colormaps (bug #65011).
Rik <rik@octave.org>
parents: 32653
diff changeset
47 error ("hsv: N must be a scalar integer");
24800
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
48 endif
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
49 n = double (n);
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
50 else
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
51 hf = get (0, "currentfigure");
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
52 if (! isempty (hf))
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
53 n = rows (get (hf, "colormap"));
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
54 else
32647
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
55 n = 256;
24800
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
56 endif
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
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 9751
diff changeset
59 if (n == 1)
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
60 map = [1, 0, 0];
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 9751
diff changeset
61 elseif (n > 1)
16353
ca395af72d88 hsv.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
62 hue = [0:n-1]' / n;
14279
f205d0074687 Update colormap files with faster code.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
63 map = hsv2rgb ([hue, ones(n,1), ones(n,1)]);
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
64 else
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
65 map = zeros (0, 3);
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
66 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
67
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
68 endfunction
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 8920
diff changeset
69
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
70
20724
0338dc274ec5 Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents: 20158
diff changeset
71 ## A better demo of this colormap would be to plot the hsv values.
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 8920
diff changeset
72 %!demo
20724
0338dc274ec5 Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents: 20158
diff changeset
73 %! ## Show the 'hsv' colormap profile and as an image
0338dc274ec5 Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents: 20158
diff changeset
74 %! cmap = hsv (256);
0338dc274ec5 Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents: 20158
diff changeset
75 %! subplot (2, 1, 1);
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 21973
diff changeset
76 %! rgbplot (cmap, "composite");
20724
0338dc274ec5 Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents: 20158
diff changeset
77 %! subplot (2, 1, 2);
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 21973
diff changeset
78 %! rgbplot (cmap);
32647
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
79
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
80 %!assert (size (hsv ()), [256, 3])
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
81 %!assert (size (hsv (16)), [16, 3])
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
82
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
83 %!assert (hsv (1), [1, 0, 0])
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
84 %!assert (hsv (true), double ([1, 0, 0]))
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
85 %!assert (hsv (char (1)), double ([1, 0, 0]))
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
86 %!assert (hsv (int32 (1)), double ([1, 0, 0]))
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
87
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
88 %!assert (hsv (0), zeros (0, 3))
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
89 %!assert (hsv (-1), zeros (0, 3))
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
90
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
91 %!assert (hsv (6)(:), [1, 1, 0, 0, 0, 1, 0, 1, 1, 1, 0, 0, 0, 0, 0, 1, 1, 1]')
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
92
dfb9b770ae77 Increase default colormap size to 256 colors, add colormap BISTs (bug #65010)
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 32632
diff changeset
93 ## Input validation
32737
d8e5e55c3cf5 Tighten input validation for all colormaps (bug #65011).
Rik <rik@octave.org>
parents: 32653
diff changeset
94 %!error <N must be a scalar integer> hsv ("foo")
d8e5e55c3cf5 Tighten input validation for all colormaps (bug #65011).
Rik <rik@octave.org>
parents: 32653
diff changeset
95 %!error <N must be a scalar integer> hsv ([1, 2, 3])
d8e5e55c3cf5 Tighten input validation for all colormaps (bug #65011).
Rik <rik@octave.org>
parents: 32653
diff changeset
96 %!error <N must be a scalar integer> hsv ({1, 2, 3})