annotate scripts/image/gmap40.m @ 17744:d63878346099

maint: Update copyright notices for release.
author John W. Eaton <jwe@octave.org>
date Wed, 23 Oct 2013 22:09:27 -0400
parents 1a800034d443
children 68cc16969f78
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 15720
diff changeset
1 ## Copyright (C) 2007-2013 David Bateman
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
2 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
4 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
8 ## your option) any later version.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
9 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
14 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
18
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
20 ## @deftypefn {Function File} {@var{map} =} gmap40 ()
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
21 ## @deftypefnx {Function File} {@var{map} =} gmap40 (@var{n})
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
22 ## Create color colormap. The colormap consists of red, green, blue, yellow,
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
23 ## magenta and cyan. This colormap is specifically designed for users of
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
24 ## gnuplot 4.0 where these 6 colors are the allowable ones for patch objects.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
25 ## The argument @var{n} must be a scalar.
14260
1f911333ed3d doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
26 ## If unspecified, a length of 6 is assumed. Larger values of @var{n} result
1f911333ed3d doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
27 ## in a repetition of the above colors.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
28 ## @seealso{colormap}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
29 ## @end deftypefn
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
30
14640
b9c02ee24de1 new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents: 14279
diff changeset
31 ## PKG_ADD: colormap ("register", "gmap40");
b9c02ee24de1 new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents: 14279
diff changeset
32 ## PKG_DEL: colormap ("unregister", "gmap40");
b9c02ee24de1 new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents: 14279
diff changeset
33
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
34 function map = gmap40 (n)
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
35
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
36 if (nargin == 0)
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
37 n = 6;
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
38 elseif (nargin == 1)
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
39 if (! isscalar (n))
15720
1a800034d443 Colormap error() calls now report the input variable which is a problem.
Rik <rik@octave.org>
parents: 14641
diff changeset
40 error ("gmap40: N must be a scalar");
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
41 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
42 else
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
43 print_usage ();
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
44 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
45
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
46 if (n > 1)
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
47 C = [1, 0, 0; 0, 1, 0; 0, 0, 1; 1, 1, 0; 1, 0, 1; 0, 1, 1];
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
48 map = C(rem (0:(n-1), 6) + 1, :);
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
49 else
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
50 map = zeros (0, 3);
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
51 endif
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
52
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
53 endfunction
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
54
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
55
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
56 %!demo
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
57 %! ## Show the 'gmap40' colormap as an image
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
58 %! image (1:6, linspace (0, 1, 6), repmat ((1:6)', 1, 6));
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
59 %! axis ([1, 6, 0, 1], "ticy", "xy");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
60 %! colormap (gmap40 (6));
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
61