Mercurial > octave
annotate scripts/image/copper.m @ 20852:516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 12 Dec 2015 07:31:00 -0800 |
parents | 0338dc274ec5 |
children | 894239974868 |
rev | line source |
---|---|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19613
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 -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20724
diff
changeset
|
20 ## @deftypefn {} {@var{map} =} copper () |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20724
diff
changeset
|
21 ## @deftypefnx {} {@var{map} =} copper (@var{n}) |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
22 ## Create color colormap. This colormap varies from black to a light copper |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
23 ## tone. |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
24 ## |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
25 ## The argument @var{n} must be a scalar. |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
26 ## If unspecified, the length of the current colormap, or 64, is used. |
6788 | 27 ## @seealso{colormap} |
28 ## @end deftypefn | |
29 | |
30 ## Author: Kai Habel <kai.habel@gmx.de> | |
31 | |
14640
b9c02ee24de1
new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents:
14279
diff
changeset
|
32 ## PKG_ADD: colormap ("register", "copper"); |
b9c02ee24de1
new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents:
14279
diff
changeset
|
33 ## PKG_DEL: colormap ("unregister", "copper"); |
b9c02ee24de1
new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents:
14279
diff
changeset
|
34 |
19613
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
35 function map = copper (n = rows (colormap ())) |
6788 | 36 |
19613
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
37 if (nargin > 1) |
6788 | 38 print_usage (); |
19613
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
39 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
|
40 error ("copper: N must be a scalar"); |
6788 | 41 endif |
19613
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
42 n = double (n); |
6788 | 43 |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
44 if (n == 1) |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
45 map = [0, 0, 0]; |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
46 elseif (n > 1) |
16466 | 47 x = [0:(n-1)]' / (n - 1); |
14279
f205d0074687
Update colormap files with faster code.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
48 r = (x < 4/5) .* (5/4 * x) ... |
f205d0074687
Update colormap files with faster code.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
49 + (x >= 4/5); |
16352
b8a4f313e78e
copper.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
50 g = 0.7812 * x; |
b8a4f313e78e
copper.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
51 b = 0.4975 * x; |
6788 | 52 map = [r, g, b]; |
53 else | |
14641
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
54 map = zeros (0, 3); |
6788 | 55 endif |
56 | |
57 endfunction | |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
58 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
59 |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
60 %!demo |
20724
0338dc274ec5
Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents:
20158
diff
changeset
|
61 %! ## Show the 'copper' 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
|
62 %! cmap = copper (256); |
0338dc274ec5
Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents:
20158
diff
changeset
|
63 %! subplot (2, 1, 1); |
0338dc274ec5
Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents:
20158
diff
changeset
|
64 %! rgbplot (cmap, "composite"); |
0338dc274ec5
Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents:
20158
diff
changeset
|
65 %! subplot (2, 1, 2); |
0338dc274ec5
Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents:
20158
diff
changeset
|
66 %! rgbplot (cmap); |