Mercurial > octave-nkf
annotate scripts/image/colormap.m @ 14138:72c96de7a403 stable
maint: update copyright notices for 2012
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 02 Jan 2012 14:25:41 -0500 |
| parents | fd0a3ac60b0e |
| children | 8b220af26cfb |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
1 ## Copyright (C) 1994-2012 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 -*- |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
20 ## @deftypefn {Function File} {} colormap (@var{map}) |
| 3373 | 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 |
| 2312 | 40 function cmap = colormap (map) |
| 559 | 41 |
| 1062 | 42 if (nargin > 1) |
| 5923 | 43 print_usage (); |
| 1062 | 44 endif |
| 559 | 45 |
| 1024 | 46 if (nargin == 1) |
| 3238 | 47 |
| 5443 | 48 if (ischar (map)) |
| 1024 | 49 if (strcmp (map, "default")) |
| 6895 | 50 map = jet (64); |
| 559 | 51 else |
| 6257 | 52 map = feval (map); |
| 559 | 53 endif |
| 3238 | 54 endif |
| 55 | |
| 56 if (! isempty (map)) | |
| 57 if (columns (map) != 3) | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
58 error ("colormap: MAP must have 3 columns: [R,G,B]"); |
| 3238 | 59 endif |
| 60 if (min (min (map)) < 0 || max (max (map)) > 1) | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
61 error ("colormap: MAP must have values in [0,1]"); |
| 3238 | 62 endif |
| 2303 | 63 ## Set the new color map |
| 6257 | 64 set (gcf (), "colormap", map); |
| 559 | 65 endif |
| 3238 | 66 |
| 559 | 67 endif |
| 68 | |
| 2303 | 69 ## Return current color map. |
| 7108 | 70 if (nargout > 0 || (nargout == 0 && nargin == 0)) |
| 6762 | 71 cmap = get (gcf (), "colormap"); |
| 72 endif | |
| 1024 | 73 |
| 559 | 74 endfunction |