annotate scripts/plot/contour.m @ 17141:13da13e1e17f

waitbar.m: Cache axes and patch handles in figure's __guidata__. * scripts/plot/waitbar.m: Instead of calling "findobj" twice, cache the handles for the wait bar axes and patch objects in the figure's __guidata__ field.
author Philipp Kutin <philipp.kutin@gmail.com>
date Mon, 29 Jul 2013 12:18:16 +0200
parents 26589abbc78d
children df4c4b7708a4
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: 13156
diff changeset
1 ## Copyright (C) 1993-2012 Shai Ayal
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6434
diff changeset
3 ## This file is part of Octave.
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6434
diff changeset
4 ##
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6434
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## 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
7 ## 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
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6434
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## 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
16 ## 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
17 ## <http://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
18
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3136
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 8920
diff changeset
20 ## @deftypefn {Function File} {} contour (@var{z})
7317
11c5f1ee553e [project @ 2007-12-14 17:42:55 by jwe]
jwe
parents: 7245
diff changeset
21 ## @deftypefnx {Function File} {} contour (@var{z}, @var{vn})
11c5f1ee553e [project @ 2007-12-14 17:42:55 by jwe]
jwe
parents: 7245
diff changeset
22 ## @deftypefnx {Function File} {} contour (@var{x}, @var{y}, @var{z})
11c5f1ee553e [project @ 2007-12-14 17:42:55 by jwe]
jwe
parents: 7245
diff changeset
23 ## @deftypefnx {Function File} {} contour (@var{x}, @var{y}, @var{z}, @var{vn})
11c5f1ee553e [project @ 2007-12-14 17:42:55 by jwe]
jwe
parents: 7245
diff changeset
24 ## @deftypefnx {Function File} {} contour (@dots{}, @var{style})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
25 ## @deftypefnx {Function File} {} contour (@var{hax}, @dots{})
7170
9f38c6293317 [project @ 2007-11-13 17:34:33 by jwe]
jwe
parents: 7017
diff changeset
26 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contour (@dots{})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
27 ## Create a 2-D contour plot.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
28 ##
6604
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe]
jwe
parents: 6547
diff changeset
29 ## Plot level curves (contour lines) of the matrix @var{z}, using the
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe]
jwe
parents: 6547
diff changeset
30 ## contour matrix @var{c} computed by @code{contourc} from the same
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
31 ## arguments; see the latter for their interpretation.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
32 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
33 ## The appearance of contour lines can be defined with a line style @var{style}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
34 ## in the same manner as @code{plot}. Only line style and color are used;
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
35 ## Any markers defined by @var{style} are ignored.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
36 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
37 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
38 ## rather than the current axes returned by @code{gca}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
39 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
40 ## The optional output @var{c} are the contour levels in @code{contourc} format.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
41 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
42 ## The optional return value @var{h} is a graphics handle to the hggroup
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
43 ## comprising the contour lines.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
44 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
45 ## Example:
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
46 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
47 ## @example
6604
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe]
jwe
parents: 6547
diff changeset
48 ## @group
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe]
jwe
parents: 6547
diff changeset
49 ## x = 0:2;
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe]
jwe
parents: 6547
diff changeset
50 ## y = x;
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe]
jwe
parents: 6547
diff changeset
51 ## z = x' * y;
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe]
jwe
parents: 6547
diff changeset
52 ## contour (x, y, z, 2:3)
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe]
jwe
parents: 6547
diff changeset
53 ## @end group
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
54 ## @end example
7170
9f38c6293317 [project @ 2007-11-13 17:34:33 by jwe]
jwe
parents: 7017
diff changeset
55 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17050
diff changeset
56 ## @seealso{ezcontour, contourc, contourf, contour3, clabel, meshc, surfc, caxis, colormap, plot}
7317
11c5f1ee553e [project @ 2007-12-14 17:42:55 by jwe]
jwe
parents: 7245
diff changeset
57 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3136
diff changeset
58 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
59
7327
9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe]
jwe
parents: 7317
diff changeset
60 ## Author: Shai Ayal <shaiay@users.sourceforge.net>
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
61
7170
9f38c6293317 [project @ 2007-11-13 17:34:33 by jwe]
jwe
parents: 7017
diff changeset
62 function [c, h] = contour (varargin)
6434
7caa5942d4da [project @ 2007-03-23 13:59:29 by jwe]
jwe
parents: 6279
diff changeset
63
17050
9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16911
diff changeset
64 [hax, varargin] = __plt_get_axis_arg__ ("contour", varargin{:});
7216
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
65
17050
9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16911
diff changeset
66 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure"));
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7189
diff changeset
67 unwind_protect
17050
9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16911
diff changeset
68 hax = newplot (hax);
9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16911
diff changeset
69
9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16911
diff changeset
70 [ctmp, htmp] = __contour__ (hax, "none", varargin{:});
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7189
diff changeset
71 unwind_protect_cleanup
17050
9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16911
diff changeset
72 if (! isempty (oldfig))
9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16911
diff changeset
73 set (0, "currentfigure", oldfig);
9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16911
diff changeset
74 endif
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7189
diff changeset
75 end_unwind_protect
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
76
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
77 if (nargout > 0)
7170
9f38c6293317 [project @ 2007-11-13 17:34:33 by jwe]
jwe
parents: 7017
diff changeset
78 c = ctmp;
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7170
diff changeset
79 h = htmp;
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
80 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
81
b4df021f796c [project @ 1993-08-08 01:26:08 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: 14245
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 ();
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7216
diff changeset
89 %! contour (x, y, z);
7327
9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe]
jwe
parents: 7317
diff changeset
90
9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe]
jwe
parents: 7317
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: 14245
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);
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14247
diff changeset
97 %! contour (X, Y, abs (Z), 10);
13156
da71f676e449 Fix bug #34282. Fill holes in contours with the background colour
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
98
da71f676e449 Fix bug #34282. Fill holes in contours with the background colour
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
99 %!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
100 %! clf;
14247
c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents: 14245
diff changeset
101 %! colormap ('default');
13156
da71f676e449 Fix bug #34282. Fill holes in contours with the background colour
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
102 %! x = linspace (-2, 2);
da71f676e449 Fix bug #34282. Fill holes in contours with the background colour
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
103 %! [x, y] = meshgrid (x);
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
104 %! z = sqrt (x.^2 + y.^2) ./ (x.^2 + y.^2 + 1);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
105 %! contourf (x, y, z, [0.4, 0.4]);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
106 %! title ('The hole should be filled with the background color');
13156
da71f676e449 Fix bug #34282. Fill holes in contours with the background colour
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
107
16911
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
108 %!test
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
109 %! hf = figure ("visible", "off");
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
110 %! clf (hf);
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
111 %! unwind_protect
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
112 %! [x, y, z] = peaks ();
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
113 %! [c, h] = contour (x, y, z);
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
114 %! levellist = (-6):6;
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
115 %! set (h, "levellist", levellist);
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
116 %! assert (get (h, "levellist"), levellist)
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
117 %! assert (get (h, "levellistmode"), "manual")
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
118 %! unwind_protect_cleanup
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
119 %! close (hf);
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
120 %! end_unwind_protect
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
121
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
122 %!test
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
123 %! hf = figure ("visible", "off");
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
124 %! clf (hf);
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
125 %! unwind_protect
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
126 %! [x, y, z] = peaks ();
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
127 %! [c, h] = contour (x, y, z);
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
128 %! levelstep = 3;
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
129 %! set (h, "levelstep", levelstep);
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
130 %! assert (get (h, "levelstep"), levelstep)
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
131 %! assert (get (h, "levelstepmode"), "manual")
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
132 %! assert (get (h, "levellist"), (-6):levelstep:6)
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
133 %! assert (get (h, "levellistmode"), "auto")
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
134 %! unwind_protect_cleanup
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
135 %! close (hf);
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
136 %! end_unwind_protect
5ea6a6d2b83f Fix contour() listeners.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
137