|
7017
|
1 ## Copyright (C) 2006, 2007 Michel D. Schmid |
|
6303
|
2 ## |
|
6440
|
3 ## This file is part of Octave. |
|
|
4 ## |
|
|
5 ## Octave is free software; you can redistribute it and/or modify it |
|
6303
|
6 ## under the terms of the GNU General Public License as published by |
|
7016
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
|
|
8 ## your option) any later version. |
|
6303
|
9 ## |
|
6440
|
10 ## Octave is distributed in the hope that it will be useful, but |
|
6303
|
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 ## |
|
|
15 ## You should have received a copy of the GNU General Public License |
|
7016
|
16 ## along with Octave; see the file COPYING. If not, see |
|
|
17 ## <http://www.gnu.org/licenses/>. |
|
6303
|
18 |
|
|
19 ## -*- texinfo -*- |
|
|
20 ## @deftypefn {Function File} {@var{h} =} stem (@var{x}, @var{y}, @var{linespec}) |
|
6506
|
21 ## Plot a stem graph and return the handles of the line and marker |
|
6303
|
22 ## objects used to draw the stems. The default color is @code{"r"} |
|
6895
|
23 ## (red). The default line style is @code{"-"} and the default marker is |
|
6303
|
24 ## @code{"o"}. |
|
|
25 ## |
|
|
26 ## For example, |
|
|
27 ## @example |
|
|
28 ## x = 1:10; |
|
|
29 ## stem (x); |
|
|
30 ## @end example |
|
|
31 ## @noindent |
|
6509
|
32 ## plots 10 stems with heights from 1 to 10; |
|
6303
|
33 ## |
|
|
34 ## @example |
|
|
35 ## x = 1:10; |
|
|
36 ## y = ones (1, length (x))*2.*x; |
|
|
37 ## stem (x, y); |
|
|
38 ## @end example |
|
|
39 ## @noindent |
|
6509
|
40 ## plots 10 stems with heights from 2 to 20; |
|
6303
|
41 ## |
|
|
42 ## @example |
|
|
43 ## x = 1:10; |
|
|
44 ## y = ones (size (x))*2.*x; |
|
|
45 ## h = stem (x, y, "b"); |
|
|
46 ## @end example |
|
|
47 ## @noindent |
|
6509
|
48 ## plots 10 bars with heights from 2 to 20 |
|
6303
|
49 ## (the color is blue, and @var{h} is a 2-by-10 array of handles in |
|
7001
|
50 ## which the first row holds the line handles and |
|
6303
|
51 ## the second row holds the marker handles); |
|
|
52 ## |
|
|
53 ## @example |
|
|
54 ## x = 1:10; |
|
|
55 ## y = ones (size (x))*2.*x; |
|
|
56 ## h = stem (x, y, "-.k"); |
|
|
57 ## @end example |
|
|
58 ## @noindent |
|
6509
|
59 ## plots 10 stems with heights from 2 to 20 |
|
6303
|
60 ## (the color is black, line style is @code{"-."}, and @var{h} is a 2-by-10 |
|
|
61 ## array of handles in which the first row holds the line handles and |
|
7001
|
62 ## the second row holds the marker handles); |
|
6303
|
63 ## |
|
|
64 ## @example |
|
|
65 ## x = 1:10; |
|
|
66 ## y = ones (size (x))*2.*x; |
|
|
67 ## h = stem (x, y, "-.k."); |
|
|
68 ## @end example |
|
|
69 ## @noindent |
|
6509
|
70 ## plots 10 stems with heights from 2 to 20 |
|
6303
|
71 ## (the color is black, line style is @code{"-."} and the marker style |
|
|
72 ## is @code{"."}, and @var{h} is a 2-by-10 array of handles in which the |
|
|
73 ## first row holds the line handles and the second row holds the marker |
|
|
74 ## handles); |
|
|
75 ## |
|
|
76 ## @example |
|
|
77 ## x = 1:10; |
|
|
78 ## y = ones (size (x))*2.*x; |
|
|
79 ## h = stem (x, y, "fill"); |
|
|
80 ## @end example |
|
|
81 ## @noindent |
|
6506
|
82 ## plots 10 stems with heights from 2 to 20 |
|
6303
|
83 ## (the color is rgb-triple defined, the line style is @code{"-"}, |
|
|
84 ## the marker style is @code{"o"}, and @var{h} is a 2-by-10 array of |
|
|
85 ## handles in which the first row holds the line handles and the second |
|
|
86 ## row holds the marker handles). |
|
|
87 ## |
|
|
88 ## Color definitions with rgb-triples are not valid! |
|
|
89 ## @seealso{bar, barh, plot} |
|
|
90 ## @end deftypefn |
|
|
91 |
|
|
92 ## Author: Michel D. Schmid <michaelschmid@users.sourceforge.net> |
|
|
93 ## Adapted-by: jwe |
|
|
94 |
|
|
95 function h = stem (varargin) |
|
|
96 |
|
|
97 if (nargin < 1 || nargin > 4) |
|
|
98 print_usage (); |
|
|
99 endif |
|
|
100 |
|
|
101 [x, y, dofill, lc, ls, mc, ms] = check_stem_arg (varargin{:}); |
|
|
102 |
|
6509
|
103 if (dofill) |
|
|
104 fc = mc; |
|
|
105 else |
|
|
106 fc = "none"; |
|
|
107 endif |
|
|
108 |
|
6303
|
109 newplot (); |
|
7189
|
110 nx = numel (x); |
|
6506
|
111 xt = x(:)'; |
|
7189
|
112 xt = [xt; xt; NaN(1, nx)](:); |
|
6506
|
113 yt = y(:)'; |
|
7189
|
114 yt = [zeros(1, nx); yt; NaN(1, nx)](:); |
|
|
115 h_stems = plot (xt, yt, "color", lc, "linestyle", ls, |
|
6511
|
116 x, y, "color", mc, "marker", ms, "linestyle", "", |
|
|
117 "markerfacecolor", fc); |
|
|
118 |
|
|
119 ## Must draw the plot first to get proper x limits. |
|
|
120 drawnow(); |
|
|
121 x_axis_range = get (gca, "xlim"); |
|
|
122 h_baseline = line (x_axis_range, [0, 0], "color", [0, 0, 0]); |
|
6303
|
123 |
|
|
124 if (nargout > 0) |
|
6511
|
125 h = [h_stems; h_baseline]; |
|
6303
|
126 endif |
|
|
127 |
|
|
128 endfunction |
|
|
129 |
|
|
130 function [x, y, dofill, lc, ls, mc, ms] = check_stem_arg (varargin) |
|
|
131 |
|
|
132 ## set specifiers to default values |
|
|
133 [lc, ls, mc, ms] = set_default_values (); |
|
|
134 dofill = 0; |
|
|
135 fill_2 = 0; |
|
|
136 linespec_2 = 0; |
|
|
137 |
|
|
138 ## check input arguments |
|
|
139 if (nargin == 1) |
|
|
140 y = varargin{1}; |
|
|
141 if (isvector (y)) |
|
|
142 x = 1:length(y); |
|
|
143 elseif (ismatrix (y)) |
|
|
144 x = 1:rows(y); |
|
|
145 else |
|
|
146 error ("stem: Y must be a matrix"); |
|
|
147 endif # in each case, x & y will be defined |
|
|
148 |
|
|
149 elseif (nargin == 2) |
|
|
150 ## several possibilities |
|
|
151 ## 1. the real y data |
|
|
152 ## 2. 'fill' |
|
|
153 ## 3. line spec |
|
|
154 if (ischar (varargin{2})) |
|
|
155 ## only 2. or 3. possible |
|
|
156 if (strcmp ("fill", varargin{2})) |
|
|
157 dofill = 1; |
|
|
158 else |
|
|
159 ## parse the linespec |
|
|
160 [lc, ls, mc, ms] = stem_line_spec (varargin{2}); |
|
|
161 endif |
|
|
162 y = varargin{1}; |
|
|
163 if (isvector (y)) |
|
|
164 x = 1:length(y); |
|
|
165 elseif (ismatrix (y)) |
|
|
166 x = 1:rows(y); |
|
|
167 else |
|
|
168 error ("stem: Y must be a matrix"); |
|
|
169 endif # in each case, x & y will be defined |
|
|
170 else |
|
|
171 ## must be the real y data |
|
|
172 x = varargin{1}; |
|
|
173 y = varargin{2}; |
|
|
174 if (! (ismatrix (x) && ismatrix (y))) |
|
|
175 error ("stem: X and Y must be matrices"); |
|
|
176 endif |
|
|
177 endif |
|
|
178 elseif (nargin == 3) |
|
|
179 ## again several possibilities |
|
|
180 ## arg2 1. real y |
|
|
181 ## arg2 2. 'fill' or linespec |
|
|
182 ## arg3 1. 'fill' or linespec |
|
|
183 if (ischar (varargin{2})) |
|
|
184 ## only arg2 2. / arg3 1. & arg3 3. are possible |
|
|
185 if (strcmp ("fill", varargin{2})) |
|
|
186 dofill = 1; |
|
|
187 fill_2 = 1; # be sure, no second "fill" is in the arguments |
|
|
188 else |
|
|
189 ## must be a linespec |
|
|
190 [lc, ls, mc, ms] = stem_line_spec (varargin{2}); |
|
|
191 linespec_2 = 1; |
|
|
192 endif |
|
|
193 y = varargin{1}; |
|
|
194 if (isvector (y)) |
|
|
195 x = 1:length(y); |
|
|
196 elseif (ismatrix (y)) |
|
|
197 x = 1:size(y,1); |
|
|
198 else |
|
|
199 error ("stem: Y must be a matrix"); |
|
|
200 endif # in each case, x & y will be defined |
|
|
201 else |
|
|
202 ## must be the real y data |
|
|
203 x = varargin{1}; |
|
|
204 y = varargin{2}; |
|
|
205 if (! (ismatrix (x) && ismatrix (y))) |
|
|
206 error ("stem: X and Y must be matrices"); |
|
|
207 endif |
|
|
208 endif # if ischar(varargin{2}) |
|
|
209 ## varargin{3} must be char... |
|
|
210 ## check for "fill" .. |
|
|
211 if (strcmp ("fill", varargin{3}) & fill_2) |
|
|
212 error ("stem:check_stem_arg: duplicate fill argument"); |
|
|
213 elseif (strcmp("fill", varargin{3}) & linespec_2) |
|
|
214 # must be "fill" |
|
|
215 dofill = 1; |
|
|
216 fill_2 = 1; |
|
|
217 elseif (strcmp ("fill", varargin{3}) & ! linespec_2) |
|
|
218 ## must be "fill" |
|
|
219 dofill = 1; |
|
|
220 fill_2 = 1; |
|
|
221 elseif (! linespec_2) |
|
|
222 ## must be linespec |
|
|
223 [lc, ls, mc, ms] = stem_line_spec (varargin{3}); |
|
|
224 linespec_2 = 1; |
|
|
225 endif |
|
|
226 elseif (nargin == 4) |
|
|
227 x = varargin{1}; |
|
|
228 y = varargin{2}; |
|
|
229 if (! (ismatrix (x) && ismatrix (y))) |
|
|
230 error ("X and Y must be matrices"); |
|
|
231 endif |
|
|
232 |
|
|
233 if (strcmp ("fill", varargin{3})) |
|
|
234 dofill = 1; |
|
|
235 fill_2 = 1; # be sure, no second "fill" is in the arguments |
|
|
236 else |
|
|
237 ## must be a linespec |
|
|
238 [lc, ls, mc, ms] = stem_line_spec (varargin{3}); |
|
|
239 linespec_2 = 1; |
|
|
240 endif |
|
|
241 |
|
|
242 ## check for "fill" .. |
|
|
243 if (strcmp ("fill", varargin{4}) & fill_2) |
|
|
244 error ("stem:check_stem_arg: duplicate fill argument"); |
|
|
245 elseif (strcmp ("fill", varargin{4}) & linespec_2) |
|
|
246 ## must be "fill" |
|
|
247 dofill = 1; |
|
|
248 fill_2 = 1; |
|
|
249 elseif (! strcmp ("fill", varargin{4}) & ! linespec_2) |
|
|
250 ## must be linespec |
|
|
251 [lc, ls, mc, ms] = stem_line_spec (varargin{4}); |
|
|
252 linespec_2 = 1; |
|
|
253 endif |
|
|
254 endif |
|
|
255 |
|
|
256 endfunction |
|
|
257 |
|
|
258 function [lc, ls, mc, ms] = stem_line_spec (str) |
|
|
259 if (! ischar (str)) |
|
|
260 error ("stem:stem_line_spec: wrong argument type, must be \"fill\" or a string of specifiers"); |
|
|
261 endif |
|
|
262 [lc, ls, mc, ms] = set_default_values (); |
|
|
263 ## Parse the line specifier string. |
|
6534
|
264 cur_props = __pltopt__ ("stem", str, false); |
|
6303
|
265 for i = 1:length(cur_props) |
|
7189
|
266 if (isfield (cur_props(i), "color") && ! isempty (cur_props(i).color)); # means line color |
|
|
267 mc = lc = cur_props(i).color; |
|
6303
|
268 elseif (isfield (cur_props(i), "linestyle")) |
|
|
269 ls = cur_props(i).linestyle; |
|
6506
|
270 elseif (isfield (cur_props(i), "marker") && ! strcmp (cur_props(i).marker, "none")) |
|
6303
|
271 ms = cur_props(i).marker; |
|
|
272 endif |
|
|
273 endfor |
|
|
274 endfunction |
|
|
275 |
|
|
276 function [lc, ls, mc, ms] = set_default_values () |
|
|
277 ## set default values |
|
6473
|
278 mc = [1, 0, 0]; |
|
|
279 lc = [1, 0, 0]; |
|
6303
|
280 ls = "-"; |
|
|
281 ms = "o"; |
|
|
282 endfunction |
