Mercurial > hg > octave-nkf
annotate scripts/plot/pie3.m @ 17191:85e55da61409
doc: Clarify description of plot format.
* scripts/plot/plot.m: Clarify description of plot format.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 06 Aug 2013 21:23:38 -0700 |
| parents | df4c4b7708a4 |
| children | 87ba70043bfc |
| 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 |
| 11330 | 2 ## Copyright (C) 2010 Kai Habel |
| 3 ## | |
| 4 ## This file is part of Octave. | |
| 5 ## | |
| 6 ## Octave is free software; you can redistribute it and/or modify it | |
| 7 ## under the terms of the GNU General Public License as published by | |
| 8 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 9 ## your option) any later version. | |
| 10 ## | |
| 11 ## Octave is distributed in the hope that it will be useful, but | |
| 12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 14 ## General Public License for more details. | |
| 15 ## | |
| 16 ## You should have received a copy of the GNU General Public License | |
| 17 ## along with Octave; see the file COPYING. If not, see | |
| 18 ## <http://www.gnu.org/licenses/>. | |
| 19 | |
| 20 ## -*- texinfo -*- | |
|
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
21 ## @deftypefn {Function File} {} pie3 (@var{x}) |
|
17064
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
22 ## @deftypefnx {Function File} {} pie3 (@dots{}, @var{explode}) |
| 11330 | 23 ## @deftypefnx {Function File} {} pie3 (@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
|
24 ## @deftypefnx {Function File} {} pie3 (@var{hax}, @dots{}); |
| 11330 | 25 ## @deftypefnx {Function File} {@var{h} =} pie3 (@dots{}); |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
26 ## Plot a 3-D pie chart. |
| 11330 | 27 ## |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
28 ## Called with a single vector argument, produces a 3-D pie chart of the |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
29 ## 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
|
30 ## 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
|
31 ## @code{pct = @var{x}(i) / sum (@var{x})}. |
| 11330 | 32 ## |
|
17064
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
33 ## 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
|
34 ## that, if non-zero, "explodes" the slice from the pie chart. |
| 11330 | 35 ## |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
36 ## 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
|
37 ## length as @var{x} specifying the label for each slice. |
| 11330 | 38 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17064
diff
changeset
|
39 ## 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
|
40 ## rather than the current axes returned by @code{gca}. |
|
17064
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
41 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17064
diff
changeset
|
42 ## The optional return value @var{h} is a list of graphics handles to the |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17064
diff
changeset
|
43 ## patch, surface, and text objects generating the plot. |
| 11330 | 44 ## |
|
17064
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
45 ## 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
|
46 ## 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
|
47 ## 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
|
48 ## 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
|
49 ## |
|
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
50 ## @seealso{pie, bar, hist, rose} |
| 11330 | 51 ## @end deftypefn |
| 52 | |
| 53 ## Very roughly based on pie.m from octave-forge whose author was | |
| 54 ## Daniel Heiserer <Daniel.heiserer@physik.tu-muenchen.de> | |
| 55 | |
|
17064
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
56 function h = pie3 (varargin) |
| 11330 | 57 |
|
17064
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
58 [hax, varargin, nargin] = __plt_get_axis_arg__ ("pie3", varargin{:}); |
| 11330 | 59 |
| 60 if (nargin < 1) | |
| 61 print_usage (); | |
| 62 endif | |
| 63 | |
|
17064
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
64 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
|
65 unwind_protect |
|
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
66 hax = newplot (hax); |
|
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
67 htmp = __pie__ ("pie3", hax, varargin{:}); |
|
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
68 unwind_protect_cleanup |
|
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
69 if (! isempty (oldfig)) |
|
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
70 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
|
71 endif |
|
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
72 end_unwind_protect |
|
84e000930ca5
pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
73 |
| 11330 | 74 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
|
75 h = htmp; |
| 11330 | 76 endif |
| 77 | |
| 78 endfunction | |
| 79 | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
12344
diff
changeset
|
80 |
| 11330 | 81 %!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
|
82 %! clf; |
| 11330 | 83 %! pie3 ([5:-1:1], [0, 0, 1, 0, 0]); |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
12344
diff
changeset
|
84 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); |
|
17190
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
85 %! title ('pie3() with exploded wedge'); |
| 11330 | 86 |
| 87 %!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
|
88 %! clf; |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
89 %! pie3 ([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:
12344
diff
changeset
|
90 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); |
| 11330 | 91 %! axis ([-2,2,-2,2]); |
|
17190
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
92 %! title ('pie3() with labels'); |
|
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
93 |
|
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
94 %!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
|
95 %! clf; |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
96 %! pie3 ([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:
12344
diff
changeset
|
97 %! 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
|
98 %! axis ([-2,2,-2,2]); |
|
17190
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
99 %! title ('pie3() with missing slice'); |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
12344
diff
changeset
|
100 |