Home > freetb4matlab > plot > errorbar.m

errorbar

PURPOSE ^

% This function produces two-dimensional plots with errorbars. Many

SYNOPSIS ^

function retval = errorbar (varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {} errorbar (@var{args})
% This function produces two-dimensional plots with errorbars.  Many
% different combinations of arguments are possible.  The simplest form is
%
% @example
% errorbar (@var{y}, @var{ey})
% @end example
%
% @noindent
% where the first argument is taken as the set of @var{y} coordinates
% and the second argument @var{ey} is taken as the errors of the
% @var{y} values.  @var{x} coordinates are taken to be the indices
% of the elements, starting with 1.
%
% If more than two arguments are given, they are interpreted as
%
% @example
% errorbar (@var{x}, @var{y}, @dots{}, @var{fmt}, @dots{})
% @end example
%
% @noindent
% where after @var{x} and @var{y} there can be up to four error
% parameters such as @var{ey}, @var{ex}, @var{ly}, @var{uy}, etc.,
% depending on the plot type.  Any number of argument sets may appear,
% as long as they are separated with a format string @var{fmt}.
%
% If @var{y} is a matrix, @var{x} and error parameters must also be matrices
% having same dimensions.  The columns of @var{y} are plotted versus the
% corresponding columns of @var{x} and errorbars are drawn from
% the corresponding columns of error parameters.
%
% If @var{fmt} is missing, yerrorbars ('~') plot style is assumed.
%
% If the @var{fmt} argument is supplied, it is interpreted as in
% normal plots.  In addition the following plot styles are supported by
% errorbar:
%
% @table @samp
% @item ~
% Set yerrorbars plot style (default).
%
% @item >
% Set xerrorbars plot style.
%
% @item ~>
% Set xyerrorbars plot style.
%
% @item %
% Set boxes plot style.
%
% @item %!
% Set boxerrorbars plot style.
%
% @item %!>
% Set boxxyerrorbars plot style.
% @end table
%
% Examples:
%
% @example
% errorbar (@var{x}, @var{y}, @var{ex}, '>')
% @end example
%
% produces an xerrorbar plot of @var{y} versus @var{x} with @var{x}
% errorbars drawn from @var{x}-@var{ex} to @var{x}+@var{ex}.
%
% @example
% @group
% errorbar (@var{x}, @var{y1}, @var{ey}, '~',
%           @var{x}, @var{y2}, @var{ly}, @var{uy})
% @end group
% @end example
%
% produces yerrorbar plots with @var{y1} and @var{y2} versus @var{x}.
% Errorbars for @var{y1} are drawn from @var{y1}-@var{ey} to
% @var{y1}+@var{ey}, errorbars for @var{y2} from @var{y2}-@var{ly} to
% @var{y2}+@var{uy}.
%
% @example
% @group
% errorbar (@var{x}, @var{y}, @var{lx}, @var{ux},
%           @var{ly}, @var{uy}, '~>')
% @end group
% @end example
%
% produces an xyerrorbar plot of @var{y} versus @var{x} in which
% @var{x} errorbars are drawn from @var{x}-@var{lx} to @var{x}+@var{ux}
% and @var{y} errorbars from @var{y}-@var{ly} to @var{y}+@var{uy}.
% @seealso{semilogxerr, semilogyerr, loglogerr}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Fri 22-May-2009 15:13:00 by m2html © 2003