Mercurial > hg > octave-nkf

comparison scripts/plot/quiver.m @ 9042:97aa01a85ea4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge documentation cleanup changes to main branch.
author Rik <rdrider0-list@yahoo.com>
date Wed, 25 Mar 2009 18:13:08 -0700
parents dbd0c77e575e
children 16f53d29049f
comparison
equal deleted inserted replaced
9019:12ca81f1fa99 9042:97aa01a85ea4
24 ## @deftypefnx {Function File} {} quiver (@dots{}, 'filled') 24 ## @deftypefnx {Function File} {} quiver (@dots{}, 'filled')
25 ## @deftypefnx {Function File} {} quiver (@var{h}, @dots{}) 25 ## @deftypefnx {Function File} {} quiver (@var{h}, @dots{})
26 ## @deftypefnx {Function File} {@var{h} =} quiver (@dots{}) 26 ## @deftypefnx {Function File} {@var{h} =} quiver (@dots{})
27 ## 27 ##
28 ## Plot the @code{(@var{u}, @var{v})} components of a vector field in 28 ## Plot the @code{(@var{u}, @var{v})} components of a vector field in
29 ## an @code{(@var{x}, @var{y})} meshgrid. If the grid is uniform, you can 29 ## an @code{(@var{x}, @var{y})} meshgrid. If the grid is uniform, you can
30 ## specify @var{x} and @var{y} as vectors. 30 ## specify @var{x} and @var{y} as vectors.
31 ## 31 ##
32 ## If @var{x} and @var{y} are undefined they are assumed to be 32 ## If @var{x} and @var{y} are undefined they are assumed to be
33 ## @code{(1:@var{m}, 1:@var{n})} where @code{[@var{m}, @var{n}] = 33 ## @code{(1:@var{m}, 1:@var{n})} where @code{[@var{m}, @var{n}] =
34 ## size(@var{u})}. 34 ## size(@var{u})}.
35 ## 35 ##
36 ## The variable @var{s} is a scalar defining a scaling factor to use for 36 ## The variable @var{s} is a scalar defining a scaling factor to use for
37 ## the arrows of the field relative to the mesh spacing. A value of 0 37 ## the arrows of the field relative to the mesh spacing. A value of 0
38 ## disables all scaling. The default value is 1. 38 ## disables all scaling. The default value is 1.
39 ## 39 ##
40 ## The style to use for the plot can be defined with a line style @var{style} 40 ## The style to use for the plot can be defined with a line style @var{style}
41 ## in a similar manner to the line styles used with the @code{plot} command. 41 ## in a similar manner to the line styles used with the @code{plot} command.
42 ## If a marker is specified then markers at the grid points of the vectors are 42 ## If a marker is specified then markers at the grid points of the vectors are
43 ## printed rather than arrows. If the argument 'filled' is given then the 43 ## printed rather than arrows. If the argument 'filled' is given then the
44 ## markers as filled. 44 ## markers as filled.
45 ## 45 ##
46 ## The optional return value @var{h} provides a quiver group that 46 ## The optional return value @var{h} provides a quiver group that
47 ## regroups the components of the quiver plot (body, arrow and marker), 47 ## regroups the components of the quiver plot (body, arrow and marker),
48 ## and allows them to be changed together 48 ## and allows them to be changed together