view scripts/plot/ezcontour.m @ 16993:78f57b14535c

Overhaul ez* family of plot functions. * scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezpolar.m, scripts/plot/ezsurfc.m: Redo docstring. Match function output names to docstring. * scripts/plot/ezplot.m: Add %!demo block with sinc function. Redo docstring. Match function output names to docstring. scripts/plot/ezplot3.m: Add %!demo block showing 'animate' option. Redo docstring. Match function output names to docstring. * scripts/plot/ezsurf.m: Add %!demo block showing 'circ' argument. Redo docstring. Match function output names to docstring. * scripts/plot/private/__ezplot__.m: Implement 'circ' option for ezsurf, ezmesh. Implement 'animate' option for ezplot3. Implement new algorithm for finding valid axis setting for mesh, surf, contour plots based on function gradient. Eliminate complex Z values along with singularities because these are not plottable by mesh, surf. Implement Matlab-compatible 2-pass approach to finding valid domain for plot. Use 500 points for point-style plot functions ezplot, ezplot3, ezpolar rather than previous 60 for a smoother plot. Use better regexprep() calls to format "pretty print" title string. Relax input checking and allow 3rd parametric function to be a function of 1 variable only. Clean up code and use Octave coding conventions.
author Rik <rik@octave.org>
date Wed, 17 Jul 2013 10:09:44 -0700
parents ce2b59a6d0e5
children eaab03308c0b
line wrap: on
line source

## Copyright (C) 2007-2012 David Bateman
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn  {Function File} {} ezcontour (@var{f})
## @deftypefnx {Function File} {} ezcontour (@dots{}, @var{dom})
## @deftypefnx {Function File} {} ezcontour (@dots{}, @var{n})
## @deftypefnx {Function File} {} ezcontour (@var{hax}, @dots{})
## @deftypefnx {Function File} {@var{h} =} ezcontour (@dots{})
##
## Plot the contour lines of a function.
## 
## @var{f} is a string, inline function, or function handle with two arguments
## defining the function.  By default the plot is over the meshed domain
## @code{-2*pi <= @var{x} | @var{y} <= 2*pi} with 60 points in each dimension.
##
## If @var{dom} is a two element vector, it represents the minimum and maximum
## values of both @var{x} and @var{y}.  If @var{dom} is a four element vector,
## then the minimum and maximum values are @code{[xmin xmax ymin ymax]}.
##
## @var{n} is a scalar defining the number of points to use in each dimension.
##
## If the first argument is an axis handle, @var{hax}, then plot into this
## axis rather than the current axis handle returned by @code{gca}.
##
## The optional return value @var{h} is a graphics handle to the created plot.
##
## Example:
##
## @example
## @group
## f = @@(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2);
## ezcontour (f, [-3, 3]);
## @end group
## @end example
##
## @seealso{contour, ezcontourf, ezplot, ezmeshc, ezsurfc}
## @end deftypefn

function h = ezcontour (varargin)

  [htmp, needusage] = __ezplot__ ("contour", varargin{:});

  if (needusage)
    print_usage ();
  endif

  if (nargout > 0)
    h = htmp;
  endif

endfunction


%!demo
%! clf;
%! colormap ('default');
%! f = @(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2);
%! ezcontour (f, [-3, 3]);