Mercurial > hg > octave-nkf
annotate scripts/plot/meshz.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 31 Jul 2013 13:53:30 -0700 |
parents | 328b579e08e9 |
children | 26589abbc78d |
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 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7 ## the Free Software Foundation; either version 3 of the License, or (at | |
8 ## your option) any later version. | |
9 ## | |
10 ## Octave is distributed in the hope that it will be useful, but | |
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 | |
16 ## along with Octave; see the file COPYING. If not, see | |
17 ## <http://www.gnu.org/licenses/>. | |
18 | |
19 ## -*- texinfo -*- | |
17122
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 | 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 | 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 | 60 endif |
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 | 76 z = varargin{1}; |
7207 | 77 [m, n] = size (z); |
7216 | 78 x = 1:n; |
79 y = (1:m).'; | |
7207 | 80 else |
7208 | 81 x = varargin{1}; |
82 y = varargin{2}; | |
83 z = varargin{3}; | |
7207 | 84 endif |
85 | |
86 if (isvector (x) && isvector (y)) | |
87 x = [x(1), x(:).', x(end)]; | |
88 y = [y(1); y(:); y(end)]; | |
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 | 96 endif |
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 | 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 | 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); |
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 htmp = mesh (hax, x, y, z, varargin{charidx:end}); |
7215 | 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 | 111 end_unwind_protect |
112 | |
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 | 115 endif |
7207 | 116 |
117 endfunction | |
16985
c9346014fed2
Validate inputs are real for mesh, meshc, meshz functions.
Rik <rik@octave.org>
parents:
14872
diff
changeset
|
118 |