Mercurial > hg > octave-nkf
annotate scripts/plot/comet.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 31 Jul 2013 13:53:30 -0700 |
| parents | 2d17dbdf6b7d |
| children | 26589abbc78d |
| 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 | 3 ## This file is part of Octave. |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 8126 | 15 ## You should have received a copy of the GNU General Public License |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 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 | 21 ## @deftypefnx {Function File} {} comet (@var{x}, @var{y}) |
| 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 | 27 ## |
| 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 | 31 ## |
|
17122
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 | 35 ## @end deftypefn |
| 36 | |
| 37 ## Author: Ben Abbott bpabbott@mac.com | |
| 38 ## Created: 2008-09-21 | |
| 39 | |
| 40 function comet (varargin) | |
| 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 | 44 if (nargin == 0) |
| 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 | 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 | 51 x = varargin{1}; |
| 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 | 55 x = varargin{1}; |
| 56 y = varargin{2}; | |
| 57 p = varargin{3}; | |
| 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]); |
|
17060
2d17dbdf6b7d
comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
70 plot (hax, x(1:m), y(1:m), "r", x(m:k), y(m:k), "g", x(k), y(k), "ob"); |
|
2d17dbdf6b7d
comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
71 axis (hax, 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 | 80 |
| 81 endfunction | |
| 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 | 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 | 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 | 90 |