Mercurial > hg > octave-lyh

annotate scripts/plot/comet3.m @ 17085:d3ebc3f9bdbf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc update for grid and subplot
author Michael Godfrey <michaeldgodfrey@gmail.com>
date Thu, 25 Jul 2013 18:18:32 -0400
parents 2d17dbdf6b7d
children eaab03308c0b
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: 11587
diff changeset
1 ## Copyright (C) 2010-2012 Ben Abbott and John W. Eaton
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
2 ##
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20 ## @deftypefn {Function File} {} comet3 (@var{z})
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
21 ## @deftypefnx {Function File} {} comet3 (@var{x}, @var{y}, @var{z})
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22 ## @deftypefnx {Function File} {} comet3 (@var{x}, @var{y}, @var{z}, @var{p})
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
23 ## @deftypefnx {Function File} {} comet3 (@var{hax}, @dots{})
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
24 ## Produce a simple comet style animation along the trajectory provided by
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
25 ## the input coordinate vectors (@var{x}, @var{y}, @var{z}). If only @var{z}
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
26 ## is specified then @var{x}, @var{y} default to the indices of @var{z}.
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 ##
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 ## The speed of the comet may be controlled by @var{p}, which represents the
16826
a4969508008e doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents: 16814
diff changeset
29 ## time each point is displayed before moving to the next one. The default for
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
30 ## @var{p} is 0.1 seconds.
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 ##
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
32 ## If @var{hax} is specified the animation is produced in that axis rather than
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
33 ## the current axis.
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
34 ## @seealso{comet}
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 ## @end deftypefn
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 ## Author: jwe
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38 ## Created: 2010-12-17
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 function comet3 (varargin)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
42 [hax, varargin, nargin] = __plt_get_axis_arg__ ("comet3", varargin{:});
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 if (nargin == 0 || nargin == 2 || nargin > 4)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 print_usage ();
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 elseif (nargin == 1)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 z = varargin{1};
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
48 x = y = 1:numel (z);
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 p = 0.1;
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 elseif (nargin == 3)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 x = varargin{1};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 y = varargin{2};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 z = varargin{3};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 p = 0.1;
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 elseif (nargin == 4)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 x = varargin{1};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 y = varargin{2};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 z = varargin{3};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 p = varargin{4};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
61
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
62 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure"));
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 unwind_protect
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
64 hax = newplot (hax);
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
65 limits = [min(x), max(x), min(y), max(y), min(z), max(z)];
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 num = numel (y);
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 dn = round (num/10);
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 for n = 1:(num+dn);
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69 m = n - dn;
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70 m = max ([m, 1]);
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71 k = min ([n, num]);
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
72 htmp = plot3 (hax, x(1:m), y(1:m), z(1:m), "r",
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
73 x(m:k), y(m:k), z(m:k), "g",
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
74 x(k), y(k), z(k), "ob");
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
75 axis (limits);
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76 drawnow ();
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77 pause (p);
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 endfor
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79 unwind_protect_cleanup
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
80 if (! isempty (oldfig))
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
81 set (0, "currentfigure", oldfig);
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
82 endif
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
83 end_unwind_protect
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
84
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
85 endfunction
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
86
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
87
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
88 %!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
89 %! clf;
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
90 %! t = 0:pi/20:5*pi;
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
91 %! comet3 (cos (t), sin (t), t, 0.01);
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
92