Mercurial > hg > octave-nkf

annotate scripts/plot/compass.m @ 19669:c2031ad6dbe7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix octave header includes in audiodevinfo * audiodevinfo.cc: change includes to use local octave headers
author Vytautas Jančauskas <unaudio@gmail.com>
date Wed, 11 Sep 2013 21:32:14 +0300
parents 997b700b6ad4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14092
diff changeset
1 ## Copyright (C) 2007-2012 David Bateman
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
2 ##
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
4 ##
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
9 ##
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
14 ##
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
18
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
20 ## @deftypefn {Function File} {} compass (@var{u}, @var{v})
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {} compass (@var{z})
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} compass (@dots{}, @var{style})
17063
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
23 ## @deftypefnx {Function File} {} compass (@var{hax}, @dots{})
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} compass (@dots{})
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
25 ##
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
26 ## 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: 17063
diff changeset
27 ## from the origin of a polar plot.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17063
diff changeset
28 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17063
diff changeset
29 ## The arrow representing each vector has one end at the origin and the tip at
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17063
diff changeset
30 ## [@var{u}(i), @var{v}(i)]. If a single complex argument @var{z} is given,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17063
diff changeset
31 ## then @code{@var{u} = real (@var{z})} and @code{@var{v} = imag (@var{z})}.
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
32 ##
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
33 ## 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: 17063
diff changeset
34 ## of the same format as the @code{plot} command.
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
35 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17063
diff changeset
36 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17063
diff changeset
37 ## rather than the current axes returned by @code{gca}.
17063
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
38 ##
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 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
40 ## line objects representing the drawn vectors.
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
41 ##
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
42 ## @example
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
43 ## @group
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
44 ## a = toeplitz ([1;randn(9,1)], [1,randn(1,9)]);
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
45 ## compass (eig (a));
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
46 ## @end group
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
47 ## @end example
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
48 ##
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
49 ## @seealso{polar, feather, quiver, rose, plot}
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
50 ## @end deftypefn
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
51
17063
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
52 function h = compass (varargin)
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
53
17063
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
54 [hax, varargin, nargin] = __plt_get_axis_arg__ ("compass", varargin{:});
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
55
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
56 if (nargin == 0 || nargin > 3)
9502
69a57c59868c compass.m, feather.m: simplify argument processing
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
57 print_usage ();
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
58 endif
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
59
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
60 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
61 z = varargin{1}(:).';
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
62 u = real (z);
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
63 v = imag (z);
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
64 have_line_spec = (nargin == 2);
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
65 elseif (nargin >= 2 && isnumeric (varargin{2}))
9502
69a57c59868c compass.m, feather.m: simplify argument processing
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
66 u = varargin{1}(:).';
69a57c59868c compass.m, feather.m: simplify argument processing
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
67 v = varargin{2}(:).';
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
68 have_line_spec = (nargin == 3);
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
69 else
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
70 print_usage ();
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
71 endif
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
72
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
73 arrowsize = 0.20;
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
74 line_spec = "-b";
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
75
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
76 if (have_line_spec)
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
77 arg = varargin{end};
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
78 if (ischar (arg) || iscellstr (arg))
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
79 [~, valid] = __pltopt__ ("compass", arg, false);
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
80 if (valid)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9502
diff changeset
81 line_spec = arg;
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
82 else
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
83 error ("compass: invalid linestyle STYLE");
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
84 endif
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
85 else
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
86 error ("compass: invalid linestyle STYLE");
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
87 endif
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
88 endif
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
89
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
90 ## Matlab draws compass plots with the arrow head as one continous line,
17471
997b700b6ad4 compass.m: Add %!error input validation tests.
Rik <rik@octave.org>
parents: 17445
diff changeset
91 ## and each arrow separately. This is completely different from quiver
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
92 ## and quite ugly.
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
93 n = length (u);
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
94 xend = u;
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
95 xtmp = u .* (1 - arrowsize);
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
96 yend = v;
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
97 ytmp = v .* (1 - arrowsize);
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
98 x = [zeros(1, n); xend; xtmp - v * arrowsize / 3; xend; ...
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
99 xtmp + v * arrowsize / 3];
17445
2fee3022ac2f compass.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
100 y = [zeros(1, n); yend; ytmp + u * arrowsize / 3; yend; ...
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
101 ytmp - u * arrowsize / 3];
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
102 [r, p] = cart2pol (x, y);
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
103
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17126
diff changeset
104 oldfig = [];
17301
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17211
diff changeset
105 if (! isempty (hax))
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17126
diff changeset
106 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17126
diff changeset
107 endif
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
108 unwind_protect
17063
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
109 hax = newplot (hax);
17126
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17122
diff changeset
110 hlist = polar (r, p, line_spec);
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
111 unwind_protect_cleanup
17063
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
112 if (! isempty (oldfig))
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
113 set (0, "currentfigure", oldfig);
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
114 endif
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
115 end_unwind_protect
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
116
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
117 if (nargout > 0)
17063
f17d9a574645 compass.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14335
diff changeset
118 h = hlist;
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
119 endif
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
120
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
121 endfunction
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
122
11363
a0dfd7e8e3e2 Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
123
7322
40a17a87155e [project @ 2007-12-18 21:32:10 by jwe]
jwe
parents:
diff changeset
124 %!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
125 %! clf;
11363
a0dfd7e8e3e2 Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
126 %! randn_9x1_data = [-2.555884; 0.394974; -0.191871; -1.147024; 1.355425; -0.437335; -0.014370; -0.941312; 1.240300];
a0dfd7e8e3e2 Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
127 %! randn_1x9_data = [1.42934, -1.10821, -1.70404, 0.63357, -0.68337, -1.19771, -0.96502, -1.12810, 0.22457];
a0dfd7e8e3e2 Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
128 %! a = toeplitz ([1;randn_9x1_data], [1,randn_1x9_data]);
a0dfd7e8e3e2 Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
129 %! compass (eig (a));
a0dfd7e8e3e2 Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
130
17471
997b700b6ad4 compass.m: Add %!error input validation tests.
Rik <rik@octave.org>
parents: 17445
diff changeset
131 %% Test input validation
997b700b6ad4 compass.m: Add %!error input validation tests.
Rik <rik@octave.org>
parents: 17445
diff changeset
132 %!error compass ()
997b700b6ad4 compass.m: Add %!error input validation tests.
Rik <rik@octave.org>
parents: 17445
diff changeset
133 %!error compass (1,2,3,4)
997b700b6ad4 compass.m: Add %!error input validation tests.
Rik <rik@octave.org>
parents: 17445
diff changeset
134 %!error compass (1, "-r", 2)
997b700b6ad4 compass.m: Add %!error input validation tests.
Rik <rik@octave.org>
parents: 17445
diff changeset
135 %!error <invalid linestyle STYLE> compass (1, "abc")
997b700b6ad4 compass.m: Add %!error input validation tests.
Rik <rik@octave.org>
parents: 17445
diff changeset
136 %!error <invalid linestyle STYLE> compass (1, {1})
997b700b6ad4 compass.m: Add %!error input validation tests.
Rik <rik@octave.org>
parents: 17445
diff changeset
137