annotate scripts/plot/comet.m @ 17171:4b834dbe4b3e

meshz.m: Add support for color matrix input. * scripts/plot/meshz.m: Add support for color matrix input.
author Rik <rik@octave.org>
date Sat, 03 Aug 2013 10:05:07 -0700
parents 26589abbc78d
children c954b0a396a2
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) 2008-2012 Ben Abbott
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
2 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
4 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
6 ## under the terms of the GNU General Public License as published by
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
8 ## your option) any later version.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
9 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
13 ## General Public License for more details.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
14 ##
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
18
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
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} {} comet (@var{y})
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} comet (@var{x}, @var{y})
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
22 ## @deftypefnx {Function File} {} comet (@var{x}, @var{y}, @var{p})
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
23 ## @deftypefnx {Function File} {} comet (@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}). If @var{x} is not
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
26 ## specified it defaults to the indices of @var{y}.
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
27 ##
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
28 ## The speed of the comet may be controlled by @var{p}, which represents the
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
29 ## time each point is displayed before moving to the next one. The default for
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
30 ## @var{p} is 0.1 seconds.
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
31 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17060
diff changeset
32 ## 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: 17060
diff changeset
33 ## rather than the current axes returned by @code{gca}.
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
34 ## @seealso{comet3}
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
35 ## @end deftypefn
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
36
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
37 ## Author: Ben Abbott bpabbott@mac.com
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
38 ## Created: 2008-09-21
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
39
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
40 function comet (varargin)
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
41
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
42 [hax, varargin, nargin] = __plt_get_axis_arg__ ("comet", varargin{:});
11378
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
43
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
44 if (nargin == 0)
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
45 print_usage ();
11378
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
46 elseif (nargin == 1)
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
47 y = varargin{1};
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14245
diff changeset
48 x = 1:numel (y);
11378
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
49 p = 0.1;
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
50 elseif (nargin == 2)
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
51 x = varargin{1};
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
52 y = varargin{2};
11378
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
53 p = 0.1;
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
54 elseif (nargin == 3)
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
55 x = varargin{1};
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
56 y = varargin{2};
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
57 p = varargin{3};
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
58 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
59
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
60 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure"));
11378
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
61 unwind_protect
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
62 hax = newplot (hax);
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
63 limits = [min(x), max(x), min(y), max(y)];
11378
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
64 num = numel (y);
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
65 dn = round (num/10);
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
66 for n = 1:(num+dn);
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
67 m = n - dn;
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
68 m = max ([m, 1]);
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
69 k = min ([n, num]);
17130
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17126
diff changeset
70 plot (x(1:m), y(1:m), "r", x(m:k), y(m:k), "g", x(k), y(k), "ob");
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17126
diff changeset
71 axis (limits);
11378
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
72 drawnow ();
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
73 pause (p);
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
74 endfor
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
75 unwind_protect_cleanup
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
76 if (! isempty (oldfig))
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
77 set (0, "currentfigure", oldfig);
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
78 endif
11378
a0278a856516 comet: if axes are specified, switch temporarily
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
79 end_unwind_protect
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
80
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
81 endfunction
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
82
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
83
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
84 %!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
85 %! clf;
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
86 %! t = 0:.1:2*pi;
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 %! x = cos (2*t) .* (cos (t).^2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
88 %! y = sin (2*t) .* (sin (t).^2);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
89 %! comet (x, y);
8126
a012580f0d2f comet.m: New File.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
90