Revision of help page for errbar function (en_US).
[scilab.git] / scilab / modules / graphics / help / en_US / 2d_plot / errbar.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="errbar">
14     <refnamediv>
15         <refname>errbar</refname>
16         <refpurpose>add vertical error bars on a 2D plot</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>errbar(x, y, em, ep)</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>x, y, em, ep</term>
27                 <listitem>
28                     <para>four matrices of the same size.</para>
29                 </listitem>
30             </varlistentry>
31         </variablelist>
32     </refsection>
33     <refsection>
34         <title>Description</title>
35         <para>
36             <function>errbar</function> adds vertical error bars on a 2D plot.
37             <varname>x</varname> and <varname>y</varname> have the same meaning
38             as in <function>plot2d</function>.
39         </para>
40         <para>
41             <literal>em(i,j)</literal> and <literal>ep(i,j)</literal> stands for
42             the error interval on the value <literal>y(i,j)</literal>:
43             <literal>[y(i,j)-em(i,j),y(i,j)+ep(i,j)]</literal>.
44         </para>
45         <para>
46             Enter the command <code>errbar()</code> to see a demo.
47         </para>
48     </refsection>
49     <refsection>
50         <title>Examples</title>
51         <programlisting role="example"><![CDATA[ 
52 t=[0:0.1:2*%pi]';
53 y=[sin(t) cos(t)]; x=[t t];
54 plot2d(x,y)
55 errbar(x,y,0.05*ones(x),0.03*ones(x))
56  ]]></programlisting>
57         <scilab:image>
58             t=[0:0.1:2*%pi]';
59             y=[sin(t) cos(t)]; x=[t t];
60             plot2d(x,y)
61             errbar(x,y,0.05*ones(x),0.03*ones(x))
62         </scilab:image>
63     </refsection>
64     <refsection role="see also">
65         <title>See Also</title>
66         <simplelist type="inline">
67             <member>
68                 <link linkend="plot2d">plot2d</link>
69             </member>
70         </simplelist>
71     </refsection>
72 </refentry>