Mercurial > octave
annotate scripts/image/lines.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 | 3d25f9f4a62b |
rev | line source |
---|---|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19613
diff
changeset
|
1 ## Copyright (C) 2012-2015 Rik Wehbring |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
2 ## |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
3 ## This file is part of Octave. |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
4 ## |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
5 ## Octave is free software; you can redistribute it and/or modify it |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
6 ## under the terms of the GNU General Public License as published by |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
8 ## your option) any later version. |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
9 ## |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
10 ## Octave is distributed in the hope that it will be useful, but |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
13 ## General Public License for more details. |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
14 ## |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
15 ## You should have received a copy of the GNU General Public License |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
16 ## along with Octave; see the file COPYING. If not, see |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
17 ## <http://www.gnu.org/licenses/>. |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
18 |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
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} =} lines () |
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} =} lines (@var{n}) |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
22 ## Create color colormap. This colormap is composed of the list of colors |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
23 ## in the current axes @qcode{"ColorOrder"} property. The default is blue, |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
24 ## green, red, cyan, pink, yellow, and gray. |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
25 ## |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
26 ## The argument @var{n} must be a scalar. |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
27 ## If unspecified, the length of the current colormap, or 64, is used. |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
28 ## @seealso{colormap} |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
29 ## @end deftypefn |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
30 |
14640
b9c02ee24de1
new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents:
14279
diff
changeset
|
31 ## PKG_ADD: colormap ("register", "lines"); |
b9c02ee24de1
new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents:
14279
diff
changeset
|
32 ## PKG_DEL: colormap ("unregister", "lines"); |
b9c02ee24de1
new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents:
14279
diff
changeset
|
33 |
19613
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
34 function map = lines (n = rows (colormap ())) |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
35 |
19613
e8e3a89fa370
Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents:
17744
diff
changeset
|
36 if (nargin > 1) |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
37 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
|
38 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
|
39 error ("lines: N must be a scalar"); |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
40 endif |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
41 |
14641
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
42 if (n == 1) |
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
43 map = [0, 0, 1]; |
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
44 elseif (n > 1) |
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
45 C = get (gca, "colororder"); |
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
46 nr = rows (C); |
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
47 map = C(rem (0:(n-1), nr) + 1, :); |
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
48 else |
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
49 map = zeros (0, 3); |
5f1d4def40e1
improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents:
14640
diff
changeset
|
50 endif |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
51 |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
52 endfunction |
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
53 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
54 |
14272
4f8d2931f886
lines.m: Add new colormap corresponding to ColorOrder property.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
55 %!demo |
20724
0338dc274ec5
Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents:
20158
diff
changeset
|
56 %! ## Show the 'lines' 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
|
57 %! cmap = lines (21); # default has 7 colours, therefore cycle 3 times |
0338dc274ec5
Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents:
20158
diff
changeset
|
58 %! 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
|
59 %! rgbplot (cmap, "composite"); |
0338dc274ec5
Rewrite colormap demos with rgbplot() to show both composite and profile.
Carnë Draug <carandraug@octave.org>
parents:
20158
diff
changeset
|
60 %! 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
|
61 %! rgbplot (cmap); |