|
7189
|
1 ## Copyright (C) 2007 David Bateman |
|
|
2 ## |
|
|
3 ## This file is part of Octave. |
|
|
4 ## |
|
|
5 ## Octave is free software; you can redistribute it and/or modify it |
|
|
6 ## under the terms of the GNU General Public License as published by |
|
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
|
|
8 ## your option) any later version. |
|
|
9 ## |
|
|
10 ## Octave is distributed in the hope that it will be useful, but |
|
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
|
13 ## General Public License for more details. |
|
|
14 ## |
|
|
15 ## You should have received a copy of the GNU General Public License |
|
|
16 ## along with Octave; see the file COPYING. If not, see |
|
|
17 ## <http://www.gnu.org/licenses/>. |
|
|
18 |
|
|
19 ## -*- texinfo -*- |
|
|
20 ## @deftypefn {Function File} {} quiver3 (@var{u}, @var{v}, @var{w}) |
|
|
21 ## @deftypefnx {Function File} {} quiver3 (@var{x}, @var{y}, @var{z}, @var{u}, @var{v}, @var{w}) |
|
|
22 ## @deftypefnx {Function File} {} quiver3 (@dots{}, @var{s}) |
|
|
23 ## @deftypefnx {Function File} {} quiver3 (@dots{}, @var{style}) |
|
|
24 ## @deftypefnx {Function File} {} quiver3 (@dots{}, 'filled') |
|
|
25 ## @deftypefnx {Function File} {} quiver3 (@var{h}, @dots{}) |
|
|
26 ## @deftypefnx {Function File} {@var{h} =} quiver3 (@dots{}) |
|
|
27 ## |
|
|
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 |
|
|
30 ## can specify @var{x}, @var{y} @var{z} as vectors. |
|
|
31 ## |
|
|
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}] = |
|
|
34 ## size(@var{u})} and @code{@var{p} = max (size (@var{w}))}. |
|
|
35 ## |
|
|
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 |
|
|
38 ## disables all scaling. The default value is 1. |
|
|
39 ## |
|
|
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. |
|
|
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 |
|
|
44 ## markers as filled. |
|
|
45 ## |
|
|
46 ## The optional return value @var{h} provides a list of handles to the |
|
|
47 ## the parts of the vector field (body, arrow and marker). |
|
|
48 ## |
|
|
49 ## @example |
|
|
50 ## @group |
|
|
51 ## [x, y, z] = peaks (25); |
|
|
52 ## surf (x, y, z); |
|
|
53 ## hold on; |
|
|
54 ## [u, v, w] = surfnorm (x, y, z / 10); |
|
|
55 ## quiver3 (x, y, z, u, v, w); |
|
|
56 ## @end group |
|
|
57 ## @end example |
|
|
58 ## |
|
|
59 ## @seealso{plot} |
|
|
60 ## @end deftypefn |
|
|
61 |
|
|
62 function retval = quiver3 (varargin) |
|
|
63 |
|
|
64 if (nargin < 2) |
|
|
65 print_usage (); |
|
|
66 elseif (isscalar (varargin{1}) && ishandle (varargin{1})) |
|
7208
|
67 h = varargin{1}; |
|
7189
|
68 if (! strcmp (get (h, "type"), "axes")) |
|
|
69 error ("quiver: expecting first argument to be an axes object"); |
|
|
70 endif |
|
|
71 oldh = gca (); |
|
|
72 unwind_protect |
|
|
73 axes (h); |
|
|
74 newplot (); |
|
|
75 tmp = __quiver__ (h, 1, varargin{2:end}); |
|
|
76 unwind_protect_cleanup |
|
|
77 axes (oldh); |
|
|
78 end_unwind_protect |
|
|
79 else |
|
|
80 newplot (); |
|
|
81 tmp = __quiver__ (gca (), 1, varargin{:}); |
|
|
82 endif |
|
|
83 |
|
|
84 if (nargout > 0) |
|
|
85 retval = tmp; |
|
|
86 endif |
|
|
87 |
|
|
88 endfunction |
|
|
89 |
|
|
90 %!demo |
|
|
91 %! [x,y]=meshgrid (-1:0.1:1); |
|
|
92 %! z=sin(2*pi*sqrt(x.^2+y.^2)); |
|
|
93 %! theta=2*pi*sqrt(x.^2+y.^2)+pi/2; |
|
|
94 %! quiver3(x,y,z,sin(theta),cos(theta),ones(size(z))); |
|
|
95 %! hold on; |
|
|
96 %! mesh(x,y,z); |
|
|
97 %! hold off; |
