gui-release/scripts/plot/draw/ezsurf.m

@(
)
@(
)
@(
)
@(
)
@(
)
author	John W. Eaton <jwe@octave.org>
date	Fri, 30 Jan 2015 17:41:50 -0500
parents	d63878346099
children	4197fc428c7d
rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 17572 diff changeset	1 ## Copyright (C) 2007-2013 David Bateman
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	2 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	4 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	8 ## your option) any later version.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	9 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	14 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	18
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	20 ## @deftypefn {Function File} {} ezsurf (@var{f})
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	21 ## @deftypefnx {Function File} {} ezsurf (@var{fx}, @var{fy}, @var{fz})
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	22 ## @deftypefnx {Function File} {} ezsurf (@dots{}, @var{dom})
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	23 ## @deftypefnx {Function File} {} ezsurf (@dots{}, @var{n})
14359 7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/ Rik <octave@nomad.inbox5.com> parents: 14335 diff changeset	24 ## @deftypefnx {Function File} {} ezsurf (@dots{}, "circ")
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	25 ## @deftypefnx {Function File} {} ezsurf (@var{hax}, @dots{})
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	26 ## @deftypefnx {Function File} {@var{h} =} ezsurf (@dots{})
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	27 ##
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	28 ## Plot the surface defined by a function.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	29 ##
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	30 ## @var{f} is a string, inline function, or function handle with two arguments
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	31 ## defining the function. By default the plot is over the meshed domain
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	32 ## @code{-2pi <= @var{x} \| @var{y} <= 2pi} with 60 points in each dimension.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	33 ##
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	34 ## If three functions are passed, then plot the parametrically defined
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	35 ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}),
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	36 ## @var{fz} (@var{s}, @var{t})]}.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	37 ##
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	38 ## If @var{dom} is a two element vector, it represents the minimum and maximum
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	39 ## values of both @var{x} and @var{y}. If @var{dom} is a four element vector,
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	40 ## then the minimum and maximum values are @code{[xmin xmax ymin ymax]}.
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	41 ##
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	42 ## @var{n} is a scalar defining the number of points to use in each dimension.
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	43 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17122 diff changeset	44 ## If the argument @qcode{"circ"} is given, then the function is plotted over
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17122 diff changeset	45 ## a disk centered on the middle of the domain @var{dom}.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	46 ##
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16993 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: 16993 diff changeset	48 ## rather than the current axes returned by @code{gca}.
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	49 ##
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	50 ## The optional return value @var{h} is a graphics handle to the created
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	51 ## surface object.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	52 ##
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	53 ## Example 1: 2-argument function
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	54 ##
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	55 ## @example
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	56 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	57 ## f = @@(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2);
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	58 ## ezsurf (f, [-3, 3]);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	59 ## @end group
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	60 ## @end example
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	61 ##
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	62 ## Example 2: parametrically defined function
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	63 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	64 ## @example
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	65 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	66 ## fx = @@(s,t) cos (s) .* cos (t);
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	67 ## fy = @@(s,t) sin (s) .* cos (t);
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	68 ## fz = @@(s,t) sin (t);
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	69 ## ezsurf (fx, fy, fz, [-pi, pi, -pi/2, pi/2], 20);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	70 ## @end group
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	71 ## @end example
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	72 ##
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	73 ## @seealso{surf, ezsurfc, ezplot, ezmesh, ezmeshc, shading}
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	74 ## @end deftypefn
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	75
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	76 function h = ezsurf (varargin)
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	77
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	78 [htmp, needusage] = __ezplot__ ("surf", varargin{:});
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	79
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	80 if (needusage)
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	81 print_usage ();
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	82 endif
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	83
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	84 if (nargout > 0)
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	85 h = htmp;
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	86 endif
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	87
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	88 endfunction
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	89
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	90
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	91 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	92 %! clf;
14247 c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	93 %! colormap ('default');
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	94 %! f = @(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2);
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	95 %! ezsurf (f, [-3, 3]);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	96
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	97 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	98 %! clf;
14247 c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	99 %! colormap ('default');
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	100 %! fx = @(s,t) cos (s) .* cos (t);
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	101 %! fy = @(s,t) sin (s) .* cos (t);
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	102 %! fz = @(s,t) sin (t);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	103 %! ezsurf (fx, fy, fz, [-pi,pi,-pi/2,pi/2], 20);
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	104 %! axis equal;
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	105
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	106 %!demo
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	107 %! clf;
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	108 %! colormap ('default');
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	109 %! f = @(x,y) x.^2 + y.^2;
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	110 %! subplot (1,2,1);
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	111 %! ezsurf (f, [-2,2]);
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	112 %! title ({'x^2 + y^2'; 'plotted over rectangular grid (default)'});
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	113 %! subplot (1,2,2);
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	114 %! ezsurf (f, [-2,2], 'circ');
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	115 %! title ({'x^2 + y^2'; 'plotted over circular disk with "circ"'});
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14868 diff changeset	116