Mercurial > octave
annotate scripts/plot/draw/feather.m @ 33669:96f077c60226 default tip @
maint: Merge stable to default.
author | Markus Mützel <markus.muetzel@gmx.de> |
---|---|
date | Wed, 19 Jun 2024 16:41:55 +0200 |
parents | 2e484f9f1f18 |
children |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 ######################################################################## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 ## |
32632
2e484f9f1f18
maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
31706
diff
changeset
|
3 ## Copyright (C) 2007-2024 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
4 ## |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 ## See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 ## distribution or <https://octave.org/copyright/>. |
7322 | 7 ## |
8 ## This file is part of Octave. | |
9 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24432
diff
changeset
|
10 ## Octave is free software: you can redistribute it and/or modify it |
7322 | 11 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24432
diff
changeset
|
12 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## (at your option) any later version. |
7322 | 14 ## |
15 ## Octave is distributed in the hope that it will be useful, but | |
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
18 ## GNU General Public License for more details. |
7322 | 19 ## |
20 ## You should have received a copy of the GNU General Public License | |
21 ## along with Octave; see the file COPYING. If not, see | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24432
diff
changeset
|
22 ## <https://www.gnu.org/licenses/>. |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 ## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 ######################################################################## |
7322 | 25 |
26 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
27 ## @deftypefn {} {} feather (@var{u}, @var{v}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
28 ## @deftypefnx {} {} feather (@var{z}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
29 ## @deftypefnx {} {} feather (@dots{}, @var{style}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
30 ## @deftypefnx {} {} feather (@var{hax}, @dots{}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
31 ## @deftypefnx {} {@var{h} =} feather (@dots{}) |
7322 | 32 ## |
33 ## Plot the @code{(@var{u}, @var{v})} components of a vector field emanating | |
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17071
diff
changeset
|
34 ## from equidistant points on the x-axis. |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17071
diff
changeset
|
35 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17071
diff
changeset
|
36 ## If a single complex argument @var{z} is given, then |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17071
diff
changeset
|
37 ## @code{@var{u} = real (@var{z})} and @code{@var{v} = imag (@var{z})}. |
7322 | 38 ## |
39 ## 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:
17071
diff
changeset
|
40 ## of the same format as the @code{plot} command. |
7322 | 41 ## |
24431
0c6cedafc71e
doc: Use 'axes' rather than 'axis' appropriately in docstrings.
Rik <rik@octave.org>
parents:
23219
diff
changeset
|
42 ## If the first argument @var{hax} is an axes handle, then plot into this axes, |
17161
52931d71400f
doc: Document that first argument can be an axes handle for several plot functions.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
43 ## 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:
17126
diff
changeset
|
44 ## |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
45 ## The optional return value @var{h} is a vector of graphics handles to the |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
46 ## line objects representing the drawn vectors. |
7322 | 47 ## |
48 ## @example | |
49 ## @group | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
50 ## phi = [0 : 15 : 360] * pi/180; |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
51 ## feather (sin (phi), cos (phi)); |
7322 | 52 ## @end group |
53 ## @end example | |
54 ## | |
55 ## @seealso{plot, quiver, compass} | |
56 ## @end deftypefn | |
57 | |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
58 function h = feather (varargin) |
7322 | 59 |
17071
e89fd58a6e84
feather.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14335
diff
changeset
|
60 [hax, varargin, nargin] = __plt_get_axis_arg__ ("feather", varargin{:}); |
7322 | 61 |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
62 if (nargin == 0 || nargin > 3) |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
63 print_usage (); |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
64 endif |
7322 | 65 |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
66 if (nargin == 1 || (nargin == 2 && ! isnumeric (varargin{2}))) |
9502
69a57c59868c
compass.m, feather.m: simplify argument processing
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
67 z = varargin{1}(:).'; |
7322 | 68 u = real (z); |
69 v = imag (z); | |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
70 have_line_spec = (nargin == 2); |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
71 elseif (nargin >= 2 && isnumeric (varargin{2})) |
7322 | 72 ioff = 3; |
9502
69a57c59868c
compass.m, feather.m: simplify argument processing
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
73 u = varargin{1}(:).'; |
69a57c59868c
compass.m, feather.m: simplify argument processing
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
74 v = varargin{2}(:).'; |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
75 have_line_spec = (nargin == 3); |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
76 else |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
77 print_usage (); |
7322 | 78 endif |
79 | |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
80 arrowsize = 0.20; |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
81 line_spec = "-b"; |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
82 |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
83 if (have_line_spec) |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
84 arg = varargin{end}; |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
85 if (ischar (arg) || iscellstr (arg)) |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
86 [~, valid] = __pltopt__ ("feather", arg, false); |
7322 | 87 if (valid) |
10549 | 88 line_spec = arg; |
7322 | 89 else |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
90 error ("feather: invalid linestyle STYLE"); |
7322 | 91 endif |
92 else | |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
93 error ("feather: invalid linestyle STYLE"); |
7322 | 94 endif |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
95 endif |
7322 | 96 |
21751
b571fc85953f
maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
97 ## Matlab draws feather plots, with the arrow head as one continuous line, |
b571fc85953f
maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
98 ## and each arrow separately. This is completely different from quiver and |
b571fc85953f
maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
99 ## quite ugly. |
7322 | 100 n = length (u); |
101 xend = [1 : n] + u; | |
102 xtmp = [1 : n] + u .* (1 - arrowsize); | |
103 yend = v; | |
104 ytmp = v .* (1 - arrowsize); | |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
105 x = [[1 : n]; xend; xtmp - v * arrowsize / 3; xend; ... |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
106 xtmp + v * arrowsize / 3]; |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
107 y = [zeros(1, n); yend; ytmp + u * arrowsize / 3; yend; ... |
7322 | 108 ytmp - u * arrowsize / 3]; |
109 | |
17211
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17190
diff
changeset
|
110 oldfig = []; |
17301
68bcac3c043a
Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents:
17211
diff
changeset
|
111 if (! isempty (hax)) |
17211
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17190
diff
changeset
|
112 oldfig = get (0, "currentfigure"); |
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17190
diff
changeset
|
113 endif |
7322 | 114 unwind_protect |
17071
e89fd58a6e84
feather.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14335
diff
changeset
|
115 hax = newplot (hax); |
24316
01fc0e70d4c1
Use common coding style of 'htmp' passed to output 'h' for plot m-files.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
116 htmp = plot (x, y, line_spec, [1, n], [0, 0], line_spec); |
7322 | 117 unwind_protect_cleanup |
17071
e89fd58a6e84
feather.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14335
diff
changeset
|
118 if (! isempty (oldfig)) |
e89fd58a6e84
feather.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14335
diff
changeset
|
119 set (0, "currentfigure", oldfig); |
e89fd58a6e84
feather.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14335
diff
changeset
|
120 endif |
7322 | 121 end_unwind_protect |
122 | |
123 if (nargout > 0) | |
24316
01fc0e70d4c1
Use common coding style of 'htmp' passed to output 'h' for plot m-files.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
124 h = htmp; |
7322 | 125 endif |
126 | |
127 endfunction | |
128 | |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
129 |
7322 | 130 %!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
|
131 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
132 %! phi = [0 : 15 : 360] * pi/180; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
133 %! feather (sin (phi), cos (phi)); |
17190
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17161
diff
changeset
|
134 %! axis tight; |
22302
1c4cd12987f5
Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents:
21751
diff
changeset
|
135 %! title ("feather plot"); |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
136 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
137 ## Test input validation |
28896
90fea9cc9caa
test: Add expected error message <Invalid call> to BIST tests for nargin.
Rik <rik@octave.org>
parents:
27923
diff
changeset
|
138 %!error <Invalid call> feather () |
90fea9cc9caa
test: Add expected error message <Invalid call> to BIST tests for nargin.
Rik <rik@octave.org>
parents:
27923
diff
changeset
|
139 %!error <Invalid call> feather (1,2,3,4) |
17472
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
140 %!error feather (1, "-r", 2) |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
141 %!error <invalid linestyle STYLE> feather (1, "abc") |
bddb9688e41c
feather.m: Overhaul function for Matlab visual compatibility.
Rik <rik@octave.org>
parents:
17462
diff
changeset
|
142 %!error <invalid linestyle STYLE> feather (1, {1}) |