octave_packages/m/plot/ezsurf.m

   1 ## Copyright (C) 2007-2012 David Bateman
   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 -*-
  20 ## @deftypefn  {Function File} {} ezsurf (@var{f})
  21 ## @deftypefnx {Function File} {} ezsurf (@var{fx}, @var{fy}, @var{fz})
  22 ## @deftypefnx {Function File} {} ezsurf (@dots{}, @var{dom})
  23 ## @deftypefnx {Function File} {} ezsurf (@dots{}, @var{n})
  24 ## @deftypefnx {Function File} {} ezsurf (@dots{}, 'circ')
  25 ## @deftypefnx {Function File} {} ezsurf (@var{h}, @dots{})
  26 ## @deftypefnx {Function File} {@var{h} =} ezsurf (@dots{})
  27 ##
  28 ## Plot the surface defined by a function.  @var{f} is a string, inline
  29 ## function or function handle with two arguments defining the function.  By
  30 ## default the plot is over the domain @code{-2*pi < @var{x} < 2*pi} and
  31 ## @code{-2*pi < @var{y} < 2*pi} with 60 points in each dimension.
  32 ##
  33 ## If @var{dom} is a two element vector, it represents the minimum and maximum
  34 ## value of both @var{x} and @var{y}.  If @var{dom} is a four element vector,
  35 ## then the minimum and maximum value of @var{x} and @var{y} are specify
  36 ## separately.
  37 ##
  38 ## @var{n} is a scalar defining the number of points to use in each dimension.
  39 ##
  40 ## If three functions are passed, then plot the parametrically defined
  41 ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}),
  42 ## @var{fz} (@var{s}, @var{t})]}.
  43 ##
  44 ## If the argument 'circ' is given, then the function is plotted over a disk
  45 ## centered on the middle of the domain @var{dom}.
  46 ##
  47 ## The optional return value @var{h} is a graphics handle to the created
  48 ## surface object.
  49 ##
  50 ## @example
  51 ## @group
  52 ## f = @@(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2);
  53 ## ezsurf (f, [-3, 3]);
  54 ## @end group
  55 ## @end example
  56 ##
  57 ## An example of a parametrically defined function is
  58 ##
  59 ## @example
  60 ## @group
  61 ## fx = @@(s,t) cos (s) .* cos (t);
  62 ## fy = @@(s,t) sin (s) .* cos (t);
  63 ## fz = @@(s,t) sin (t);
  64 ## ezsurf (fx, fy, fz, [-pi, pi, -pi/2, pi/2], 20);
  65 ## @end group
  66 ## @end example
  67 ##
  68 ## @seealso{ezplot, ezmesh, ezsurfc, ezmeshc}
  69 ## @end deftypefn
  70
  71 function retval = ezsurf (varargin)
  72
  73   [h, needusage] = __ezplot__ ("surf", varargin{:});
  74
  75   if (needusage)
  76     print_usage ();
  77   endif
  78
  79   if (nargout > 0)
  80     retval = h;
  81   endif
  82 endfunction
  83
  84
  85 %!demo
  86 %! clf
  87 %! f = @(x,y) sqrt(abs(x .* y)) ./ (1 + x.^2 + y.^2);
  88 %! ezsurf (f, [-3, 3]);
  89
  90 %!demo
  91 %! clf
  92 %! fx = @(s,t) cos (s) .* cos(t);
  93 %! fy = @(s,t) sin (s) .* cos(t);
  94 %! fz = @(s,t) sin (t);
  95 %! ezsurf (fx, fy, fz, [-pi,pi,-pi/2,pi/2], 20);
  96