octave-lyh: scripts/plot/meshc.m annotate

annotate scripts/plot/meshc.m @ 17496:edd15fceff14

guihandles.m: Overhaul function. * scripts/plot/guihandles.m: Add docstring which was missing. Match function variables to docstring. Put input validation first.

author	Rik <rik@octave.org>
date	Wed, 25 Sep 2013 10:46:18 -0700
parents	43e0b711d7e0
children

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 12133 diff changeset	1 ## Copyright (C) 1996-2012 John W. Eaton
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	2 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	3 ## This file is part of Octave.
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	4 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 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: 6788 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: 6788 diff changeset	8 ## your option) any later version.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	9 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	10 ## 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	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	13 ## General Public License for more details.
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 ## 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	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6788 diff changeset	17 ## <http://www.gnu.org/licenses/>.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	18
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman 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} {} meshc (@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} {} meshc (@var{z})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17066 diff changeset	22 ## @deftypefnx {Function File} {} meshc (@dots{}, @var{c})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17066 diff changeset	23 ## @deftypefnx {Function File} {} meshc (@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} {} meshc (@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} =} meshc (@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 underlying contour lines.
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.
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17066 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}.
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 2-element vector with a graphics
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17066 diff changeset	51 ## 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	52 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17066 diff changeset	53 ## @seealso{ezmeshc, mesh, meshz, contour, surfc, surface, meshgrid, hidden, shading, colormap, caxis}
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	54 ## @end deftypefn
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	55
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	56 function h = meshc (varargin)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	57
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 14138 diff changeset	58 if (! all (cellfun ("isreal", varargin)))
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 14138 diff changeset	59 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	60 endif
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 14138 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__ ("meshc", varargin{:});
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	63
17219 87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. Rik <rik@octave.org> parents: 17198 diff changeset	64 oldfig = [];
17309 68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc. Rik <rik@octave.org> parents: 17289 diff changeset	65 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	66 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	67 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	68 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	69 hax = newplot (hax);
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	70
17130 26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions. Rik <rik@octave.org> parents: 17126 diff changeset	71 htmp = surface (varargin{:});
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	72
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16985 diff changeset	73 ## FIXME - gnuplot does not support a filled surface and a
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16985 diff changeset	74 ## non-filled contour. 3D filled patches are also not supported.
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 ## Thus, the facecolor will be transparent for the gnuplot backend.
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, "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	77 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	78 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	79 set (hax, "view", [-37.5, 30],
17175 0a761f218d8d Fix contour plot axis to x-y data range, not axis ("tight"). Rik <rik@octave.org> parents: 17130 diff changeset	80 "xgrid", "on", "ygrid", "on", "zgrid", "on",
0a761f218d8d Fix contour plot axis to x-y data range, not axis ("tight"). Rik <rik@octave.org> parents: 17130 diff changeset	81 "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	82 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	83
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 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	85
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16985 diff changeset	86 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	87 [~, 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	88
328b579e08e9 mesh.m,meshc.m,meshz.m: Overhaul to use newplot and __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16985 diff changeset	89 htmp = [htmp; htmp2];
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	90
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	91 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	92 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	93 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	94 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	95 end_unwind_protect
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	96
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	97 if (nargout > 0)
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 14138 diff changeset	98 h = htmp;
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	99 endif
7119 d22ad51b9cf8 [project @ 2007-11-07 21:06:27 by jwe] jwe parents: 7017 diff changeset	100
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	101 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	102
17198 df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	103
df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	104 %!demo
df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	105 %! clf;
df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	106 %! colormap ('default');
df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	107 %! [X, Y] = meshgrid (linspace (-3, 3, 40));
df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	108 %! Z = sqrt (abs (X .* Y)) ./ (1 + X.^2 + Y.^2);
df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	109 %! meshc (X, Y, Z);
df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	110 %! title ('meshc() combines mesh/contour plots');
df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17175 diff changeset	111

Mercurial > hg > octave-lyh

annotate scripts/plot/meshc.m @ 17496:edd15fceff14