Mercurial > hg > octave-lyh
annotate scripts/plot/errorbar.m @ 17059:c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
* scripts/plot/errorbar.m: Update to use new __plt_get_axis_arg__.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 24 Jul 2013 23:12:46 -0700 |
parents | 64e7bb01fce2 |
children | eaab03308c0b |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14092
diff
changeset
|
1 ## Copyright (C) 2000-2012 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 | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
3718 | 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 | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
3718 | 18 |
19 ## -*- texinfo -*- | |
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
14245
diff
changeset
|
20 ## @deftypefn {Function File} {} errorbar (@var{args}) |
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
14245
diff
changeset
|
21 ## @deftypefnx {Function File} {@var{h} =} errorbar (@var{args}) |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
22 ## Create a two-dimensional plot with errorbars. |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
23 ## |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
24 ## Many different combinations of arguments are possible. The simplest |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
25 ## form is |
3718 | 26 ## |
27 ## @example | |
28 ## errorbar (@var{y}, @var{ey}) | |
29 ## @end example | |
30 ## | |
31 ## @noindent | |
32 ## where the first argument is taken as the set of @var{y} coordinates | |
33 ## 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
|
34 ## @var{y} values. @var{x} coordinates are taken to be the indices |
3718 | 35 ## of the elements, starting with 1. |
36 ## | |
37 ## If more than two arguments are given, they are interpreted as | |
38 ## | |
39 ## @example | |
6701 | 40 ## errorbar (@var{x}, @var{y}, @dots{}, @var{fmt}, @dots{}) |
3718 | 41 ## @end example |
42 ## | |
43 ## @noindent | |
44 ## 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
|
45 ## 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
|
46 ## depending on the plot type. Any number of argument sets may appear, |
3718 | 47 ## as long as they are separated with a format string @var{fmt}. |
48 ## | |
49 ## 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
|
50 ## having same dimensions. The columns of @var{y} are plotted versus the |
3718 | 51 ## corresponding columns of @var{x} and errorbars are drawn from |
52 ## the corresponding columns of error parameters. | |
53 ## | |
6895 | 54 ## If @var{fmt} is missing, yerrorbars ("~") plot style is assumed. |
55 ## | |
3718 | 56 ## If the @var{fmt} argument is supplied, it is interpreted as in |
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
57 ## normal plots. In addition, @var{fmt} may include an errorbar style |
11575
d6619410e79c
Spellcheck documentation before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11563
diff
changeset
|
58 ## which must precede the line and marker format. The following plot |
11099
65b240770880
Fix normal line and marker types for errorplots.
Ben Abbott <bpabbott@mac.com>
parents:
10846
diff
changeset
|
59 ## styles are supported by errorbar: |
3718 | 60 ## |
61 ## @table @samp | |
62 ## @item ~ | |
63 ## Set yerrorbars plot style (default). | |
64 ## | |
65 ## @item > | |
66 ## Set xerrorbars plot style. | |
67 ## | |
68 ## @item ~> | |
69 ## Set xyerrorbars plot style. | |
70 ## | |
71 ## @item # | |
72 ## Set boxes plot style. | |
73 ## | |
74 ## @item #~ | |
75 ## Set boxerrorbars plot style. | |
76 ## | |
77 ## @item #~> | |
78 ## Set boxxyerrorbars plot style. | |
79 ## @end table | |
80 ## | |
81 ## Examples: | |
82 ## | |
83 ## @example | |
6895 | 84 ## errorbar (@var{x}, @var{y}, @var{ex}, ">") |
3718 | 85 ## @end example |
86 ## | |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10591
diff
changeset
|
87 ## @noindent |
6895 | 88 ## produces an xerrorbar plot of @var{y} versus @var{x} with @var{x} |
89 ## errorbars drawn from @var{x}-@var{ex} to @var{x}+@var{ex}. | |
3718 | 90 ## |
91 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
92 ## @group |
6895 | 93 ## errorbar (@var{x}, @var{y1}, @var{ey}, "~", |
94 ## @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
|
95 ## @end group |
3718 | 96 ## @end example |
97 ## | |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10591
diff
changeset
|
98 ## @noindent |
6895 | 99 ## produces yerrorbar plots with @var{y1} and @var{y2} versus @var{x}. |
3718 | 100 ## Errorbars for @var{y1} are drawn from @var{y1}-@var{ey} to |
101 ## @var{y1}+@var{ey}, errorbars for @var{y2} from @var{y2}-@var{ly} to | |
102 ## @var{y2}+@var{uy}. | |
103 ## | |
104 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
105 ## @group |
6895 | 106 ## errorbar (@var{x}, @var{y}, @var{lx}, @var{ux}, |
107 ## @var{ly}, @var{uy}, "~>") | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
108 ## @end group |
3718 | 109 ## @end example |
110 ## | |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10591
diff
changeset
|
111 ## @noindent |
6895 | 112 ## produces an xyerrorbar plot of @var{y} versus @var{x} in which |
113 ## @var{x} errorbars are drawn from @var{x}-@var{lx} to @var{x}+@var{ux} | |
114 ## and @var{y} errorbars from @var{y}-@var{ly} to @var{y}+@var{uy}. | |
115 ## @seealso{semilogxerr, semilogyerr, loglogerr} | |
3718 | 116 ## @end deftypefn |
117 | |
118 ## Created: 18.7.2000 | |
119 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi> | |
120 ## Keywords: errorbar, plotting | |
121 | |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
122 function h = errorbar (varargin) |
3718 | 123 |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
124 [hax, varargin] = __plt_get_axis_arg__ ("errorbar", varargin{:}); |
7216 | 125 |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
126 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure")); |
7207 | 127 unwind_protect |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
128 hax = newplot (hax); |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
129 |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
130 htmp = __errcomm__ ("errorbar", hax, varargin{:}); |
7510
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
131 |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
132 unwind_protect_cleanup |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
133 if (! isempty (oldfig)) |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
134 set (0, "currentfigure", oldfig); |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
135 endif |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
136 end_unwind_protect |
7510
f3e6ada67d9e
improve handling line style for errorbar plots
John W. Eaton <jwe@octave.org>
parents:
7216
diff
changeset
|
137 |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
138 if (nargout > 0) |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
139 h = htmp; |
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
140 endif |
3718 | 141 |
142 endfunction | |
8258 | 143 |
144 | |
145 %!demo | |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
146 %! clf; |
11363
a0dfd7e8e3e2
Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents:
11099
diff
changeset
|
147 %! rand_1x11_data1 = [0.82712, 0.50325, 0.35613, 0.77089, 0.20474, 0.69160, 0.30858, 0.88225, 0.35187, 0.14168, 0.54270]; |
a0dfd7e8e3e2
Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents:
11099
diff
changeset
|
148 %! rand_1x11_data2 = [0.506375, 0.330106, 0.017982, 0.859270, 0.140641, 0.327839, 0.275886, 0.162453, 0.807592, 0.318509, 0.921112]; |
a0dfd7e8e3e2
Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents:
11099
diff
changeset
|
149 %! errorbar (0:10, rand_1x11_data1, 0.25*rand_1x11_data2); |
a0dfd7e8e3e2
Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents:
11099
diff
changeset
|
150 |
a0dfd7e8e3e2
Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents:
11099
diff
changeset
|
151 %!demo |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
152 %! clf; |
11363
a0dfd7e8e3e2
Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents:
11099
diff
changeset
|
153 %! rand_1x11_data3 = [0.423650, 0.142331, 0.213195, 0.129301, 0.975891, 0.012872, 0.635327, 0.338829, 0.764997, 0.401798, 0.551850]; |
a0dfd7e8e3e2
Assign data used in demo plots for reproducibility between runs
Rik <octave@nomad.inbox5.com>
parents:
11099
diff
changeset
|
154 %! rand_1x11_data4 = [0.682566, 0.456342, 0.132390, 0.341292, 0.108633, 0.601553, 0.040455, 0.146665, 0.309187, 0.586291, 0.540149]; |
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
155 %! errorbar (0:10, rand_1x11_data3, rand_1x11_data4, '>'); |
10589 | 156 |
157 %!demo | |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
158 %! clf; |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
159 %! x = 0:0.5:2*pi; |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
160 %! err = x/30; |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
161 %! y1 = sin (x); |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
162 %! y2 = cos (x); |
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
163 %! hg = errorbar (x, y1, err, '~', x, y2, err, '>'); |
10589 | 164 |
165 %!demo | |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
166 %! clf; |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
167 %! x = 0:0.5:2*pi; |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
168 %! err = x/30; |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
169 %! y1 = sin (x); |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
170 %! y2 = cos (x); |
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
171 %! hg = errorbar (x, y1, err, err, '#r', x, y2, err, err, '#~'); |
10589 | 172 |
173 %!demo | |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
174 %! clf; |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
175 %! x = 0:0.5:2*pi; |
17059
c935a0db31c6
errorbar.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
16814
diff
changeset
|
176 %! err = x/30; |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
177 %! y1 = sin (x); |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
178 %! y2 = cos (x); |
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
179 %! hg = errorbar (x, y1, err, err, err, err, '~>', ... |
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
180 %! x, y2, err, err, err, err, '#~>-*'); |
10589 | 181 |