Mercurial > hg > octave-lyh
annotate scripts/plot/errorbar.m @ 11341:3c7ba1e3dc21
Add missing option slice for pie and pie3
| author | Kai Habel <kai.habel@gmx.de> |
|---|---|
| date | Fri, 10 Dec 2010 19:53:06 +0100 |
| parents | 65b240770880 |
| children | a0dfd7e8e3e2 |
| 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 |
|
11099
65b240770880
Fix normal line and marker types for errorplots.
Ben Abbott <bpabbott@mac.com>
parents:
10846
diff
changeset
|
55 ## normal plots. In addition, @var{fmt} may include an errorbar style |
|
65b240770880
Fix normal line and marker types for errorplots.
Ben Abbott <bpabbott@mac.com>
parents:
10846
diff
changeset
|
56 ## which must preceed the line and marker format. The following plot |
|
65b240770880
Fix normal line and marker types for errorplots.
Ben Abbott <bpabbott@mac.com>
parents:
10846
diff
changeset
|
57 ## styles are supported by errorbar: |
| 3718 | 58 ## |
| 59 ## @table @samp | |
| 60 ## @item ~ | |
| 61 ## Set yerrorbars plot style (default). | |
| 62 ## | |
| 63 ## @item > | |
| 64 ## Set xerrorbars plot style. | |
| 65 ## | |
| 66 ## @item ~> | |
| 67 ## Set xyerrorbars plot style. | |
| 68 ## | |
| 69 ## @item # | |
| 70 ## Set boxes plot style. | |
| 71 ## | |
| 72 ## @item #~ | |
| 73 ## Set boxerrorbars plot style. | |
| 74 ## | |
| 75 ## @item #~> | |
| 76 ## Set boxxyerrorbars plot style. | |
| 77 ## @end table | |
| 78 ## | |
| 79 ## Examples: | |
| 80 ## | |
| 81 ## @example | |
| 6895 | 82 ## errorbar (@var{x}, @var{y}, @var{ex}, ">") |
| 3718 | 83 ## @end example |
| 84 ## | |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10591
diff
changeset
|
85 ## @noindent |
| 6895 | 86 ## produces an xerrorbar plot of @var{y} versus @var{x} with @var{x} |
| 87 ## errorbars drawn from @var{x}-@var{ex} to @var{x}+@var{ex}. | |
| 3718 | 88 ## |
| 89 ## @example | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
90 ## @group |
| 6895 | 91 ## errorbar (@var{x}, @var{y1}, @var{ey}, "~", |
| 92 ## @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
|
93 ## @end group |
| 3718 | 94 ## @end example |
| 95 ## | |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10591
diff
changeset
|
96 ## @noindent |
| 6895 | 97 ## produces yerrorbar plots with @var{y1} and @var{y2} versus @var{x}. |
| 3718 | 98 ## Errorbars for @var{y1} are drawn from @var{y1}-@var{ey} to |
| 99 ## @var{y1}+@var{ey}, errorbars for @var{y2} from @var{y2}-@var{ly} to | |
| 100 ## @var{y2}+@var{uy}. | |
| 101 ## | |
| 102 ## @example | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
103 ## @group |
| 6895 | 104 ## errorbar (@var{x}, @var{y}, @var{lx}, @var{ux}, |
| 105 ## @var{ly}, @var{uy}, "~>") | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
106 ## @end group |
| 3718 | 107 ## @end example |
| 108 ## | |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10591
diff
changeset
|
109 ## @noindent |
| 6895 | 110 ## produces an xyerrorbar plot of @var{y} versus @var{x} in which |
| 111 ## @var{x} errorbars are drawn from @var{x}-@var{lx} to @var{x}+@var{ux} | |
| 112 ## and @var{y} errorbars from @var{y}-@var{ly} to @var{y}+@var{uy}. | |
| 113 ## @seealso{semilogxerr, semilogyerr, loglogerr} | |
| 3718 | 114 ## @end deftypefn |
| 115 | |
| 116 ## Created: 18.7.2000 | |
| 117 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi> | |
| 118 ## Keywords: errorbar, plotting | |
| 119 | |
|
7510
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
120 function retval = errorbar (varargin) |
| 3718 | 121 |
| 7207 | 122 [h, varargin] = __plt_get_axis_arg__ ("errorbar", varargin{:}); |
| 7216 | 123 |
| 7207 | 124 oldh = gca (); |
| 125 unwind_protect | |
| 126 axes (h); | |
| 127 newplot (); | |
|
7510
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
128 |
|
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
129 tmp = __errcomm__ ("errorbar", h, varargin{:}); |
|
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
130 |
|
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
131 if (nargout > 0) |
|
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
132 retval = tmp; |
|
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
133 endif |
| 7207 | 134 unwind_protect_cleanup |
| 135 axes (oldh); | |
| 136 end_unwind_protect | |
| 3718 | 137 |
| 138 endfunction | |
| 8258 | 139 |
| 140 %!demo | |
| 141 %! errorbar(0:10,rand(1,11),0.25*rand(1,11)) | |
| 142 | |
| 143 %!demo | |
| 144 %! errorbar(0:10,rand(1,11),rand(1,11), ">") | |
| 10589 | 145 |
| 146 %!demo | |
| 147 %! x = 0:0.5:2*pi; | |
| 148 %! err = x/100; | |
| 149 %! y1 = sin (x); | |
| 150 %! y2 = cos (x); | |
| 151 %! hg = errorbar (x, y1, err, "~", x, y2, err, ">"); | |
| 152 | |
| 153 %!demo | |
| 154 %! x = 0:0.5:2*pi; | |
| 155 %! err = x/100; | |
| 156 %! y1 = sin (x); | |
| 157 %! y2 = cos (x); | |
|
11099
65b240770880
Fix normal line and marker types for errorplots.
Ben Abbott <bpabbott@mac.com>
parents:
10846
diff
changeset
|
158 %! hg = errorbar (x, y1, err, err, "#r", x, y2, err, err, "#~"); |
| 10589 | 159 |
| 160 %!demo | |
| 161 %! x = 0:0.5:2*pi; | |
| 162 %! err = x/100; | |
| 163 %! y1 = sin (x); | |
| 164 %! y2 = cos (x); | |
| 165 %! hg = errorbar (x, y1, err, err, err, err, "~>", ... | |
|
11099
65b240770880
Fix normal line and marker types for errorplots.
Ben Abbott <bpabbott@mac.com>
parents:
10846
diff
changeset
|
166 %! x, y2, err, err, err, err, "#~>-*"); |
| 10589 | 167 |