octave_packages/m/plot/scatter3.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} {} scatter3 (@var{x}, @var{y}, @var{z}, @var{s}, @var{c})
  21 ## @deftypefnx {Function File} {} scatter3 (@dots{}, 'filled')
  22 ## @deftypefnx {Function File} {} scatter3 (@dots{}, @var{style})
  23 ## @deftypefnx {Function File} {} scatter3 (@dots{}, @var{prop}, @var{val})
  24 ## @deftypefnx {Function File} {} scatter3 (@var{h}, @dots{})
  25 ## @deftypefnx {Function File} {@var{h} =} scatter3 (@dots{})
  26 ##
  27 ## Plot a scatter plot of the data in 3D@.  A marker is plotted at each point
  28 ## defined by the points in the vectors @var{x}, @var{y} and @var{z}.  The size
  29 ## of the markers used is determined by @var{s}, which can be a scalar or
  30 ## a vector of the same length of @var{x}, @var{y} and @var{z}.  If @var{s} is
  31 ## not given or is an empty matrix, then the default value of 8 points is used.
  32 ##
  33 ## The color of the markers is determined by @var{c}, which can be a string
  34 ## defining a fixed color; a 3-element vector giving the red, green, and blue
  35 ## components of the color; a vector of the same length as @var{x} that gives
  36 ## a scaled index into the current colormap; or a @var{n}-by-3 matrix defining
  37 ## the colors of each of the markers individually.
  38 ##
  39 ## The marker to use can be changed with the @var{style} argument, that is a
  40 ## string defining a marker in the same manner as the @code{plot} command.
  41 ## If the argument 'filled' is given then the markers as filled.  All
  42 ## additional arguments are passed to the underlying patch command.
  43 ##
  44 ## The optional return value @var{h} is a graphics handle to the hggroup
  45 ## object representing the points.
  46 ##
  47 ## @example
  48 ## @group
  49 ## [x, y, z] = peaks (20);
  50 ## scatter3 (x(:), y(:), z(:), [], z(:));
  51 ## @end group
  52 ## @end example
  53 ##
  54 ## @seealso{plot, patch, scatter}
  55 ## @end deftypefn
  56
  57 function retval = scatter3 (varargin)
  58
  59   [h, varargin, nargin] = __plt_get_axis_arg__ ("scatter3", varargin{:});
  60
  61   if (nargin < 2)
  62     print_usage ();
  63   else
  64     oldh = gca ();
  65     unwind_protect
  66       axes (h);
  67       newplot ();
  68       tmp = __scatter__ (h, 3, "scatter3", varargin{:});
  69     unwind_protect_cleanup
  70       axes (oldh);
  71     end_unwind_protect
  72   endif
  73
  74   if (! ishold ())
  75     set (h, "view", [-37.5, 30],
  76          "xgrid", "on", "ygrid", "on", "zgrid", "on");
  77   endif
  78
  79   if (nargout > 0)
  80     retval = tmp;
  81   endif
  82
  83 endfunction
  84
  85
  86 %!demo
  87 %! clf
  88 %! [x, y, z] = peaks (20);
  89 %! scatter3 (x(:), y(:), z(:), [], z(:));
  90
  91 %!demo
  92 %! clf
  93 %! x = rand (20,1);
  94 %! y = rand (20,1);
  95 %! z = rand (20,1);
  96 %! scatter3 (x(:), y(:), z(:), 10, z(:), "s");
  97
  98 %!demo
  99 %! clf
 100 %! x = rand (20,1);
 101 %! y = rand (20,1);
 102 %! z = rand (20,1);
 103 %! scatter3 (x(:), y(:), z(:), 20*z(:), z(:), "s");
 104
 105 %!demo
 106 %! clf
 107 %! x = rand (20,1);
 108 %! y = rand (20,1);
 109 %! z = rand (20,1);
 110 %! scatter3 (x(:), y(:), z(:), 20*z(:), [], "s");
 111