Home > freetb4matlab > plot > quiver.m

quiver

PURPOSE ^

%

SYNOPSIS ^

function retval = quiver (varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {} quiver (@var{u}, @var{v})
% @deftypefnx {Function File} {} quiver (@var{x}, @var{y}, @var{u}, @var{v})
% @deftypefnx {Function File} {} quiver (@dots{}, @var{s})
% @deftypefnx {Function File} {} quiver (@dots{}, @var{style})
% @deftypefnx {Function File} {} quiver (@dots{}, 'filled')
% @deftypefnx {Function File} {} quiver (@var{h}, @dots{})
% @deftypefnx {Function File} {@var{h} =} quiver (@dots{})
%
% Plot the @code{(@var{u}, @var{v})} components of a vector field in 
% an @code{(@var{x}, @var{y})} meshgrid.  If the grid is uniform, you can 
% specify @var{x} and @var{y} as vectors.
%
% If @var{x} and @var{y} are undefined they are assumed to be
% @code{(1:@var{m}, 1:@var{n})} where @code{[@var{m}, @var{n}] = 
% size(@var{u})}.
%
% The variable @var{s} is a scalar defining a scaling factor to use for
%  the arrows of the field relative to the mesh spacing.  A value of 0 
% disables all scaling.  The default value is 1.
%
% The style to use for the plot can be defined with a line style @var{style}
% in a similar manner to the line styles used with the @code{plot} command.
% If a marker is specified then markers at the grid points of the vectors are
% printed rather than arrows.  If the argument 'filled' is given then the
% markers as filled.
%
% The optional return value @var{h} provides a quiver group that
% regroups the components of the quiver plot (body, arrow and marker),
% and allows them to be changed together
%
% @example
% @group
% [x, y] = meshgrid (1:2:20);
% h = quiver (x, y, sin (2*pi*x/10), sin (2*pi*y/10));
% set (h, 'maxheadsize', 0.33);
% @end group
% @end example
%
% @seealso{plot}
% @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