Mercurial > hg > octave-lyh
annotate scripts/plot/contour.m @ 11523:fd0a3ac60b0e
update copyright notices
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Fri, 14 Jan 2011 05:47:45 -0500 |
| parents | be55736a0783 |
| children | c792872f8942 |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 1993-2011 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}) | |
| 25 ## @deftypefnx {Function File} {} contour (@var{h}, @dots{}) | |
| 7170 | 26 ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contour (@dots{}) |
| 6604 | 27 ## Plot level curves (contour lines) of the matrix @var{z}, using the |
| 28 ## contour matrix @var{c} computed by @code{contourc} from the same | |
| 6895 | 29 ## arguments; see the latter for their interpretation. The set of |
| 30 ## contour levels, @var{c}, is only returned if requested. For example: | |
| 6257 | 31 ## |
| 32 ## @example | |
| 6604 | 33 ## @group |
| 34 ## x = 0:2; | |
| 35 ## y = x; | |
| 36 ## z = x' * y; | |
| 37 ## contour (x, y, z, 2:3) | |
| 38 ## @end group | |
| 6257 | 39 ## @end example |
| 7170 | 40 ## |
| 7317 | 41 ## The style to use for the plot can be defined with a line style @var{style} |
| 42 ## in a similar manner to the line styles used with the @code{plot} command. | |
| 43 ## Any markers defined by @var{style} are ignored. | |
| 44 ## | |
| 7170 | 45 ## The optional input and output argument @var{h} allows an axis handle to |
| 46 ## be passed to @code{contour} and the handles to the contour objects to be | |
| 47 ## returned. | |
| 48 ## @seealso{contourc, patch, plot} | |
| 3368 | 49 ## @end deftypefn |
| 4 | 50 |
| 7327 | 51 ## Author: Shai Ayal <shaiay@users.sourceforge.net> |
| 6257 | 52 |
| 7170 | 53 function [c, h] = contour (varargin) |
| 6434 | 54 |
| 7216 | 55 [xh, varargin] = __plt_get_axis_arg__ ("contour", varargin{:}); |
| 56 | |
| 7215 | 57 oldh = gca (); |
| 58 unwind_protect | |
| 7216 | 59 axes (xh); |
| 7170 | 60 newplot (); |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
7331
diff
changeset
|
61 [ctmp, htmp] = __contour__ (xh, "none", varargin{:}); |
| 7215 | 62 unwind_protect_cleanup |
| 63 axes (oldh); | |
| 64 end_unwind_protect | |
| 6257 | 65 |
| 66 if (nargout > 0) | |
| 7170 | 67 c = ctmp; |
| 7189 | 68 h = htmp; |
| 4 | 69 endif |
| 70 | |
| 71 endfunction | |
| 7245 | 72 |
| 73 %!demo | |
| 74 %! [x, y, z] = peaks (); | |
| 75 %! contour (x, y, z); | |
| 7327 | 76 |
| 77 %!demo | |
| 7331 | 78 %! [theta, r] = meshgrid (linspace (0, 2*pi, 64), linspace(0,1,64)); |
| 79 %! [X, Y] = pol2cart (theta, r); | |
| 80 %! Z = sin(2*theta).*(1-r); | |
| 81 %! contour(X, Y, abs(Z), 10) |