annotate scripts/image/ocean.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 1994-2020 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
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
7 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ## 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
11 ## 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
12 ## (at your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
18 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
19 ## 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
20 ## 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
21 ## <https://www.gnu.org/licenses/>.
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
22
3381
69b167451491 [project @ 1999-12-15 20:48:10 by jwe]
jwe
parents: 3373
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20724
diff changeset
24 ## @deftypefn {} {@var{map} =} ocean ()
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20724
diff changeset
25 ## @deftypefnx {} {@var{map} =} ocean (@var{n})
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 9751
diff changeset
26 ## Create color colormap. This colormap varies from black to white with shades
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 9751
diff changeset
27 ## of blue.
20158
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
28 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
29 ## The argument @var{n} must be a scalar.
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 9751
diff changeset
30 ## If unspecified, the length of the current colormap, or 64, is used.
14260
1f911333ed3d doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
31 ## @seealso{colormap}
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
32 ## @end deftypefn
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
33
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 2847
diff changeset
34 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
35 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
36 ## Adapted-By: jwe
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
37
24800
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
38 function map = ocean (n)
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
39
19613
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)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
41 print_usage ();
24800
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
42 elseif (nargin == 1)
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
43 if (! isscalar (n))
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
44 error ("ocean: N must be a scalar");
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
45 endif
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
46 n = double (n);
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
47 else
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
48 hf = get (0, "currentfigure");
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
49 if (! isempty (hf))
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
50 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
51 else
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
52 n = 64;
2dc04b6e1740 Don't create new figure when calling colormap functions (bug #53217).
Rik <rik@octave.org>
parents: 24534
diff changeset
53 endif
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
54 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
55
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
56 if (n == 1)
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
57 map = [0, 0, 0];
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
58 elseif (n > 1)
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
59 cutin = fix (n/3);
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
60
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
61 dr = (n - 1) / cutin;
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
62 r = prepad ([0:dr:(n-1)], n)';
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
63
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
64 dg = (n - 1) / (2 * cutin);
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
65 g = prepad ([0:dg:(n-1)], n)';
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
66
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
67 b = [0:(n-1)]';
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
68
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
69 map = [r, g, b] / (n - 1);
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
70 else
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
71 map = zeros (0, 3);
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
72 endif
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
73
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
74 endfunction
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 7017
diff changeset
75
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
76
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 7017
diff changeset
77 %!demo
20724
0338dc274ec5 Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents: 20158
diff changeset
78 %! ## Show the 'ocean' 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
79 %! cmap = ocean (256);
0338dc274ec5 Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents: 20158
diff changeset
80 %! subplot (2, 1, 1);
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 21973
diff changeset
81 %! 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
82 %! subplot (2, 1, 2);
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 21973
diff changeset
83 %! rgbplot (cmap);