annotate scripts/plot/draw/stem.m @ 19630:0e1f5a750d00

maint: Periodic merge of gui-release to default.
author John W. Eaton <jwe@octave.org>
date Tue, 20 Jan 2015 10:24:46 -0500
parents 2d0afa04d103 446c46af4b42
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17572
diff changeset
1 ## Copyright (C) 2006-2013 Michel D. Schmid
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
2 ##
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6303
diff changeset
3 ## This file is part of Octave.
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6303
diff changeset
4 ##
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6303
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
8 ## your option) any later version.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
9 ##
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6303
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
14 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
18
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 16751
diff changeset
20 ## @deftypefn {Function File} {} stem (@var{y})
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
21 ## @deftypefnx {Function File} {} stem (@var{x}, @var{y})
17067
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
22 ## @deftypefnx {Function File} {} stem (@dots{}, @var{linespec})
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
23 ## @deftypefnx {Function File} {} stem (@dots{}, "filled")
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17067
diff changeset
24 ## @deftypefnx {Function File} {} stem (@dots{}, @var{prop}, @var{val}, @dots{})
17067
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
25 ## @deftypefnx {Function File} {} stem (@var{hax}, @dots{})
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
26 ## @deftypefnx {Function File} {@var{h} =} stem (@dots{})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17067
diff changeset
27 ## Plot a 2-D stem graph.
17067
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
28 ##
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
29 ## If only one argument is given, it is taken as the y-values and the
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
30 ## x-coordinates are taken from the indices of the elements.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
31 ##
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
32 ## If @var{y} is a matrix, then each column of the matrix is plotted as
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
33 ## a separate stem graph. In this case @var{x} can either be a vector,
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
34 ## the same length as the number of rows in @var{y}, or it can be a
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
35 ## matrix of the same size as @var{y}.
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
36 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
37 ## The default color is @qcode{"b"} (blue), the default line style is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
38 ## @qcode{"-"}, and the default marker is @qcode{"o"}. The line style can
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
39 ## be altered by the @code{linespec} argument in the same manner as the
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
40 ## @code{plot} command. If the @qcode{"filled"} argument is present the
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
41 ## markers at the top of the stems will be filled in. For example,
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
42 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
43 ## @example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
44 ## @group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
45 ## x = 1:10;
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
46 ## y = 2*x;
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
47 ## stem (x, y, "r");
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
48 ## @end group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
49 ## @end example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
50 ##
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
51 ## @noindent
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
52 ## plots 10 stems with heights from 2 to 20 in red;
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
53 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17067
diff changeset
54 ## Optional property/value pairs may be specified to control the appearance
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17067
diff changeset
55 ## of the plot.
17067
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
56 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17067
diff changeset
57 ## 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: 17067
diff changeset
58 ## rather than the current axes returned by @code{gca}.
17067
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
59 ##
17513
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
60 ## The optional return value @var{h} is a handle to a @nospell{"stem series"}
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
61 ## hggroup. The single hggroup handle has all of the graphical elements
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
62 ## comprising the plot as its children; This allows the properties of
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
63 ## multiple graphics objects to be changed by modifying just a single
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
64 ## property of the @nospell{"stem series"} hggroup.
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
65 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
66 ## For example,
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
67 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
68 ## @example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
69 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
70 ## x = [0:10]';
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
71 ## y = [sin(x), cos(x)]
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
72 ## h = stem (x, y);
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
73 ## set (h(2), "color", "g");
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
74 ## set (h(1), "basevalue", -1)
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
75 ## @end group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
76 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
77 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
78 ## @noindent
17513
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
79 ## changes the color of the second @nospell{"stem series"} and moves the base
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
80 ## line of the first.
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
81 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
82 ## Stem Series Properties
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
83 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
84 ## @table @asis
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
85 ## @item linestyle
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
86 ## The linestyle of the stem. (Default: @qcode{"-"})
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
87 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
88 ## @item linewidth
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
89 ## The width of the stem. (Default: 0.5)
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
90 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
91 ## @item color
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
92 ## The color of the stem, and if not separately specified, the marker.
17513
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
93 ## (Default: @qcode{"b"} [blue])
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
94 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
95 ## @item marker
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
96 ## The marker symbol to use at the top of each stem. (Default: @qcode{"o"})
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
97 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
98 ## @item markeredgecolor
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
99 ## The edge color of the marker. (Default: @qcode{"color"} property)
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
100 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
101 ## @item markerfacecolor
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
102 ## The color to use for @nospell{"filling"} the marker.
17513
fedcd3717ebc doc: grammarcheck of documentation before 3.8 release.
Rik <rik@octave.org>
parents: 17432
diff changeset
103 ## (Default: @qcode{"none"} [unfilled])
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
104 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
105 ## @item markersize
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
106 ## The size of the marker. (Default: 6)
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
107 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
108 ## @item baseline
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
109 ## The handle of the line object which implements the baseline. Use @code{set}
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
110 ## with the returned handle to change graphic properties of the baseline.
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
111 ##
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
112 ## @item basevalue
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
113 ## The y-value where the baseline is drawn. (Default: 0)
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
114 ## @end table
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17067
diff changeset
115 ## @seealso{stem3, bar, hist, plot, stairs}
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
116 ## @end deftypefn
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
117
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
118 ## Author: Michel D. Schmid <michaelschmid@users.sourceforge.net>
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
119 ## Adapted-by: jwe
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
120
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
121 function h = stem (varargin)
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
122
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8052
diff changeset
123 if (nargin < 1)
7218
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
124 print_usage ();
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
125 endif
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
126
17067
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
127 htmp = __stem__ (false, varargin{:});
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
128
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
129 if (nargout > 0)
17067
b2cbf369837e stem.m, stem3.m, __stem__.m: Upgrade to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16828
diff changeset
130 h = htmp;
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
131 endif
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
132
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
133 endfunction
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
134
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
135
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
136 %!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
137 %! clf;
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
138 %! y = 1:10;
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
139 %! stem (y);
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
140 %! title ('stem plot of y-values only');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
141
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
142 %!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
143 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
144 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
145 %! y = 2*x;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
146 %! stem (x, y);
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
147 %! title ('stem plot of x and y-values');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
148
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
149 %!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
150 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
151 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
152 %! y = 2*x;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
153 %! h = stem (x, y, 'r');
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
154 %! title ('stem plot with modified color');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
155
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
156 %!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
157 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
158 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
159 %! y = 2*x;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
160 %! h = stem (x, y, '-.k');
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
161 %! title ('stem plot with modified line style and color');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
162
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
163 %!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
164 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
165 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
166 %! y = 2*x;
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
167 %! h = stem (x, y, '-.ks');
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
168 %! title ('stem plot with modified line style, color, and marker');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
169
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
170 %!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
171 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
172 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
173 %! y = 2*x;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
174 %! h = stem (x, y, 'filled');
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
175 %! title ('stem plot with "filled" markers');
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
176
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
177 %!demo
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
178 %! clf;
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
179 %! x = 1:10;
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
180 %! y = 2*x;
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
181 %! h = stem (x, y, 'markerfacecolor', [1 0 1]);
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
182 %! title ('stem plot modified with property/value pair');
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
183
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
184 %!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
185 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
186 %! x = (0 : 10)';
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
187 %! y = [sin(x), cos(x)];
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
188 %! h = stem (x, y);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
189 %! set (h(2), 'color', 'g');
18463
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
190 %! set (h(1), 'basevalue', -0.75);
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
191 %! title ('stem plots modified through hggroup handle');
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
192
16751
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
193 %!demo
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
194 %! clf;
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
195 %! N = 11;
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
196 %! x = 0:(N-1);
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
197 %! y = rand (1, N);
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
198 %! hs = stem (x(1), y(1));
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
199 %! set (gca (), 'xlim', [1, N-1], 'ylim', [0, 1]);
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
200 %! title ('stem plot data modified through hggroup handle');
16751
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
201 %! for k=2:N
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
202 %! set (hs, 'xdata', x(1:k), 'ydata', y(1:k))
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
203 %! drawnow ();
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
204 %! pause (0.2);
92811d110839 Update copies consistent subset of {x,y,z}data to children of the stem hggoup.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
205 %! end
16828
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents: 16814
diff changeset
206
17432
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
207 %!error stem ()
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
208 %!error <can not define Z for 2-D stem plot> stem (1,2,3)
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
209 %!error <X and Y must be numeric> stem ({1})
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
210 %!error <X and Y must be numeric> stem (1, {1})
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
211 %!error <inconsistent sizes for X and Y> stem (1:2, 1:3)
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
212 %!error <inconsistent sizes for X and Y> stem (1:2, ones (3,3))
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
213 %!error <inconsistent sizes for X and Y> stem (ones (2,2), ones (3,3))
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
214 %!error <No value specified for property "FOO"> stem (1, "FOO")
77bec442a35a Overhaul stem family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
215
18463
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
216 %!test
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
217 %! ## stemseries share the same baseline and basevalue
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
218 %! hf = figure ("visible", "off");
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
219 %! unwind_protect
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
220 %! h = stem ([1 2; 1.5 2.5], [1 1;2 2]);
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
221 %! assert (get (h(1), "baseline"), get (h(2), "baseline"))
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
222 %! bv = 0.3;
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
223 %! set (h(1), "basevalue", bv)
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
224 %! assert (get (get (h(1), "baseline"), "basevalue"), bv)
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
225 %! assert (get (h(1), "basevalue"), bv)
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
226 %! assert (get (h(2), "basevalue"), bv)
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
227 %! unwind_protect_cleanup
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
228 %! close (hf);
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
229 %! end_unwind_protect
2d0afa04d103 Make stemseries share the same baseline (bug #41593).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 17744
diff changeset
230