Mercurial > hg > octave-lyh
comparison scripts/plot/meshz.m @ 17126: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 |
comparison
equal
deleted
inserted
replaced
| 17125:d4549655b92e | 17126:eaab03308c0b |
|---|---|
| 15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
| 16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} meshz (@var{x}, @var{y}, @var{z}) | 20 ## @deftypefn {Function File} {} meshz (@var{x}, @var{y}, @var{z}) |
| 21 ## Plot a curtain mesh given matrices @var{x}, and @var{y} from | 21 ## @deftypefnx {Function File} {} meshz (@var{z}) |
| 22 ## @code{meshgrid} and a matrix @var{z} corresponding to the @var{x} and | 22 ## @deftypefnx {Function File} {} meshz (@dots{}, @var{c}) |
| 23 ## @var{y} coordinates of the mesh. If @var{x} and @var{y} are vectors, | 23 ## @deftypefnx {Function File} {} meshz (@dots{}, @var{prop}, @var{val}, @dots{}) |
| 24 ## then a typical vertex is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, | 24 ## @deftypefnx {Function File} {} meshz (@var{hax}, @dots{}) |
| 25 ## columns of @var{z} correspond to different @var{x} values and rows of | 25 ## @deftypefnx {Function File} {@var{h} =} meshz (@dots{}) |
| 26 ## @var{z} correspond to different @var{y} values. | 26 ## Plot a 3-D wireframe mesh with a surrounding curtain. |
| 27 ## @seealso{meshgrid, mesh, contour} | 27 ## |
| 28 ## The wireframe mesh is plotted using rectangles. The vertices of the | |
| 29 ## rectangles [@var{x}, @var{y}] are typically the output of @code{meshgrid}. | |
| 30 ## over a 2-D rectangular region in the x-y plane. @var{z} determines the | |
| 31 ## height above the plane of each vertex. If only a single @var{z} matrix is | |
| 32 ## given, then it is plotted over the meshgrid | |
| 33 ## @code{@var{x} = 1:columns (@var{z}), @var{y} = 1:rows (@var{z})}. | |
| 34 ## Thus, columns of @var{z} correspond to different @var{x} values and rows | |
| 35 ## of @var{z} correspond to different @var{y} values. | |
| 36 ## | |
| 37 ## The color of the mesh is computed by linearly scaling the @var{Z} values | |
| 38 ## to fit the range of the current colormap. Use @code{caxis} and/or | |
| 39 ## change the colormap to control the appearance. | |
| 40 ## | |
| 41 ## Optionally the color of the mesh can be specified independently of @var{z} | |
| 42 ## by supplying a color matrix, @var{c}. | |
| 43 ## | |
| 44 ## Any property/value pairs are passed directly to the underlying surface | |
| 45 ## object. | |
| 46 ## | |
| 47 ## If the first argument @var{hax} is an axes handle, then plot into this axis, | |
| 48 ## rather than the current axes returned by @code{gca}. | |
| 49 ## | |
| 50 ## The optional return value @var{h} is a graphics handle to the created | |
| 51 ## surface object. | |
| 52 ## | |
| 53 ## @seealso{mesh, meshc, contour, surf, surface, waterfall, meshgrid, hidden, shading, colormap, caxis} | |
| 28 ## @end deftypefn | 54 ## @end deftypefn |
| 29 | 55 |
| 30 function h = meshz (varargin) | 56 function h = meshz (varargin) |
| 31 | 57 |
| 32 if (! all (cellfun ("isreal", varargin))) | 58 if (! all (cellfun ("isreal", varargin))) |