|
2847
|
1 ## Copyright (C) 1996, 1997 John W. Eaton |
|
2313
|
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. |
|
2313
|
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/>. |
|
1024
|
18 |
|
3381
|
19 ## -*- texinfo -*- |
|
3373
|
20 ## @deftypefn {Function File} {} colormap (@var{map}) |
|
|
21 ## @deftypefnx {Function File} {} colormap ("default") |
|
2311
|
22 ## Set the current colormap. |
|
3426
|
23 ## |
|
3373
|
24 ## @code{colormap (@var{map})} sets the current colormap to @var{map}. The |
|
|
25 ## color map should be an @var{n} row by 3 column matrix. The columns |
|
|
26 ## contain red, green, and blue intensities respectively. All entries |
|
|
27 ## should be between 0 and 1 inclusive. The new colormap is returned. |
|
3426
|
28 ## |
|
6895
|
29 ## @code{colormap ("default")} restores the default colormap (the |
|
|
30 ## @code{jet} map with 64 entries). The default colormap is returned. |
|
3426
|
31 ## |
|
3373
|
32 ## With no arguments, @code{colormap} returns the current color map. |
|
6895
|
33 ## @seealso{jet} |
|
3373
|
34 ## @end deftypefn |
|
559
|
35 |
|
3202
|
36 ## Author: Tony Richardson <arichard@stark.cc.oh.us> |
|
2312
|
37 ## Created: July 1994 |
|
|
38 ## Adapted-By: jwe |
|
904
|
39 |
|
6762
|
40 ## PKG_ADD: mark_as_command colormap |
|
|
41 |
|
2312
|
42 function cmap = colormap (map) |
|
559
|
43 |
|
1062
|
44 if (nargin > 1) |
|
5923
|
45 print_usage (); |
|
1062
|
46 endif |
|
559
|
47 |
|
1024
|
48 if (nargin == 1) |
|
3238
|
49 |
|
5443
|
50 if (ischar (map)) |
|
1024
|
51 if (strcmp (map, "default")) |
|
6895
|
52 map = jet (64); |
|
559
|
53 else |
|
6257
|
54 map = feval (map); |
|
559
|
55 endif |
|
3238
|
56 endif |
|
|
57 |
|
|
58 if (! isempty (map)) |
|
|
59 if (columns (map) != 3) |
|
3458
|
60 error ("colormap: map must have 3 columns: [R,G,B]"); |
|
3238
|
61 endif |
|
|
62 if (min (min (map)) < 0 || max (max (map)) > 1) |
|
3458
|
63 error ("colormap: map must have values in [0,1]"); |
|
3238
|
64 endif |
|
2303
|
65 ## Set the new color map |
|
6257
|
66 set (gcf (), "colormap", map); |
|
559
|
67 endif |
|
3238
|
68 |
|
559
|
69 endif |
|
|
70 |
|
2303
|
71 ## Return current color map. |
|
6762
|
72 if (nargout > 0) |
|
|
73 cmap = get (gcf (), "colormap"); |
|
|
74 endif |
|
1024
|
75 |
|
559
|
76 endfunction |
