annotate scripts/image/colormap.m @ 7108:60a1165732f9

[project @ 2007-11-06 22:05:18 by jwe]
author jwe
date Tue, 06 Nov 2007 22:06:27 +0000
parents a1dbe9d80eee
children 5dd06f19e9be
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2003, 2005,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2006, 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
7 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
11 ## 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
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
16 ## 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: 6895
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
18 ## <http://www.gnu.org/licenses/>.
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
19
3381
69b167451491 [project @ 1999-12-15 20:48:10 by jwe]
jwe
parents: 3373
diff changeset
20 ## -*- texinfo -*-
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3238
diff changeset
21 ## @deftypefn {Function File} {} colormap (@var{map})
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3238
diff changeset
22 ## @deftypefnx {Function File} {} colormap ("default")
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
23 ## Set the current colormap.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3381
diff changeset
24 ##
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3238
diff changeset
25 ## @code{colormap (@var{map})} sets the current colormap to @var{map}. The
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3238
diff changeset
26 ## color map should be an @var{n} row by 3 column matrix. The columns
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3238
diff changeset
27 ## contain red, green, and blue intensities respectively. All entries
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3238
diff changeset
28 ## should be between 0 and 1 inclusive. The new colormap is returned.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3381
diff changeset
29 ##
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6762
diff changeset
30 ## @code{colormap ("default")} restores the default colormap (the
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6762
diff changeset
31 ## @code{jet} map with 64 entries). The default colormap is returned.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3381
diff changeset
32 ##
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3238
diff changeset
33 ## With no arguments, @code{colormap} returns the current color map.
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6762
diff changeset
34 ## @seealso{jet}
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3238
diff changeset
35 ## @end deftypefn
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
36
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3106
diff changeset
37 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
38 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
39 ## Adapted-By: jwe
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 559
diff changeset
40
6762
721953d49b19 [project @ 2007-06-27 18:20:19 by jwe]
jwe
parents: 6257
diff changeset
41 ## PKG_ADD: mark_as_command colormap
721953d49b19 [project @ 2007-06-27 18:20:19 by jwe]
jwe
parents: 6257
diff changeset
42
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
43 function cmap = colormap (map)
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
44
1062
1b3a87031641 [project @ 1995-01-24 02:54:50 by jwe]
jwe
parents: 1024
diff changeset
45 if (nargin > 1)
5923
611e30b984b3 [project @ 2006-08-14 18:29:18 by jwe]
jwe
parents: 5443
diff changeset
46 print_usage ();
1062
1b3a87031641 [project @ 1995-01-24 02:54:50 by jwe]
jwe
parents: 1024
diff changeset
47 endif
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
48
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
49 if (nargin == 1)
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
50
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5307
diff changeset
51 if (ischar (map))
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
52 if (strcmp (map, "default"))
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6762
diff changeset
53 map = jet (64);
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
54 else
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 5923
diff changeset
55 map = feval (map);
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
56 endif
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
57 endif
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
58
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
59 if (! isempty (map))
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
60 if (columns (map) != 3)
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3457
diff changeset
61 error ("colormap: map must have 3 columns: [R,G,B]");
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
62 endif
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
63 if (min (min (map)) < 0 || max (max (map)) > 1)
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3457
diff changeset
64 error ("colormap: map must have values in [0,1]");
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
65 endif
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
66 ## Set the new color map
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 5923
diff changeset
67 set (gcf (), "colormap", map);
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
68 endif
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 3202
diff changeset
69
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
70 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
71
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
72 ## Return current color map.
7108
60a1165732f9 [project @ 2007-11-06 22:05:18 by jwe]
jwe
parents: 7017
diff changeset
73 if (nargout > 0 || (nargout == 0 && nargin == 0))
6762
721953d49b19 [project @ 2007-06-27 18:20:19 by jwe]
jwe
parents: 6257
diff changeset
74 cmap = get (gcf (), "colormap");
721953d49b19 [project @ 2007-06-27 18:20:19 by jwe]
jwe
parents: 6257
diff changeset
75 endif
1024
56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe]
jwe
parents: 904
diff changeset
76
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
77 endfunction