octave_packages/m/plot/stem3.m

   1 ## Copyright (C) 2007-2012 David Bateman
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  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
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {@var{h} =} stem3 (@var{x}, @var{y}, @var{z}, @var{linespec})
  21 ## Plot a three-dimensional stem graph and return the handles of the line
  22 ## and marker objects used to draw the stems as "stem series" object.
  23 ## The default color is @code{"r"} (red).  The default line style is
  24 ## @code{"-"} and the default marker is @code{"o"}.
  25 ##
  26 ## For example,
  27 ##
  28 ## @example
  29 ## @group
  30 ## theta = 0:0.2:6;
  31 ## stem3 (cos (theta), sin (theta), theta)
  32 ## @end group
  33 ## @end example
  34 ##
  35 ## @noindent
  36 ## plots 31 stems with heights from 0 to 6 lying on a circle.  Color
  37 ## definitions with RGB-triples are not valid!
  38 ## @seealso{bar, barh, stem, plot}
  39 ## @end deftypefn
  40
  41 function h = stem3 (varargin)
  42
  43   if (nargin < 1 || nargin > 4)
  44     print_usage ();
  45   endif
  46
  47   tmp = __stem__ (true, varargin{:});
  48
  49   if (nargout > 0)
  50     h = tmp;
  51   endif
  52
  53 endfunction
  54
  55 %!demo
  56 %! clf
  57 %! theta = 0:0.2:6;
  58 %! stem3 (cos (theta), sin (theta), theta)