Mercurial > octave

annotate scripts/plot/draw/meshc.m @ 30329:81d26e8481a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Shorten @seealso lines to less than 80 characters (bug #57599) * chol.cc, data.cc, debug.cc, file-io.cc, load-save.cc, oct-hist.cc, pr-output.cc, sparse.cc, syscalls.cc, time.cc, utils.cc, ov-struct.cc, base64decode.m, base64encode.m, getappdata.m, isappdata.m, setappdata.m, colormap.m, isdir.m, cast.m, getfield.m, isfile.m, isfolder.m, setfield.m, contour.m, contour3.m, contourf.m, ezplot.m, isosurface.m, mesh.m, meshc.m, meshz.m, plot.m, surf.m, surfc.m, waterfall.m, movmad.m, movmax.m, movmean.m, movmedian.m, movmin.m, movprod.m, movstd.m, movsum.m, movvar.m: Shorten @seealso lines to less than 80 characters.
author Rik <rik@octave.org>
date Tue, 23 Nov 2021 11:26:38 -0800
parents 0a5b15007766
children 796f54d4ddbf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
29358
0a5b15007766 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 28733
diff changeset
3 ## Copyright (C) 1996-2021 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
7 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
8 ## This file is part of Octave.
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24432
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24432
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22355
diff changeset
13 ## (at your option) any later version.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
14 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22355
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22355
diff changeset
18 ## GNU General Public License for more details.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
19 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
20 ## 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: 6788
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24432
diff changeset
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
25
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 ## @deftypefn {} {} meshc (@var{x}, @var{y}, @var{z})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
28 ## @deftypefnx {} {} meshc (@var{z})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
29 ## @deftypefnx {} {} meshc (@dots{}, @var{c})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
30 ## @deftypefnx {} {} meshc (@dots{}, @var{prop}, @var{val}, @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
31 ## @deftypefnx {} {} meshc (@var{hax}, @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
32 ## @deftypefnx {} {@var{h} =} meshc (@dots{})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
33 ## Plot a 3-D wireframe mesh with underlying contour lines.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
34 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
35 ## 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
36 ## 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
37 ## 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
38 ## 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
39 ## given, then it is plotted over the meshgrid
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
40 ## @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
41 ## Thus, columns of @var{z} correspond to different @var{x} values and rows
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17211
diff changeset
42 ## of @var{z} correspond to different @var{y} values.
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
43 ##
17450
43e0b711d7e0 doc: Correct accidental capitalization @var{Z} in mesh/surf docstrings.
Rik <rik@octave.org>
parents: 17301
diff changeset
44 ## The color of the mesh is computed by linearly scaling the @var{z} values
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
45 ## 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
46 ## change the colormap to control the appearance.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
47 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
48 ## 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
49 ## by supplying a color matrix, @var{c}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
50 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
51 ## Any property/value pairs are passed directly to the underlying surface
28733
9342688e86b4 Updated property references for text and graphics functions (bug #50247)
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27923
diff changeset
52 ## object. The full list of properties is documented at
9342688e86b4 Updated property references for text and graphics functions (bug #50247)
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27923
diff changeset
53 ## @ref{Surface Properties}.
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
54 ##
24431
0c6cedafc71e doc: Use 'axes' rather than 'axis' appropriately in docstrings.
Rik <rik@octave.org>
parents: 23219
diff changeset
55 ## If the first argument @var{hax} is an axes handle, then plot into this axes,
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
56 ## 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
57 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
58 ## The optional return value @var{h} is a 2-element vector with a graphics
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
59 ## handle to the created surface object and to the created contour plot.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17066
diff changeset
60 ##
30329
81d26e8481a6 maint: Shorten @seealso lines to less than 80 characters (bug #57599)
Rik <rik@octave.org>
parents: 29358
diff changeset
61 ## @seealso{ezmeshc, mesh, meshz, contour, surfc, surface, meshgrid, hidden,
81d26e8481a6 maint: Shorten @seealso lines to less than 80 characters (bug #57599)
Rik <rik@octave.org>
parents: 29358
diff changeset
62 ## shading, colormap, caxis}
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
63 ## @end deftypefn
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
64
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
65 function h = meshc (varargin)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
66
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
67 if (! all (cellfun ("isreal", varargin)))
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
68 error ("meshc: X, Y, Z, C arguments must be real");
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
69 endif
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
70
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
71 [hax, varargin, nargin] = __plt_get_axis_arg__ ("meshc", varargin{:});
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
72
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
73 oldfig = [];
17301
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17281
diff changeset
74 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
75 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
76 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
77 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
78 hax = newplot (hax);
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
79
18857
7bbe3658c5ef maint: Use "FIXME:" coding convention in m-files.
Rik <rik@octave.org>
parents: 17744
diff changeset
80 ## FIXME: gnuplot does not support a filled surface and a
7bbe3658c5ef maint: Use "FIXME:" coding convention in m-files.
Rik <rik@octave.org>
parents: 17744
diff changeset
81 ## non-filled contour. 3D filled patches are also not supported.
7bbe3658c5ef maint: Use "FIXME:" coding convention in m-files.
Rik <rik@octave.org>
parents: 17744
diff changeset
82 ## Thus, the facecolor will be transparent for the gnuplot backend.
22355
886530282db9 Set "facelighting" and "edgelighting" for mesh plots (bug #48507).
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22323
diff changeset
83 mesh_props = {"facecolor", "w", "edgecolor", "flat", ...
886530282db9 Set "facelighting" and "edgelighting" for mesh plots (bug #48507).
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22323
diff changeset
84 "facelighting", "none", "edgelighting", "flat"};
18896
4d75bda5df80 mesh, meshc, surfc: Allow user provided properties to override defaults.
Rik <rik@octave.org>
parents: 18857
diff changeset
85 chararg = find (cellfun ("isclass", varargin, "char"), 1);
4d75bda5df80 mesh, meshc, surfc: Allow user provided properties to override defaults.
Rik <rik@octave.org>
parents: 18857
diff changeset
86 if (isempty (chararg))
4d75bda5df80 mesh, meshc, surfc: Allow user provided properties to override defaults.
Rik <rik@octave.org>
parents: 18857
diff changeset
87 htmp = surface (varargin{:}, mesh_props{:});
4d75bda5df80 mesh, meshc, surfc: Allow user provided properties to override defaults.
Rik <rik@octave.org>
parents: 18857
diff changeset
88 else
4d75bda5df80 mesh, meshc, surfc: Allow user provided properties to override defaults.
Rik <rik@octave.org>
parents: 18857
diff changeset
89 htmp = surface (varargin{1:chararg-1}, mesh_props{:},
4d75bda5df80 mesh, meshc, surfc: Allow user provided properties to override defaults.
Rik <rik@octave.org>
parents: 18857
diff changeset
90 varargin{chararg:end});
4d75bda5df80 mesh, meshc, surfc: Allow user provided properties to override defaults.
Rik <rik@octave.org>
parents: 18857
diff changeset
91 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
92
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
93 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
94 set (hax, "view", [-37.5, 30],
17167
0a761f218d8d Fix contour plot axis to x-y data range, not axis ("tight").
Rik <rik@octave.org>
parents: 17126
diff changeset
95 "xgrid", "on", "ygrid", "on", "zgrid", "on",
0a761f218d8d Fix contour plot axis to x-y data range, not axis ("tight").
Rik <rik@octave.org>
parents: 17126
diff changeset
96 "xlimmode", "manual", "ylimmode", "manual");
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
97 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
98
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
99 drawnow ();
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
100
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 zmin = get (hax, "zlim")(1);
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
102 [~, htmp2] = __contour__ (hax, zmin, varargin{:});
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
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16985
diff changeset
104 htmp = [htmp; htmp2];
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
105
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
106 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
107 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
108 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
109 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
110 end_unwind_protect
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
111
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
112 if (nargout > 0)
16985
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents: 14138
diff changeset
113 h = htmp;
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
114 endif
7119
d22ad51b9cf8 [project @ 2007-11-07 21:06:27 by jwe]
jwe
parents: 7017
diff changeset
115
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
116 endfunction
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
117
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17167
diff changeset
118
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17167
diff changeset
119 %!demo
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17167
diff changeset
120 %! clf;
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 20852
diff changeset
121 %! colormap ("default");
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17167
diff changeset
122 %! [X, Y] = meshgrid (linspace (-3, 3, 40));
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17167
diff changeset
123 %! Z = sqrt (abs (X .* Y)) ./ (1 + X.^2 + Y.^2);
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17167
diff changeset
124 %! meshc (X, Y, Z);
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 20852
diff changeset
125 %! title ("meshc() combines mesh/contour plots");