Mercurial > octave

annotate scripts/plot/draw/quiver.m @ 20852:516bb87ea72e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
2015 Code Sprint: remove class of function from docstring for all m-files.
author Rik <rik@octave.org>
date Sat, 12 Dec 2015 07:31:00 -0800
parents 777f26aa8e3e
children ecce63c99c3f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
1 ## Copyright (C) 2007-2015 David Bateman
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
2 ##
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
4 ##
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
9 ##
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
14 ##
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
18
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
20 ## @deftypefn {} {} quiver (@var{u}, @var{v})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
21 ## @deftypefnx {} {} quiver (@var{x}, @var{y}, @var{u}, @var{v})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
22 ## @deftypefnx {} {} quiver (@dots{}, @var{s})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
23 ## @deftypefnx {} {} quiver (@dots{}, @var{style})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
24 ## @deftypefnx {} {} quiver (@dots{}, "filled")
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
25 ## @deftypefnx {} {} quiver (@var{hax}, @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
26 ## @deftypefnx {} {@var{h} =} quiver (@dots{})
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
27 ##
20173
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
28 ## Plot a 2-D vector field with arrows.
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
29 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17070
diff changeset
30 ## Plot the (@var{u}, @var{v}) components of a vector field in
20173
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
31 ## an (@var{x}, @var{y}) meshgrid. If the grid is uniform then @var{x} and
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
32 ## @var{y} can be specified as vectors.
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
33 ##
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
34 ## If @var{x} and @var{y} are undefined they are assumed to be
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17070
diff changeset
35 ## @code{(1:@var{m}, 1:@var{n})} where
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17070
diff changeset
36 ## @code{[@var{m}, @var{n}] = size (@var{u})}.
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
37 ##
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
38 ## The variable @var{s} is a scalar defining a scaling factor to use for
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
39 ## the arrows of the field relative to the mesh spacing. A value of 0
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
40 ## disables all scaling. The default value is 0.9.
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
41 ##
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
42 ## The style to use for the plot can be defined with a line style @var{style}
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17070
diff changeset
43 ## of the same format as the @code{plot} command.
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
44 ## If a marker is specified then markers at the grid points of the vectors are
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
45 ## drawn rather than arrows. If the argument @qcode{"filled"} is given then
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
46 ## the markers are filled.
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
47 ##
17161
52931d71400f doc: Document that first argument can be an axes handle for several plot functions.
Rik <rik@octave.org>
parents: 17122
diff changeset
48 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
52931d71400f doc: Document that first argument can be an axes handle for several plot functions.
Rik <rik@octave.org>
parents: 17122
diff changeset
49 ## rather than the current axes returned by @code{gca}.
52931d71400f doc: Document that first argument can be an axes handle for several plot functions.
Rik <rik@octave.org>
parents: 17122
diff changeset
50 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
51 ## The optional return value @var{h} is a graphics handle to a quiver object.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
52 ## A quiver object regroups the components of the quiver plot (body, arrow,
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
53 ## and marker), and allows them to be changed together.
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
54 ##
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
55 ## Example:
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
56 ##
7121
c0d9ac299176 [project @ 2007-11-07 21:32:57 by jwe]
jwe
parents: 7120
diff changeset
57 ## @example
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
58 ## @group
7121
c0d9ac299176 [project @ 2007-11-07 21:32:57 by jwe]
jwe
parents: 7120
diff changeset
59 ## [x, y] = meshgrid (1:2:20);
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7215
diff changeset
60 ## h = quiver (x, y, sin (2*pi*x/10), sin (2*pi*y/10));
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7215
diff changeset
61 ## set (h, "maxheadsize", 0.33);
7121
c0d9ac299176 [project @ 2007-11-07 21:32:57 by jwe]
jwe
parents: 7120
diff changeset
62 ## @end group
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
63 ## @end example
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
64 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17070
diff changeset
65 ## @seealso{quiver3, compass, feather, plot}
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
66 ## @end deftypefn
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
67
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
68 function h = quiver (varargin)
7121
c0d9ac299176 [project @ 2007-11-07 21:32:57 by jwe]
jwe
parents: 7120
diff changeset
69
17070
d465f9970c02 quiver.m, quiver3.m: Upgrade to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16814
diff changeset
70 [hax, varargin, nargin] = __plt_get_axis_arg__ ("quiver", varargin{:});
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
71
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
72 if (nargin < 2)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
73 print_usage ();
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
74 endif
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
75
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17161
diff changeset
76 oldfig = [];
17301
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17281
diff changeset
77 if (! isempty (hax))
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17161
diff changeset
78 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17161
diff changeset
79 endif
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
80 unwind_protect
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
81 hax = newplot (hax);
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
82 htmp = __quiver__ (hax, false, varargin{:});
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
83 unwind_protect_cleanup
17070
d465f9970c02 quiver.m, quiver3.m: Upgrade to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16814
diff changeset
84 if (! isempty (oldfig))
d465f9970c02 quiver.m, quiver3.m: Upgrade to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16814
diff changeset
85 set (0, "currentfigure", oldfig);
d465f9970c02 quiver.m, quiver3.m: Upgrade to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16814
diff changeset
86 endif
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
87 end_unwind_protect
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
88
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
89 if (nargout > 0)
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
90 h = htmp;
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
91 endif
7121
c0d9ac299176 [project @ 2007-11-07 21:32:57 by jwe]
jwe
parents: 7120
diff changeset
92
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
93 endfunction
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
94
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
95
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
96 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
97 %! clf;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
98 %! [x,y] = meshgrid (1:2:20);
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
99 %! h = quiver (x,y, sin (2*pi*x/10), sin (2*pi*y/10));
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
100 %! title ('quiver plot')
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
101
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents:
diff changeset
102 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
103 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
104 %! x = linspace (0, 3, 80);
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
105 %! y = sin (2*pi*x);
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
106 %! theta = 2*pi*x + pi/2;
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
107 %! quiver (x, y, sin (theta)/10, cos (theta)/10, 0.4);
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
108 %! axis equal tight;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
109 %! hold on; plot (x,y,'r'); hold off;
17671
ddfc1600a311 Overhaul quiver/quiver3 functions.
Rik <rik@octave.org>
parents: 17572
diff changeset
110 %! title ('quiver() with scaled arrows');
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
111