Mercurial > hg > octave-lyh

annotate scripts/plot/meshz.m @ 17130:26589abbc78d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Don't pass axis handle unnecessarily from high level to low level plot functions. * scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contourf.m, scripts/plot/cylinder.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/feather.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/pcolor.m, scripts/plot/plot3.m, scripts/plot/rectangle.m, scripts/plot/rose.m, scripts/plot/scatter3.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m, scripts/plot/semilogyerr.m, scripts/plot/slice.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfnorm.m, scripts/plot/trimesh.m, scripts/plot/trisurf.m: Don't pass hax to lower level functions after newplot() has been called.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 18:42:17 -0700
parents eaab03308c0b
children 4b834dbe4b3e
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: 11587
diff changeset
1 ## Copyright (C) 2007-2012 David Bateman
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
2 ##
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
4 ##
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
9 ##
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
14 ##
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
18
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
20 ## @deftypefn {Function File} {} meshz (@var{x}, @var{y}, @var{z})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
21 ## @deftypefnx {Function File} {} meshz (@var{z})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
22 ## @deftypefnx {Function File} {} meshz (@dots{}, @var{c})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
23 ## @deftypefnx {Function File} {} meshz (@dots{}, @var{prop}, @var{val}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
24 ## @deftypefnx {Function File} {} meshz (@var{hax}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
25 ## @deftypefnx {Function File} {@var{h} =} meshz (@dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
26 ## Plot a 3-D wireframe mesh with a surrounding curtain.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
27 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
28 ## The wireframe mesh is plotted using rectangles. The vertices of the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
29 ## rectangles [@var{x}, @var{y}] are typically the output of @code{meshgrid}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
30 ## over a 2-D rectangular region in the x-y plane. @var{z} determines the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
31 ## height above the plane of each vertex. If only a single @var{z} matrix is
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
32 ## given, then it is plotted over the meshgrid
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
33 ## @code{@var{x} = 1:columns (@var{z}), @var{y} = 1:rows (@var{z})}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
34 ## Thus, columns of @var{z} correspond to different @var{x} values and rows
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
35 ## of @var{z} correspond to different @var{y} values.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
36 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
37 ## The color of the mesh is computed by linearly scaling the @var{Z} values
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
38 ## to fit the range of the current colormap. Use @code{caxis} and/or
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
39 ## change the colormap to control the appearance.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
40 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
41 ## Optionally the color of the mesh can be specified independently of @var{z}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
42 ## by supplying a color matrix, @var{c}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
43 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
44 ## Any property/value pairs are passed directly to the underlying surface
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
45 ## object.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
46 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
47 ## 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: 17066
diff changeset
48 ## rather than the current axes returned by @code{gca}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
49 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
50 ## The optional return value @var{h} is a graphics handle to the created
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
51 ## surface object.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
52 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
53 ## @seealso{mesh, meshc, contour, surf, surface, waterfall, meshgrid, hidden, shading, colormap, caxis}
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
54 ## @end deftypefn
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
55
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
56 function h = meshz (varargin)
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
57
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
58 if (! all (cellfun ("isreal", varargin)))
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
59 error ("meshz: X, Y, Z, C arguments must be real");
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
60 endif
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
61
17066
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
62 [hax, varargin, nargin] = __plt_get_axis_arg__ ("meshz", varargin{:});
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
63
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
64 ## Find where property/value pairs start
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
65 charidx = find (cellfun ("isclass", varargin, "char"), 1);
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
66
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
67 if (isempty (charidx))
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
68 if (nargin == 2 || nargin == 4)
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
69 charidx = nargin; # bundle C matrix back into varargin
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
70 else
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
71 charidx = nargin + 1;
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
72 endif
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
73 endif
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
74
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
75 if (charidx == 2)
7208
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7207
diff changeset
76 z = varargin{1};
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
77 [m, n] = size (z);
7216
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
78 x = 1:n;
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
79 y = (1:m).';
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
80 else
7208
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7207
diff changeset
81 x = varargin{1};
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7207
diff changeset
82 y = varargin{2};
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7207
diff changeset
83 z = varargin{3};
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
84 endif
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
85
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
86 if (isvector (x) && isvector (y))
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
87 x = [x(1), x(:).', x(end)];
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
88 y = [y(1); y(:); y(end)];
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
89 else
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
90 x = [x(1,1), x(1,:), x(1,end);
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
91 x(:,1), x, x(:,end);
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
92 x(end,1), x(end,:), x(end,end)];
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
93 y = [y(1,1), y(1,:), y(1,end);
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
94 y(:,1), y, y(:,end);
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
95 y(end,1), y(end,:), y(end,end)];
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
96 endif
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
97
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
98 zref = min (z(isfinite (z)));
14872
c2dbdeaa25df maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents: 14868
diff changeset
99 z = [zref .* ones(1, columns(z) + 2);
c2dbdeaa25df maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents: 14868
diff changeset
100 zref .* ones(rows(z), 1), z, zref .* ones(rows(z), 1);
17066
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
101 zref .* ones(1, columns(z) + 2)];
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
102
17066
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
103 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure"));
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
104 unwind_protect
17066
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
105 hax = newplot (hax);
17130
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17126
diff changeset
106 htmp = mesh (x, y, z, varargin{charidx:end});
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
107 unwind_protect_cleanup
17066
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
108 if (! isempty (oldfig))
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
109 set (0, "currentfigure", oldfig);
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
110 endif
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
111 end_unwind_protect
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
112
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
113 if (nargout > 0)
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
114 h = htmp;
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
115 endif
7207
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
116
71c03c7239fb [project @ 2007-11-28 02:19:25 by jwe]
jwe
parents:
diff changeset
117 endfunction
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14872
diff changeset
118