Mercurial > octave
view scripts/plot/stem.m @ 17122:eaab03308c0b
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 | b2cbf369837e |
children | bc924baa2c4e |
line wrap: on
line source
## Copyright (C) 2006-2012 Michel D. Schmid ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} stem (@var{y}) ## @deftypefnx {Function File} {} stem (@var{x}, @var{y}) ## @deftypefnx {Function File} {} stem (@dots{}, @var{linespec}) ## @deftypefnx {Function File} {} stem (@dots{}, "filled") ## @deftypefnx {Function File} {} stem (@dots{}, @var{prop}, @var{val}, @dots{}) ## @deftypefnx {Function File} {} stem (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} stem (@dots{}) ## Plot a 2-D stem graph. ## ## If only one argument is given, it is taken as the y-values and the ## x-coordinates are taken from the indices of the elements. ## ## If @var{y} is a matrix, then each column of the matrix is plotted as ## a separate stem graph. In this case @var{x} can either be a vector, ## the same length as the number of rows in @var{y}, or it can be a ## matrix of the same size as @var{y}. ## ## The default color is @code{"b"} (blue), the default line style is ## @code{"-"}, and the default marker is @code{"o"}. The line style can ## be altered by the @code{linespec} argument in the same manner as the ## @code{plot} command. If the "filled" argument is present the markers at ## the top of the stems will be filled in. For example, ## ## @example ## @group ## x = 1:10; ## y = 2*x; ## stem (x, y, "r"); ## @end group ## @end example ## ## @noindent ## plots 10 stems with heights from 2 to 20 in red; ## ## Optional property/value pairs may be specified to control the appearance ## of the plot. ## ## If the first argument @var{hax} is an axes handle, then plot into this axis, ## rather than the current axes returned by @code{gca}. ## ## The optional return value @var{h} is a vector of "stem series" graphics ## handles with one handle per column of the variable @var{y}. The ## handle regroups the elements of the stem graph together as the ## children of the "stem series" handle, allowing them to be altered ## together. For example, ## ## @example ## @group ## x = [0:10]'; ## y = [sin(x), cos(x)] ## h = stem (x, y); ## set (h(2), "color", "g"); ## set (h(1), "basevalue", -1) ## @end group ## @end example ## ## @noindent ## changes the color of the second "stem series" and moves the base line ## of the first. ## @seealso{stem3, bar, hist, plot, stairs} ## @end deftypefn ## Author: Michel D. Schmid <michaelschmid@users.sourceforge.net> ## Adapted-by: jwe function h = stem (varargin) if (nargin < 1) print_usage (); endif htmp = __stem__ (false, varargin{:}); if (nargout > 0) h = htmp; endif endfunction %!demo %! clf; %! x = 1:10; %! stem (x); %!demo %! clf; %! x = 1:10; %! y = 2*x; %! stem (x, y); %!demo %! clf; %! x = 1:10; %! y = 2*x; %! h = stem (x, y, 'r'); %!demo %! clf; %! x = 1:10; %! y = 2*x; %! h = stem (x, y, '-.k'); %!demo %! clf; %! x = 1:10; %! y = 2*x; %! h = stem (x, y, '-.k.'); %!demo %! clf; %! x = 1:10; %! y = 2*x; %! h = stem (x, y, 'filled'); %!demo %! clf; %! x = (0 : 10)'; %! y = [sin(x), cos(x)]; %! h = stem (x, y); %! set (h(2), 'color', 'g'); %! set (h(1), 'basevalue', -1); %!demo %! clf; %! N = 11; %! x = 0:(N-1); %! y = rand (1, N); %! hs = stem (x(1), y(1)); %! set (gca (), 'xlim', [1, N-1], 'ylim', [0, 1]); %! for k=2:N %! set (hs, 'xdata', x(1:k), 'ydata', y(1:k)) %! drawnow (); %! pause (0.2); %! end