Mercurial > octave-nkf
annotate scripts/image/rainbow.m @ 11420:466ba499eff5
Update docstrings for colormap files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 28 Dec 2010 13:08:23 -0800 |
parents | 2b0cc0b6db61 |
children | fd0a3ac60b0e |
rev | line source |
---|---|
9245 | 1 ## Copyright (C) 1999, 2000, 2007, 2009 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 -*- | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
20 ## @deftypefn {Function File} {@var{map} =} rainbow () |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
21 ## @deftypefnx {Function File} {@var{map} =} rainbow (@var{n}) |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
22 ## Create color colormap. This colormap ranges from red through orange, |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
23 ## yellow, green, blue, to violet. |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
24 ## The argument @var{n} must be a scalar. |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
25 ## If unspecified, the length of the current colormap, or 64, is used. |
6788 | 26 ## @seealso{colormap} |
27 ## @end deftypefn | |
28 | |
29 ## Author: Kai Habel <kai.habel@gmx.de> | |
30 | |
31 ## this colormap is not part of matlab, it is like the prism | |
32 ## colormap map but with a continuous map | |
33 | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
34 function map = rainbow (n) |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
35 |
6788 | 36 if (nargin == 0) |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
37 n = rows (colormap); |
6788 | 38 elseif (nargin == 1) |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
39 if (! isscalar (n)) |
6788 | 40 error ("rainbow: argument must be a scalar"); |
41 endif | |
42 else | |
43 print_usage (); | |
44 endif | |
45 | |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
46 if (n == 1) |
6788 | 47 map = [1, 0, 0]; |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
48 elseif (n > 1) |
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
49 x = linspace (0, 1, n)'; |
6788 | 50 r = (x < 2/5) + (x >= 2/5 & x < 3/5) .* (-5 * x + 3)\ |
51 + (x >= 4/5) .* (10/3 * x - 8/3); | |
52 g = (x < 2/5) .* (5/2 * x) + (x >= 2/5 & x < 3/5)\ | |
53 + (x >= 3/5 & x < 4/5) .* (-5 * x + 4); | |
54 b = (x >= 3/5 & x < 4/5) .* (5 * x - 3) + (x >= 4/5); | |
55 map = [r, g, b]; | |
56 else | |
57 map = []; | |
58 endif | |
59 | |
60 endfunction | |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
61 |
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
62 %!demo |
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
63 %! ## Show the 'rainbow' colormap as an image |
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
64 %! image (1:64, linspace (0, 1, 64), repmat (1:64, 64, 1)') |
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
65 %! axis ([1, 64, 0, 1], "ticy", "xy") |
11420
466ba499eff5
Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents:
9751
diff
changeset
|
66 %! colormap (rainbow (64)) |
9751
2b0cc0b6db61
Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents:
9245
diff
changeset
|
67 |