annotate scripts/plot/stem.m @ 8070:3b53b25e2550

Add data sources and line series
author David Bateman <dbateman@free.fr>
date Thu, 28 Aug 2008 12:23:54 -0400
parents 961d4c52ffae
children eb63fbe60fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 2006, 2007 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 -*-
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{h} =} stem (@var{x}, @var{y}, @var{linespec})
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
21 ## @deftypefnx {Function File} {@var{h} =} stem (@dots{}, "filled")
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
22 ## Plot a stem graph from two vectors of x-y data. If only one argument
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
23 ## is given, it is taken as the y-values and the x coordinates are taken
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
24 ## from the indicies of the elements.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
25 ##
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
26 ## If @var{y} is a matrix, then each column of the matrix is plotted as
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
27 ## a separate stem graph. In this case @var{x} can either be a vector,
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
28 ## 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
29 ## 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
30 ##
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
31 ## The default color is @code{"r"} (red). The default line style is
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
32 ## @code{"-"} and the default marker is @code{"o"}. The line style can
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
33 ## be altered by the @code{linespec} argument in the same manner as the
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
34 ## @code{plot} command. For example
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
35 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
36 ## @example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
37 ## @group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
38 ## x = 1:10;
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
39 ## y = ones (1, length (x))*2.*x;
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
40 ## stem (x, y, "b");
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
41 ## @end group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
42 ## @end example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
43 ##
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
44 ## @noindent
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
45 ## plots 10 stems with heights from 2 to 20 in blue;
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
46 ##
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
47 ## The return value of @code{stem} is a vector if "stem series" graphics
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
48 ## handles, with one handle per column of the variable @var{y}. This
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
49 ## handle regroups the elements of the stem graph together as the
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
50 ## children of the "stem series" handle, allowing them to be altered
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
51 ## together. For example
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
52 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
53 ## @example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
54 ## @group
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
55 ## x = [0 : 10].';
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
56 ## y = [sin(x), cos(x)]
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
57 ## h = stem (x, y);
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
58 ## set (h(2), "color", "g");
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
59 ## set (h(1), "basevalue", -1)
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
60 ## @end group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
61 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
62 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
63 ## @noindent
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
64 ## changes the color of the second "stem series" and moves the base line
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
65 ## of the first.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
66 ## @seealso{bar, barh, plot}
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
67 ## @end deftypefn
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
68
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
69 ## Author: Michel D. Schmid <michaelschmid@users.sourceforge.net>
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
70 ## Adapted-by: jwe
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
71
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
72 function h = stem (varargin)
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
73
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8052
diff changeset
74 if (nargin < 1)
7218
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
75 print_usage ();
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
76 endif
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
77
7217
c8abc18322b7 [project @ 2007-11-29 20:50:24 by jwe]
jwe
parents: 7189
diff changeset
78 tmp = __stem__ (false, varargin{:});
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
79
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
80 if (nargout > 0)
7217
c8abc18322b7 [project @ 2007-11-29 20:50:24 by jwe]
jwe
parents: 7189
diff changeset
81 h = tmp;
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
82 endif
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
83
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
84 endfunction
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
85
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
86 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
87 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
88 %! stem (x);
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
89
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
90 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
91 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
92 %! y = ones (1, length (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
93 %! stem (x, y);
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
94
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
95 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
96 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
97 %! y = ones (size (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
98 %! h = stem (x, y, "b");
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
99
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
100 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
101 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
102 %! y = ones (size (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
103 %! h = stem (x, y, "-.k");
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
104
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
105 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
106 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
107 %! y = ones (size (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
108 %! h = stem (x, y, "-.k.");
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
109
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
110 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
111 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
112 %! y = ones (size (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
113 %! h = stem (x, y, "fill");
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
114
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
115 %!demo
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
116 %! x = [0 : 10].';
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
117 %! y = [sin(x), cos(x)];
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
118 %! h = stem (x, y);
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
119 %! set (h(2), "color", "g");
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
120 %! set (h(1), "basevalue", -1)