annotate scripts/plot/contourf.m @ 15063:36cbcc37fdb8

Refactor configure.ac to make it more understandable. Use common syntax for messages in config.h Correct typos, refer to libraries in all caps, use two spaces after period. Follow Autoconf guidelines and place general tests before specific tests. * configure.ac, m4/acinclude.m4: Use common syntax for messages in config.h Correct typos, refer to libraries in all caps, use two spaces after period. Follow Autoconf guidelines and place general tests before specific tests.
author Rik <rik@octave.org>
date Tue, 31 Jul 2012 10:28:51 -0700
parents c4fa5e0b6193
children 64e7bb01fce2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14092
diff changeset
1 ## Copyright (C) 2007-2012 Kai Habel
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
2 ## Copyright (C) 2003 Shai Ayal
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
3 ##
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7042
diff changeset
4 ## This file is part of Octave.
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7042
diff changeset
5 ##
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7042
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7042
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7042
diff changeset
9 ## your option) any later version.
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
10 ##
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7042
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
15 ##
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7042
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7042
diff changeset
18 ## <http://www.gnu.org/licenses/>.
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
19
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
21 ## @deftypefn {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z}, @var{lvl})
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z}, @var{n})
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z})
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{z}, @var{n})
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
25 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{z}, @var{lvl})
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
26 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{z})
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
27 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{ax}, @dots{})
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
28 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@dots{}, @var{"property"}, @var{val})
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
29 ## Compute and plot filled contours of the matrix @var{z}.
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
30 ## Parameters @var{x}, @var{y} and @var{n} or @var{lvl} are optional.
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
31 ##
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
32 ## The return value @var{c} is a 2xn matrix containing the contour lines
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
33 ## as described in the help to the contourc function.
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
34 ##
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
35 ## The return value @var{h} is handle-vector to the patch objects creating
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
36 ## the filled contours.
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
37 ##
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
38 ## If @var{x} and @var{y} are omitted they are taken as the row/column
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
39 ## index of @var{z}. @var{n} is a scalar denoting the number of lines
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
40 ## to compute. Alternatively @var{lvl} is a vector containing the
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
41 ## contour levels. If only one value (e.g., lvl0) is wanted, set
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
42 ## @var{lvl} to [lvl0, lvl0]. If both @var{n} or @var{lvl} are omitted
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
43 ## a default value of 10 contour level is assumed.
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
44 ##
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
45 ## If provided, the filled contours are added to the axes object
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
46 ## @var{ax} instead of the current axis.
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
47 ##
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
48 ## The following example plots filled contours of the @code{peaks}
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
49 ## function.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
50 ##
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
51 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
52 ## @group
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
53 ## [x, y, z] = peaks (50);
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
54 ## contourf (x, y, z, -7:9)
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
55 ## @end group
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
56 ## @end example
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
57 ## @seealso{contour, contourc, patch}
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
58 ## @end deftypefn
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
59
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
60 ## Author: Kai Habel <kai.habel@gmx.de>
7327
9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe]
jwe
parents: 7245
diff changeset
61 ## Author: Shai Ayal <shaiay@users.sourceforge.net>
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
62
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
63 function [c, h] = contourf (varargin)
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
64
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
65 [xh, varargin] = __plt_get_axis_arg__ ("contour", varargin{:});
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
66
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
67 oldh = gca ();
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
68 unwind_protect
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
69 axes (xh);
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
70 newplot ();
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
71 [ctmp, htmp] = __contour__ (xh, "none", "fill", "on",
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
72 "linecolor", "black", varargin{:});
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
73 unwind_protect_cleanup
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
74 axes (oldh);
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
75 end_unwind_protect
7570
8bf1bcb0ad8f set axes layer property to "top"
John W. Eaton <jwe@octave.org>
parents: 7331
diff changeset
76
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
77 if (nargout > 0)
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
78 c = ctmp;
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8227
diff changeset
79 h = htmp;
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
80 endif
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
81
7042
e54cc03d53f6 [project @ 2007-10-19 20:43:32 by jwe]
jwe
parents:
diff changeset
82 endfunction
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7216
diff changeset
83
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
84
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7216
diff changeset
85 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
86 %! clf;
14247
c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
87 %! colormap ('default');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7216
diff changeset
88 %! [x, y, z] = peaks (50);
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
89 %! contourf (x, y, z, -7:9);
7327
9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe]
jwe
parents: 7245
diff changeset
90
9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe]
jwe
parents: 7245
diff changeset
91 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
92 %! clf;
14247
c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
93 %! colormap ('default');
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
94 %! [theta, r] = meshgrid (linspace (0,2*pi,64), linspace (0,1,64));
7331
3ed85de5922c [project @ 2007-12-21 17:40:20 by jwe]
jwe
parents: 7327
diff changeset
95 %! [X, Y] = pol2cart (theta, r);
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
96 %! Z = sin (2*theta) .* (1-r);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
97 %! contourf (X, Y, abs (Z), 10);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
98