octave-nkf: scripts/plot/draw/contour.m annotate

annotate scripts/plot/draw/contour.m @ 20595:c1a6c31ac29a

eliminate more simple uses of error_state * ov-classdef.cc: Eliminate simple uses of error_state.

author	John W. Eaton <jwe@octave.org>
date	Tue, 06 Oct 2015 00:20:02 -0400
parents	777f26aa8e3e
children

rev	line source
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19627 diff changeset	1 ## Copyright (C) 1993-2015 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 ##
20208 777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19731 diff changeset	40 ## The optional output @var{c} contains the contour levels in @code{contourc}
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19731 diff changeset	41 ## format.
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17050 diff changeset	42 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17050 diff changeset	43 ## 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	44 ## comprising the contour lines.
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17050 diff changeset	45 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17050 diff changeset	46 ## Example:
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6172 diff changeset	47 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6172 diff changeset	48 ## @example
6604 c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe] jwe parents: 6547 diff changeset	49 ## @group
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe] jwe parents: 6547 diff changeset	50 ## x = 0:2;
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe] jwe parents: 6547 diff changeset	51 ## y = x;
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe] jwe parents: 6547 diff changeset	52 ## z = x' * y;
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe] jwe parents: 6547 diff changeset	53 ## contour (x, y, z, 2:3)
c2b700808e0a [project @ 2007-05-02 05:36:43 by jwe] jwe parents: 6547 diff changeset	54 ## @end group
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6172 diff changeset	55 ## @end example
7170 9f38c6293317 [project @ 2007-11-13 17:34:33 by jwe] jwe parents: 7017 diff changeset	56 ##
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17050 diff changeset	57 ## @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	58 ##
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3136 diff changeset	59 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	60
7327 9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe] jwe parents: 7317 diff changeset	61 ## Author: Shai Ayal <shaiay@users.sourceforge.net>
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6172 diff changeset	62
7170 9f38c6293317 [project @ 2007-11-13 17:34:33 by jwe] jwe parents: 7017 diff changeset	63 function [c, h] = contour (varargin)
6434 7caa5942d4da [project @ 2007-03-23 13:59:29 by jwe] jwe parents: 6279 diff changeset	64
17050 9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__. Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 16911 diff changeset	65 [hax, varargin] = __plt_get_axis_arg__ ("contour", varargin{:});
7216 5389a52df87b [project @ 2007-11-29 19:07:29 by jwe] jwe parents: 7215 diff changeset	66
17211 87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. Rik <rik@octave.org> parents: 17190 diff changeset	67 oldfig = [];
17301 68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc. Rik <rik@octave.org> parents: 17257 diff changeset	68 if (! isempty (hax))
17211 87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. Rik <rik@octave.org> parents: 17190 diff changeset	69 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. Rik <rik@octave.org> parents: 17190 diff changeset	70 endif
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7189 diff changeset	71 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	72 hax = newplot (hax);
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	73
17050 9ff7d4849f03 contour[3f].m: Update to use new __plt_get_axis_arg__. Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 16911 diff changeset	74 [ctmp, htmp] = __contour__ (hax, "none", varargin{:});
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7189 diff changeset	75 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	76 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	77 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	78 endif
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7189 diff changeset	79 end_unwind_protect
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6172 diff changeset	80
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6172 diff changeset	81 if (nargout > 0)
7170 9f38c6293317 [project @ 2007-11-13 17:34:33 by jwe] jwe parents: 7017 diff changeset	82 c = ctmp;
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7170 diff changeset	83 h = htmp;
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	84 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	85
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	86 endfunction
7245 d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7216 diff changeset	87
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	88
7245 d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7216 diff changeset	89 %!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	90 %! 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	91 %! colormap ('default');
7245 d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7216 diff changeset	92 %! [x, y, z] = peaks ();
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7216 diff changeset	93 %! contour (x, y, z);
17257 ce55a8575874 Fix typo in titles for contour/contourf demos. Rik <rik@octave.org> parents: 17211 diff changeset	94 %! title ({'contour() plot (isolines of constant Z)'; 'Z = peaks()'});
7327 9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe] jwe parents: 7317 diff changeset	95
9af6f0a214ee [project @ 2007-12-19 21:39:02 by jwe] jwe parents: 7317 diff changeset	96 %!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	97 %! 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	98 %! 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	99 %! [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	100 %! [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	101 %! Z = sin (2theta) . (1-r);
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14247 diff changeset	102 %! contour (X, Y, abs (Z), 10);
17257 ce55a8575874 Fix typo in titles for contour/contourf demos. Rik <rik@octave.org> parents: 17211 diff changeset	103 %! title ({'contour() plot'; 'polar fcn: Z = sin (2theta) (1-r)'});
13156 da71f676e449 Fix bug #34282. Fill holes in contours with the background colour Ben Abbott <bpabbott@mac.com> parents: 11587 diff changeset	104
17525 76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	105 %!demo
76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	106 %! clf;
76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	107 %! colormap ('default');
76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	108 %! z = peaks ();
76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	109 %! contour (z, [0 0]);
76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	110 %! title ({'contour() plot with single isoline at Z == 0'; 'Z = peaks()'});
76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	111
16911 5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	112 %!test
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	113 %! hf = figure ("visible", "off");
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	114 %! clf (hf);
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	115 %! unwind_protect
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	116 %! [x, y, z] = peaks ();
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	117 %! [c, h] = contour (x, y, z);
17525 76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	118 %! levellist = -6:6;
16911 5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	119 %! set (h, "levellist", levellist);
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	120 %! assert (get (h, "levellist"), levellist)
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	121 %! assert (get (h, "levellistmode"), "manual")
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	122 %! unwind_protect_cleanup
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	123 %! close (hf);
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	124 %! end_unwind_protect
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	125
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	126 %!test
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	127 %! hf = figure ("visible", "off");
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	128 %! clf (hf);
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	129 %! unwind_protect
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	130 %! [x, y, z] = peaks ();
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	131 %! [c, h] = contour (x, y, z);
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	132 %! levelstep = 3;
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	133 %! set (h, "levelstep", levelstep);
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	134 %! assert (get (h, "levelstep"), levelstep)
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	135 %! assert (get (h, "levelstepmode"), "manual")
17525 76a6d7de4cbc Fix multiple problem with listeners for contour groups. Rik <rik@octave.org> parents: 17301 diff changeset	136 %! assert (get (h, "levellist"), -6:levelstep:6)
16911 5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	137 %! assert (get (h, "levellistmode"), "auto")
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	138 %! unwind_protect_cleanup
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	139 %! close (hf);
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	140 %! end_unwind_protect
5ea6a6d2b83f Fix contour() listeners. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	141

Mercurial > octave-nkf

annotate scripts/plot/draw/contour.m @ 20595:c1a6c31ac29a