Mercurial > hg > octave-nkf

annotate scripts/plot/pie.m @ 17122:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 84e000930ca5
children df4c4b7708a4
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
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
2 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
4 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
9 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
14 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
18
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
11341
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
20 ## @deftypefn {Function File} {} pie (@var{x})
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
21 ## @deftypefnx {Function File} {} pie (@dots{}, @var{explode})
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} pie (@dots{}, @var{labels})
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
23 ## @deftypefnx {Function File} {} pie (@var{hax}, @dots{});
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} pie (@dots{});
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
25 ## Plot a 2-D pie chart.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
26 ##
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
27 ## When called with a single vector argument, produce a pie chart of the
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
28 ## elements in @var{x}. The size of the ith slice is the percentage that the
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
29 ## element @var{x}i represents of the total sum of @var{x}:
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
30 ## @code{pct = @var{x}(i) / sum (@var{x})}.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
31 ##
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
32 ## The optional input @var{explode} is a vector of the same length as @var{x}
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
33 ## that, if non-zero, "explodes" the slice from the pie chart.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
34 ##
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
35 ## The optional input @var{labels} is a cell array of strings of the same
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
36 ## length as @var{x} specifying the label for each slice.
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
37 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17064
diff changeset
38 ## 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: 17064
diff changeset
39 ## rather than the current axes returned by @code{gca}.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
40 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
41 ## The optional return value @var{h} is a list of handles to the patch
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
42 ## and text objects generating the plot.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
43 ##
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
44 ## Note: If @code{sum (@var{x}) @leq{} 1} then the elements of @var{x} are
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
45 ## interpreted as percentages directly and are not normalized by @code{sum (x)}.
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
46 ## Furthermore, if the sum is less than 1 then there will be a missing slice
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
47 ## in the pie plot to represent the missing, unspecified percentage.
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
48 ##
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
49 ## @seealso{pie3, bar, hist, rose}
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
50 ## @end deftypefn
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
51
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
52 ## Very roughly based on pie.m from octave-forge whose author was
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
53 ## Daniel Heiserer <Daniel.heiserer@physik.tu-muenchen.de>
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
54
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
55 function h = pie (varargin)
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
56
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
57 [hax, varargin, nargin] = __plt_get_axis_arg__ ("pie", varargin{:});
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
58
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
59 if (nargin < 1)
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
60 print_usage ();
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
61 endif
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
62
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
63 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure"));
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
64 unwind_protect
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
65 hax = newplot (hax);
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
66 htmp = __pie__ ("pie", hax, varargin{:});
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
67 unwind_protect_cleanup
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
68 if (! isempty (oldfig))
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
69 set (0, "currentfigure", oldfig);
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
70 endif
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
71 end_unwind_protect
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
72
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
73 if (nargout > 0)
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
74 h = htmp;
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
75 endif
7119
d22ad51b9cf8 [project @ 2007-11-07 21:06:27 by jwe]
jwe
parents: 7118
diff changeset
76
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
77 endfunction
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
78
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
79
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7119
diff changeset
80 %!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
81 %! clf;
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7119
diff changeset
82 %! pie ([3, 2, 1], [0, 0, 1]);
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
83 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]);
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7119
diff changeset
84
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7119
diff changeset
85 %!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
86 %! clf;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
87 %! pie ([3, 2, 1], [0, 0, 1], {'Cheddar', 'Swiss', 'Camembert'});
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
88 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]);
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7119
diff changeset
89 %! axis ([-2,2,-2,2]);
11341
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
90
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
91 %!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
92 %! clf;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
93 %! pie ([0.17, 0.34, 0.41], {'Cheddar', 'Swiss', 'Camembert'});
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
94 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]);
11341
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
95 %! axis ([-2,2,-2,2]);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
96 %! title ('missing slice');
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
97