Mercurial > hg > octave-lyh

comparison scripts/plot/quiver3.m @ 9040:dbd0c77e575e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Cleanup documentation file plot.texi Spellcheck Stylecheck (Mostly double spaces after periods)
author Rik <rdrider0-list@yahoo.com>
date Sun, 22 Mar 2009 14:40:24 -0700
parents eb63fbe60fab
children be55736a0783
comparison
equal deleted inserted replaced
9039:51dc9691f23f 9040:dbd0c77e575e
24 ## @deftypefnx {Function File} {} quiver3 (@dots{}, 'filled') 24 ## @deftypefnx {Function File} {} quiver3 (@dots{}, 'filled')
25 ## @deftypefnx {Function File} {} quiver3 (@var{h}, @dots{}) 25 ## @deftypefnx {Function File} {} quiver3 (@var{h}, @dots{})
26 ## @deftypefnx {Function File} {@var{h} =} quiver3 (@dots{}) 26 ## @deftypefnx {Function File} {@var{h} =} quiver3 (@dots{})
27 ## 27 ##
28 ## Plot the @code{(@var{u}, @var{v}, @var{w})} components of a vector field in 28 ## Plot the @code{(@var{u}, @var{v}, @var{w})} components of a vector field in
29 ## an @code{(@var{x}, @var{y}), @var{z}} meshgrid. If the grid is uniform, you 29 ## an @code{(@var{x}, @var{y}), @var{z}} meshgrid. If the grid is uniform, you
30 ## can specify @var{x}, @var{y} @var{z} as vectors. 30 ## can specify @var{x}, @var{y} @var{z} as vectors.
31 ## 31 ##
32 ## If @var{x}, @var{y} and @var{z} are undefined they are assumed to be 32 ## If @var{x}, @var{y} and @var{z} are undefined they are assumed to be
33 ## @code{(1:@var{m}, 1:@var{n}, 1:@var{p})} where @code{[@var{m}, @var{n}] = 33 ## @code{(1:@var{m}, 1:@var{n}, 1:@var{p})} where @code{[@var{m}, @var{n}] =
34 ## size(@var{u})} and @code{@var{p} = max (size (@var{w}))}. 34 ## size(@var{u})} and @code{@var{p} = max (size (@var{w}))}.
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