|
4007
|
1 ## Copyright (C) 2000, 2001, 2002 Teemu Ikonen |
|
3718
|
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 2, or (at your option) |
|
|
8 ## 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, write to the Free |
|
5307
|
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
18 ## 02110-1301, USA. |
|
3718
|
19 |
|
|
20 ## -*- texinfo -*- |
|
|
21 ## @deftypefn {Function File} {} errorbar (@var{args}) |
|
|
22 ## This function produces two-dimensional plots with errorbars. Many |
|
|
23 ## different combinations of arguments are possible. The simplest form is |
|
|
24 ## |
|
|
25 ## @example |
|
|
26 ## errorbar (@var{y}, @var{ey}) |
|
|
27 ## @end example |
|
|
28 ## |
|
|
29 ## @noindent |
|
|
30 ## where the first argument is taken as the set of @var{y} coordinates |
|
|
31 ## and the second argument @var{ey} is taken as the errors of the |
|
|
32 ## @var{y} values. @var{x} coordinates are taken to be the indices |
|
|
33 ## of the elements, starting with 1. |
|
|
34 ## |
|
|
35 ## If more than two arguments are given, they are interpreted as |
|
|
36 ## |
|
|
37 ## @example |
|
|
38 ## errorbar (@var{x}, @var{y}, ..., @var{fmt} ...) |
|
|
39 ## @end example |
|
|
40 ## |
|
|
41 ## @noindent |
|
|
42 ## where after @var{x} and @var{y} there can be up to four error |
|
|
43 ## parameters such as @var{ey}, @var{ex}, @var{ly}, @var{uy} etc., |
|
|
44 ## depending on the plot type. Any number of argument sets may appear, |
|
|
45 ## as long as they are separated with a format string @var{fmt}. |
|
|
46 ## |
|
|
47 ## If @var{y} is a matrix, @var{x} and error parameters must also be matrices |
|
|
48 ## having same dimensions. The columns of @var{y} are plotted versus the |
|
|
49 ## corresponding columns of @var{x} and errorbars are drawn from |
|
|
50 ## the corresponding columns of error parameters. |
|
|
51 ## |
|
|
52 ## If @var{fmt} is missing, yerrorbars ("~") plot style |
|
|
53 ## is assumed. |
|
|
54 ## If the @var{fmt} argument is supplied, it is interpreted as in |
|
|
55 ## normal plots (See __pltopt__). In addition the following |
|
|
56 ## plot styles are supported by errorbar: |
|
|
57 ## |
|
|
58 ## @table @samp |
|
|
59 ## @item ~ |
|
|
60 ## Set yerrorbars plot style (default). |
|
|
61 ## |
|
|
62 ## @item > |
|
|
63 ## Set xerrorbars plot style. |
|
|
64 ## |
|
|
65 ## @item ~> |
|
|
66 ## Set xyerrorbars plot style. |
|
|
67 ## |
|
|
68 ## @item # |
|
|
69 ## Set boxes plot style. |
|
|
70 ## |
|
|
71 ## @item #~ |
|
|
72 ## Set boxerrorbars plot style. |
|
|
73 ## |
|
|
74 ## @item #~> |
|
|
75 ## Set boxxyerrorbars plot style. |
|
|
76 ## |
|
|
77 ## @end table |
|
|
78 ## |
|
|
79 ## Examples: |
|
|
80 ## |
|
|
81 ## @example |
|
|
82 ## errorbar(@var{x}, @var{y}, @var{ex}, ">") |
|
|
83 ## @end example |
|
|
84 ## |
|
|
85 ## xerrorbar plot of @var{y} versus @var{x} with @var{x} errorbars drawn from |
|
|
86 ## @var{x}-@var{ex} to @var{x}+@var{ex}. |
|
|
87 ## |
|
|
88 ## @example |
|
|
89 ## errorbar(@var{x}, @var{y1}, @var{ey}, "~", @var{x}, @var{y2}, @var{ly}, @var{uy}) |
|
|
90 ## @end example |
|
|
91 ## |
|
|
92 ## Two yerrorbar plots with @var{y1} and @var{y2} versus @var{x}. |
|
|
93 ## Errorbars for @var{y1} are drawn from @var{y1}-@var{ey} to |
|
|
94 ## @var{y1}+@var{ey}, errorbars for @var{y2} from @var{y2}-@var{ly} to |
|
|
95 ## @var{y2}+@var{uy}. |
|
|
96 ## |
|
|
97 ## @example |
|
|
98 ## errorbar(@var{x}, @var{y}, @var{lx}, @var{ux}, @var{ly}, @var{uy}, "~>") |
|
|
99 ## @end example |
|
|
100 ## |
|
|
101 ## xyerrorbar plot of @var{y} versus @var{x} where @var{x} errorbars |
|
|
102 ## are drawn from @var{x}-@var{lx} to @var{x}+@var{ux} and @var{y} errorbars |
|
|
103 ## from @var{y}-@var{ly} to @var{y}+@var{uy}. |
|
5642
|
104 ## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__, |
|
6448
|
105 ## bar, stairs, xlabel, ylabel, title} |
|
3718
|
106 ## @end deftypefn |
|
|
107 |
|
|
108 ## Created: 18.7.2000 |
|
|
109 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi> |
|
|
110 ## Keywords: errorbar, plotting |
|
|
111 |
|
3979
|
112 function errorbar (varargin) |
|
3718
|
113 |
|
6257
|
114 newplot (); |
|
3718
|
115 |
|
6257
|
116 ## [h, varargin] = __plt_get_axis_arg__ ("errorbar", varargin{:}); |
|
|
117 h = gca (); |
|
4007
|
118 |
|
6257
|
119 __errcomm__ ("errorbar", h, varargin{:}); |
|
3718
|
120 |
|
|
121 endfunction |
