Home > freetb4matlab > plot > rose.m

rose

PURPOSE ^

%

SYNOPSIS ^

function [thout, rout] = rose (varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {} rose (@var{th}, @var{r})
% @deftypefnx {Function File} {} rose (@var{h}, @dots{})
% @deftypefnx {Function File} {@var{h} =} rose (@dots{})
% @deftypefnx {Function File} {[@var{r}, @var{th}] =} rose (@dots{})
%
% Plot an angular histogram.  With one vector argument @var{th}, plots the
% histogram with 20 angular bins.  If @var{th} is a matrix, then each column
% of @var{th} produces a separate histogram.
%
% If @var{r} is given and is a scalar, then the histogram is produced with
% @var{r} bins.  If @var{r} is a vector, then the center of each bin are 
% defined by the values of @var{r}.
%
% The optional return value @var{h} provides a list of handles to the 
% the parts of the vector field (body, arrow and marker).
%
% If two output arguments are requested, then rather than plotting the 
% histogram, the polar vectors necessary to plot the histogram are 
% returned.
%
% @example
% @group
% [r, t] = rose ([2*randn(1e5,1), pi + 2 * randn(1e5,1)]);
% polar (r, t);
% @end group
% @end example
%
%
% @seealso{plot, compass, polar, hist}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003