Home > freetb4matlab > plot > contourf.m

contourf

PURPOSE ^

% Compute and plot filled contours of the matrix @var{z}.

SYNOPSIS ^

function [c, h] = contourf (varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z}, @var{lvl})
% @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z}, @var{n})
% @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z})
% @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{z}, @var{n})
% @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{z}, @var{lvl})
% @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{z})
% @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{ax}, @dots{})
% @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@dots{}, @var{'property'}, @var{val})
% Compute and plot filled contours of the matrix @var{z}.
% Parameters @var{x}, @var{y} and @var{n} or @var{lvl} are optional.
%
% The return value @var{c} is a 2xn matrix containing the contour lines
% as described in the help to the contourc function.
%
% The return value @var{h} is handle-vector to the patch objects creating
% the filled contours.
%
% If @var{x} and @var{y} are omitted they are taken as the row/column
% index of @var{z}.  @var{n} is a scalar denoting the number of lines
% to compute.  Alternatively @var{lvl} is a vector containing the
% contour levels.  If only one value (e.g., lvl0) is wanted, set
% @var{lvl} to [lvl0, lvl0].  If both @var{n} or @var{lvl} are omitted
% a default value of 10 contour level is assumed.
%
% If provided, the filled contours are added to the axes object
% @var{ax} instead of the current axis.
%
% The following example plots filled contours of the @code{peaks}
% function.
% @example
% @group
% [x, y, z] = peaks (50);
% contourf (x, y, z, -7:9)
% @end group
% @end example
% @seealso{contour, contourc, patch}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Fri 22-May-2009 15:13:00 by m2html © 2003