Mercurial > hg > octave-lyh
annotate scripts/plot/errorbar.m @ 10591:eca2af8a92bc
errorbar.m: Modify demo.
author | Ben Abbott <bpabbott@mac.com> |
---|---|
date | Thu, 29 Apr 2010 08:00:42 -0400 |
parents | b6364a88de06 |
children | a4f482e66b65 |
rev | line source |
---|---|
9245 | 1 ## Copyright (C) 2000, 2001, 2002, 2004, 2005, 2006, 2007, 2008, |
2 ## 2009 Teemu Ikonen | |
3718 | 3 ## |
4 ## This file is part of Octave. | |
5 ## | |
6 ## Octave is free software; you can redistribute it and/or modify it | |
7 ## under the terms of the GNU General Public License as published by | |
7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
9 ## your option) any later version. | |
3718 | 10 ## |
11 ## Octave is distributed in the hope that it will be useful, but | |
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 ## General Public License for more details. | |
15 ## | |
16 ## You should have received a copy of the GNU General Public License | |
7016 | 17 ## along with Octave; see the file COPYING. If not, see |
18 ## <http://www.gnu.org/licenses/>. | |
3718 | 19 |
20 ## -*- texinfo -*- | |
21 ## @deftypefn {Function File} {} errorbar (@var{args}) | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
22 ## This function produces two-dimensional plots with errorbars. Many |
3718 | 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 | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
32 ## @var{y} values. @var{x} coordinates are taken to be the indices |
3718 | 33 ## of the elements, starting with 1. |
34 ## | |
35 ## If more than two arguments are given, they are interpreted as | |
36 ## | |
37 ## @example | |
6701 | 38 ## errorbar (@var{x}, @var{y}, @dots{}, @var{fmt}, @dots{}) |
3718 | 39 ## @end example |
40 ## | |
41 ## @noindent | |
42 ## where after @var{x} and @var{y} there can be up to four error | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
43 ## parameters such as @var{ey}, @var{ex}, @var{ly}, @var{uy}, etc., |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
44 ## depending on the plot type. Any number of argument sets may appear, |
3718 | 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 | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
48 ## having same dimensions. The columns of @var{y} are plotted versus the |
3718 | 49 ## corresponding columns of @var{x} and errorbars are drawn from |
50 ## the corresponding columns of error parameters. | |
51 ## | |
6895 | 52 ## If @var{fmt} is missing, yerrorbars ("~") plot style is assumed. |
53 ## | |
3718 | 54 ## If the @var{fmt} argument is supplied, it is interpreted as in |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
55 ## normal plots. In addition the following plot styles are supported by |
6895 | 56 ## errorbar: |
3718 | 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 ## @end table | |
77 ## | |
78 ## Examples: | |
79 ## | |
80 ## @example | |
6895 | 81 ## errorbar (@var{x}, @var{y}, @var{ex}, ">") |
3718 | 82 ## @end example |
83 ## | |
6895 | 84 ## produces an xerrorbar plot of @var{y} versus @var{x} with @var{x} |
85 ## errorbars drawn from @var{x}-@var{ex} to @var{x}+@var{ex}. | |
3718 | 86 ## |
87 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
88 ## @group |
6895 | 89 ## errorbar (@var{x}, @var{y1}, @var{ey}, "~", |
90 ## @var{x}, @var{y2}, @var{ly}, @var{uy}) | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
91 ## @end group |
3718 | 92 ## @end example |
93 ## | |
6895 | 94 ## produces yerrorbar plots with @var{y1} and @var{y2} versus @var{x}. |
3718 | 95 ## Errorbars for @var{y1} are drawn from @var{y1}-@var{ey} to |
96 ## @var{y1}+@var{ey}, errorbars for @var{y2} from @var{y2}-@var{ly} to | |
97 ## @var{y2}+@var{uy}. | |
98 ## | |
99 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
100 ## @group |
6895 | 101 ## errorbar (@var{x}, @var{y}, @var{lx}, @var{ux}, |
102 ## @var{ly}, @var{uy}, "~>") | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
103 ## @end group |
3718 | 104 ## @end example |
105 ## | |
6895 | 106 ## produces an xyerrorbar plot of @var{y} versus @var{x} in which |
107 ## @var{x} errorbars are drawn from @var{x}-@var{lx} to @var{x}+@var{ux} | |
108 ## and @var{y} errorbars from @var{y}-@var{ly} to @var{y}+@var{uy}. | |
109 ## @seealso{semilogxerr, semilogyerr, loglogerr} | |
3718 | 110 ## @end deftypefn |
111 | |
112 ## Created: 18.7.2000 | |
113 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi> | |
114 ## Keywords: errorbar, plotting | |
115 | |
7510
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
116 function retval = errorbar (varargin) |
3718 | 117 |
7207 | 118 [h, varargin] = __plt_get_axis_arg__ ("errorbar", varargin{:}); |
7216 | 119 |
7207 | 120 oldh = gca (); |
121 unwind_protect | |
122 axes (h); | |
123 newplot (); | |
7510
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
124 |
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
125 tmp = __errcomm__ ("errorbar", h, varargin{:}); |
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
126 |
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
127 if (nargout > 0) |
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
128 retval = tmp; |
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
129 endif |
7207 | 130 unwind_protect_cleanup |
131 axes (oldh); | |
132 end_unwind_protect | |
3718 | 133 |
134 endfunction | |
8258 | 135 |
136 %!demo | |
137 %! errorbar(0:10,rand(1,11),0.25*rand(1,11)) | |
138 | |
139 %!demo | |
140 %! errorbar(0:10,rand(1,11),rand(1,11), ">") | |
10589 | 141 |
142 %!demo | |
143 %! x = 0:0.5:2*pi; | |
144 %! err = x/100; | |
145 %! y1 = sin (x); | |
146 %! y2 = cos (x); | |
147 %! hg = errorbar (x, y1, err, "~", x, y2, err, ">"); | |
148 | |
149 %!demo | |
150 %! x = 0:0.5:2*pi; | |
151 %! err = x/100; | |
152 %! y1 = sin (x); | |
153 %! y2 = cos (x); | |
154 %! hg = errorbar (x, y1, err, err, "#", x, y2, err, err, "#~"); | |
155 | |
156 %!demo | |
157 %! x = 0:0.5:2*pi; | |
158 %! err = x/100; | |
159 %! y1 = sin (x); | |
160 %! y2 = cos (x); | |
161 %! hg = errorbar (x, y1, err, err, err, err, "~>", ... | |
162 %! x, y2, err, err, err, err, "#~>"); | |
10591 | 163 %! set (hg(2), "marker", "*") |
10589 | 164 |