Mercurial > hg > octave-nkf
annotate scripts/plot/contour.m @ 17204:d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
* scripts/plot/legend.m, scripts/plot/newplot.m,
scripts/plot/plot.m: Don't use spacer rows between multitable items.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 07 Aug 2013 22:20:32 -0700 |
| parents | df4c4b7708a4 |
| children | 87ba70043bfc |
| 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 | 2 ## |
| 6440 | 3 ## This file is part of Octave. |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 2313 | 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 ## |
| 6440 | 10 ## Octave is distributed in the hope that it will be useful, but |
| 2313 | 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/>. | |
| 245 | 18 |
| 3368 | 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 | 21 ## @deftypefnx {Function File} {} contour (@var{z}, @var{vn}) |
| 22 ## @deftypefnx {Function File} {} contour (@var{x}, @var{y}, @var{z}) | |
| 23 ## @deftypefnx {Function File} {} contour (@var{x}, @var{y}, @var{z}, @var{vn}) | |
| 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 | 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 | 29 ## Plot level curves (contour lines) of the matrix @var{z}, using the |
| 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 | 46 ## |
| 47 ## @example | |
| 6604 | 48 ## @group |
| 49 ## x = 0:2; | |
| 50 ## y = x; | |
| 51 ## z = x' * y; | |
| 52 ## contour (x, y, z, 2:3) | |
| 53 ## @end group | |
| 6257 | 54 ## @end example |
| 7170 | 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 | 57 ## |
| 3368 | 58 ## @end deftypefn |
| 4 | 59 |
| 7327 | 60 ## Author: Shai Ayal <shaiay@users.sourceforge.net> |
| 6257 | 61 |
| 7170 | 62 function [c, h] = contour (varargin) |
| 6434 | 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 | 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 | 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 | 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 | 75 end_unwind_protect |
| 6257 | 76 |
| 77 if (nargout > 0) | |
| 7170 | 78 c = ctmp; |
| 7189 | 79 h = htmp; |
| 4 | 80 endif |
| 81 | |
| 82 endfunction | |
| 7245 | 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 | 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 | 88 %! [x, y, z] = peaks (); |
| 89 %! contour (x, y, z); | |
|
17190
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
90 %! title ('contour() plot of peaks() function'); |
|
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
91 %! title ({'contour() plot (isolines of constant Z)'; 'Z = peaks()'); |
| 7327 | 92 |
| 93 %!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
|
94 %! 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
|
95 %! 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
|
96 %! [theta, r] = meshgrid (linspace (0,2*pi,64), linspace (0,1,64)); |
| 7331 | 97 %! [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
|
98 %! 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
|
99 %! contour (X, Y, abs (Z), 10); |
|
17190
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
100 %! title ({'contour() plot'; 'polar fcn Z = sin (2*theta) * (1-r)'}); |
|
13156
da71f676e449
Fix bug #34282. Fill holes in contours with the background colour
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
101 |
| 16911 | 102 %!test |
| 103 %! hf = figure ("visible", "off"); | |
| 104 %! clf (hf); | |
| 105 %! unwind_protect | |
| 106 %! [x, y, z] = peaks (); | |
| 107 %! [c, h] = contour (x, y, z); | |
| 108 %! levellist = (-6):6; | |
| 109 %! set (h, "levellist", levellist); | |
| 110 %! assert (get (h, "levellist"), levellist) | |
| 111 %! assert (get (h, "levellistmode"), "manual") | |
| 112 %! unwind_protect_cleanup | |
| 113 %! close (hf); | |
| 114 %! end_unwind_protect | |
| 115 | |
| 116 %!test | |
| 117 %! hf = figure ("visible", "off"); | |
| 118 %! clf (hf); | |
| 119 %! unwind_protect | |
| 120 %! [x, y, z] = peaks (); | |
| 121 %! [c, h] = contour (x, y, z); | |
| 122 %! levelstep = 3; | |
| 123 %! set (h, "levelstep", levelstep); | |
| 124 %! assert (get (h, "levelstep"), levelstep) | |
| 125 %! assert (get (h, "levelstepmode"), "manual") | |
| 126 %! assert (get (h, "levellist"), (-6):levelstep:6) | |
| 127 %! assert (get (h, "levellistmode"), "auto") | |
| 128 %! unwind_protect_cleanup | |
| 129 %! close (hf); | |
| 130 %! end_unwind_protect | |
| 131 |