octave: scripts/plot/draw/comet.m annotate

annotate scripts/plot/draw/comet.m @ 25054:6652d3823428 stable

maint: Update copyright dates in all source files.

author	John W. Eaton <jwe@octave.org>
date	Fri, 30 Mar 2018 09:19:05 -0400
parents	194eb4bd202b
children	6dd232798997

rev	line source
25054 6652d3823428 maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	1 ## Copyright (C) 2008-2018 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 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	5 ## Octave is free software: you can redistribute it and/or modify it
11104 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
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	7 ## 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	8 ## (at your option) any later version.
11104 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## GNU General Public License for more details.
11104 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
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	17 ## <https://www.gnu.org/licenses/>.
8126 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 --
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 {} {} comet (@var{y})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20173 diff changeset	21 ## @deftypefnx {} {} comet (@var{x}, @var{y})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20173 diff changeset	22 ## @deftypefnx {} {} comet (@var{x}, @var{y}, @var{p})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20173 diff changeset	23 ## @deftypefnx {} {} 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
20173 777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	25 ## the input coordinate vectors (@var{x}, @var{y}).
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	26 ##
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	27 ## If @var{x} is not specified it defaults to the indices of @var{y}.
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	28 ##
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	29 ## 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	30 ## 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	31 ## @var{p} is 0.1 seconds.
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	32 ##
24431 0c6cedafc71e doc: Use 'axes' rather than 'axis' appropriately in docstrings. Rik <rik@octave.org> parents: 23219 diff changeset	33 ## If the first argument @var{hax} is an axes handle, then plot into this axes,
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17060 diff changeset	34 ## 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	35 ## @seealso{comet3}
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	36 ## @end deftypefn
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	37
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	38 ## Author: Ben Abbott bpabbott@mac.com
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	39 ## Created: 2008-09-21
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	40
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	41 function comet (varargin)
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	42
17060 2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	43 [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	44
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	45 if (nargin == 0)
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	46 print_usage ();
11378 a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	47 elseif (nargin == 1)
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	48 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	49 x = 1:numel (y);
11378 a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	50 p = 0.1;
a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	51 elseif (nargin == 2)
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	52 x = varargin{1};
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	53 y = varargin{2};
11378 a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	54 p = 0.1;
a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	55 elseif (nargin == 3)
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	56 x = varargin{1};
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	57 y = varargin{2};
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	58 p = varargin{3};
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	59 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	60
17211 87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. Rik <rik@octave.org> parents: 17190 diff changeset	61 oldfig = [];
17301 68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc. Rik <rik@octave.org> parents: 17211 diff changeset	62 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	63 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	64 endif
11378 a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	65 unwind_protect
17060 2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	66 hax = newplot (hax);
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	67 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	68 num = numel (y);
a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	69 dn = round (num/10);
17186 c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	70
c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	71 hl = plot (x(1), y(1), "color", "r", "marker", "none",
c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	72 x(1), y(1), "color", "g", "marker", "none",
c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	73 x(1), y(1), "color", "b", "marker", "o");
c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	74 axis (limits); # set manual limits to speed up plotting
c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	75
c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	76 for n = 2:(num+dn);
11378 a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	77 m = n - dn;
a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	78 m = max ([m, 1]);
a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	79 k = min ([n, num]);
17186 c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	80 set (hl(1), "xdata", x(1:m), "ydata", y(1:m));
c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	81 set (hl(2), "xdata", x(m:k), "ydata", y(m:k));
17187 1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17186 diff changeset	82 set (hl(3), "xdata", x(k), "ydata", y(k));
11378 a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	83 drawnow ();
a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	84 pause (p);
a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	85 endfor
17186 c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	86
11378 a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	87 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	88 if (! isempty (oldfig))
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	89 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	90 endif
11378 a0278a856516 comet: if axes are specified, switch temporarily John W. Eaton <jwe@octave.org> parents: 11104 diff changeset	91 end_unwind_protect
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	92
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	93 endfunction
a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	94
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	95
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> 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;
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 20852 diff changeset	98 %! title ("comet() animation");
17190 df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17187 diff changeset	99 %! hold on;
8126 a012580f0d2f comet.m: New File. Ben Abbott <bpabbott@mac.com> parents: diff changeset	100 %! 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	101 %! x = cos (2t) . (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	102 %! y = sin (2t) . (sin (t).^2);
17186 c954b0a396a2 comet.m: Speed up animation by using low-level graphic commands. Rik <rik@octave.org> parents: 17126 diff changeset	103 %! comet (x, y, 0.05);
17190 df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17187 diff changeset	104 %! hold off;

Mercurial > octave

annotate scripts/plot/draw/comet.m @ 25054:6652d3823428 stable