update packages

[CreaPhase.git] / octave_packages / m / plot / compass.m

diff --git a/octave_packages/m/plot/compass.m b/octave_packages/m/plot/compass.m
new file mode 100644 (file)
index 0000000..8e7b89a
--- /dev/null
+++ b/octave_packages/m/plot/compass.m
@@ -0,0 +1,120 @@
+## Copyright (C) 2007-2012 David Bateman
+##
+## 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} {} compass (@var{u}, @var{v})
+## @deftypefnx {Function File} {} compass (@var{z})
+## @deftypefnx {Function File} {} compass (@dots{}, @var{style})
+## @deftypefnx {Function File} {} compass (@var{h}, @dots{})
+## @deftypefnx {Function File} {@var{h} =} compass (@dots{})
+##
+## Plot the @code{(@var{u}, @var{v})} components of a vector field emanating
+## from the origin of a polar plot.  If a single complex argument @var{z} is
+## given, then @code{@var{u} = real (@var{z})} and @code{@var{v} = imag
+## (@var{z})}.
+##
+## The style to use for the plot can be defined with a line style @var{style}
+## in a similar manner to the line styles used with the @code{plot} command.
+##
+## The optional return value @var{h} is a vector of graphics handles to the
+## line objects representing the drawn vectors.
+##
+## @example
+## @group
+## a = toeplitz ([1;randn(9,1)], [1,randn(1,9)]);
+## compass (eig (a));
+## @end group
+## @end example
+##
+## @seealso{polar, quiver, feather, plot}
+## @end deftypefn
+
+function retval = compass (varargin)
+
+  [h, varargin, nargin] = __plt_get_axis_arg__ ("compass", varargin{:});
+
+  arrowsize = 0.25;
+
+  if (nargin == 0)
+    print_usage ();
+  elseif (nargin == 1 || (nargin == 2 && ! isnumeric (varargin{2})))
+    ioff = 2;
+    z = varargin{1}(:).';
+    u = real (z);
+    v = imag (z);
+  elseif (nargin > 1 && isnumeric (varargin{2}))
+    ioff = 3;
+    u = varargin{1}(:).';
+    v = varargin{2}(:).';
+  endif
+
+  line_spec = "b-";
+  have_line_spec = false;
+  while (ioff <= nargin)
+    arg = varargin{ioff++};
+    if ((ischar (arg) || iscell (arg)) && ! have_line_spec)
+      [linespec, valid] = __pltopt__ ("compass", arg, false);
+      if (valid)
+        line_spec = arg;
+        have_line_spec = true;
+        break;
+      else
+        error ("compass: invalid linespec");
+      endif
+    else
+      error ("compass: unrecognized argument");
+    endif
+  endwhile
+
+  ## Matlab draws compass plots, with the arrow head as one continous
+  ## line, and each arrow separately. This is completely different than
+  ## quiver and quite ugly.
+  n = length (u);
+  xend = u;
+  xtmp = u .* (1 - arrowsize);
+  yend = v;
+  ytmp = v .* (1 - arrowsize);
+  x = [zeros(1, n); xend; xtmp  - v * arrowsize / 3; xend; ...
+       xtmp + v * arrowsize / 3];
+  y = [zeros(1, n); yend; ytmp  + u * arrowsize / 3; yend; ...
+       ytmp - u * arrowsize / 3];
+  [r, p] = cart2pol (x, y);
+
+  oldh = gca ();
+  unwind_protect
+    axes (h);
+    newplot ();
+    hlist = polar (h, r, p, line_spec);
+  unwind_protect_cleanup
+    axes (oldh);
+  end_unwind_protect
+
+  if (nargout > 0)
+    retval = hlist;
+  endif
+
+endfunction
+
+
+%!demo
+%! clf
+%! randn_9x1_data = [-2.555884; 0.394974; -0.191871; -1.147024; 1.355425; -0.437335; -0.014370; -0.941312; 1.240300];
+%! randn_1x9_data = [1.42934, -1.10821, -1.70404, 0.63357, -0.68337, -1.19771, -0.96502, -1.12810, 0.22457];
+%! a = toeplitz ([1;randn_9x1_data], [1,randn_1x9_data]);
+%! compass (eig (a));
+