Mercurial > hg > octave-lyh

annotate scripts/plot/mesh.m @ 17487:f0f4b524b6d0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Correct indentation for several plot routines. * scripts/plot/ellipsoid.m, scripts/plot/rose.m, scripts/plot/sphere.m, scripts/plot/surfnorm.m: maint: Correct indentation for several plot routines.
author Rik <rik@octave.org>
date Wed, 25 Sep 2013 07:48:58 -0700
parents 43e0b711d7e0
children
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: 14032
diff changeset
1 ## Copyright (C) 1993-2012 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
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: 6405
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: 6405
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 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
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: 6405
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: 6405
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: 3063
diff changeset
19 ## -*- texinfo -*-
11101
1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf().
Ben Abbott <bpabbott@mac.com>
parents: 7149
diff changeset
20 ## @deftypefn {Function File} {} mesh (@var{x}, @var{y}, @var{z})
1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf().
Ben Abbott <bpabbott@mac.com>
parents: 7149
diff changeset
21 ## @deftypefnx {Function File} {} mesh (@var{z})
1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf().
Ben Abbott <bpabbott@mac.com>
parents: 7149
diff changeset
22 ## @deftypefnx {Function File} {} mesh (@dots{}, @var{c})
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
23 ## @deftypefnx {Function File} {} mesh (@dots{}, @var{prop}, @var{val}, @dots{})
11101
1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf().
Ben Abbott <bpabbott@mac.com>
parents: 7149
diff changeset
24 ## @deftypefnx {Function File} {} mesh (@var{hax}, @dots{})
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
25 ## @deftypefnx {Function File} {@var{h} =} mesh (@dots{})
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
26 ## Plot a 3-D wireframe mesh.
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
17289
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17219
diff changeset
35 ## of @var{z} correspond to different @var{y} values.
11101
1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf().
Ben Abbott <bpabbott@mac.com>
parents: 7149
diff changeset
36 ##
17458
43e0b711d7e0 doc: Correct accidental capitalization @var{Z} in mesh/surf docstrings.
Rik <rik@octave.org>
parents: 17309
diff changeset
37 ## The color of the mesh is computed by linearly scaling the @var{z} values
17126
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}.
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11575
diff changeset
49 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11575
diff changeset
50 ## The optional return value @var{h} is a graphics handle to the created
14032
8497d89a17f1 mesh.m: Correct typo in documentation
Rik <octave@nomad.inbox5.com>
parents: 14001
diff changeset
51 ## surface object.
17126
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{ezmesh, meshc, meshz, trimesh, contour, surf, surface, meshgrid, hidden, shading, colormap, caxis}
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
54 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
55
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
56 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
57
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents: 7017
diff changeset
58 function h = mesh (varargin)
6172
2de853a110df [project @ 2006-11-15 22:53:47 by jwe]
jwe
parents: 6158
diff changeset
59
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
60 if (! all (cellfun ("isreal", varargin)))
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
61 error ("mesh: X, Y, Z, C arguments must be real");
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
62 endif
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
63
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
64 [hax, varargin, nargin] = __plt_get_axis_arg__ ("mesh", varargin{:});
6390
334499d75c5c [project @ 2007-03-07 18:11:28 by jwe]
jwe
parents: 6257
diff changeset
65
17219
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17198
diff changeset
66 oldfig = [];
17309
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17289
diff changeset
67 if (! isempty (hax))
17219
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17198
diff changeset
68 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17198
diff changeset
69 endif
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
70 unwind_protect
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
71 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
72
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17126
diff changeset
73 htmp = surface (varargin{:});
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
74
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
75 set (htmp, "facecolor", "w");
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
76 set (htmp, "edgecolor", "flat");
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
77 if (! ishold ())
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
78 set (hax, "view", [-37.5, 30],
17130
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17126
diff changeset
79 "xgrid", "on", "ygrid", "on", "zgrid", "on");
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
80 endif
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
81 unwind_protect_cleanup
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
82 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
83 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
84 endif
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
85 end_unwind_protect
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
86
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
87 if (nargout > 0)
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
88 h = htmp;
6154
08f0dabf17b9 [project @ 2006-11-13 18:30:25 by jwe]
jwe
parents: 6146
diff changeset
89 endif
08f0dabf17b9 [project @ 2006-11-13 18:30:25 by jwe]
jwe
parents: 6146
diff changeset
90
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
91 endfunction
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11575
diff changeset
92
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11575
diff changeset
93
14411
b9630dfc4fd9 Add mesh() demos.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
94 %!demo
16828
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents: 14868
diff changeset
95 %! clf;
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14412
diff changeset
96 %! x = logspace (0,1,11);
14411
b9630dfc4fd9 Add mesh() demos.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
97 %! z = x'*x;
17198
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
98 %! mesh (x, x, z);
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
99 %! xlabel 'X-axis';
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
100 %! ylabel 'Y-axis';
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
101 %! zlabel 'Z-axis';
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
102 %! title ('mesh() with color proportional to height');
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
103
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
104 %!demo
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
105 %! clf;
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
106 %! x = logspace (0,1,11);
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
107 %! z = x'*x;
14411
b9630dfc4fd9 Add mesh() demos.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
108 %! mesh (x, x, z, z.^2);
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
109 %! xlabel 'X-axis';
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
110 %! ylabel 'Y-axis';
16828
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents: 14868
diff changeset
111 %! zlabel 'linear scale';
17198
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
112 %! title ('mesh() with color proportional to Z^2');
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11575
diff changeset
113
14411
b9630dfc4fd9 Add mesh() demos.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
114 %!demo
16828
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents: 14868
diff changeset
115 %! clf;
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14412
diff changeset
116 %! x = logspace (0,1,11);
14411
b9630dfc4fd9 Add mesh() demos.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
117 %! z = x'*x;
b9630dfc4fd9 Add mesh() demos.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
118 %! mesh (x, x, z, z.^2);
16828
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents: 14868
diff changeset
119 %! set (gca, 'zscale', 'log');
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
120 %! xlabel 'X-axis';
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 16828
diff changeset
121 %! ylabel 'Y-axis';
16828
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents: 14868
diff changeset
122 %! zlabel 'log scale';
17198
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
123 %! title ({'mesh() with color proportional to Z^2', 'Z-axis is log scale'});
16828
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents: 14868
diff changeset
124 %! if (strcmp (get (gcf, '__graphics_toolkit__'), 'gnuplot'))
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
125 %! title ({'Gnuplot: mesh color is wrong', 'This is a Gnuplot bug'});
14411
b9630dfc4fd9 Add mesh() demos.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
126 %! endif
b9630dfc4fd9 Add mesh() demos.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
127