Graphics tests: fix histrogram references
[scilab.git] / scilab / modules / graphics / help / fr_FR / 2d_plot / histplot.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) 2013 - Scilab Enterprises - Paul Bignier: ajout de la sortie
5  * Copyright (C) INRIA - Serge Steer
6  *
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at
11  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
12  *
13  --><!-- This document was created with Syntext Serna Free. -->
14 <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="fr" xml:id="histplot">
15     <refnamediv>
16         <refname>histplot</refname>
17         <refpurpose>dessine un histogramme</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Séquence d'appel</title>
21         <synopsis>
22             [cf, ind] = histplot(n, data, &lt;opt_args&gt;)
23             [cf, ind] = histplot(x, data, &lt;opt_args&gt;)
24         </synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>Paramètres</title>
28         <variablelist>
29             <varlistentry>
30                 <term>n</term>
31                 <listitem>
32                     <para>entier strictement positif (nombre de classes)</para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>x</term>
37                 <listitem>
38                     <para>vecteur (strictement croissant) definissant les classes</para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>data</term>
43                 <listitem>
44                     <para>vecteur (contenant les données à  analyser)</para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>&lt;opt_args&gt;</term>
49                 <listitem>
50                     <para>
51                         Représente une séquence de la forme <literal>clé1=valeur1,
52                             clé2=valeur2
53                         </literal>
54                         ,... où <literal>clé1</literal>,
55                         <literal>clé2,...</literal> peut être n'importe quel paramètre optionnel de <link linkend="plot2d">plot2d</link>
56                         (<literal>style,strf,leg, rect,nax, logflag,frameflag, axesflag</literal>) ou encore <literal>normalization</literal>.
57                         Pour ce dernier la valeur correspondante est un scalaire booléen
58                         (la valeur par défaut étant %t).
59                     </para>
60                 </listitem>
61             </varlistentry>
62         </variablelist>
63     </refsection>
64     <refsection>
65         <title>Description</title>
66         <para>
67             Cette fonction dessine un histogramme des données contenues dans le vecteur <literal>data</literal>
68             en utilisant les classes <literal>x</literal>. Quand le nombre de classes <literal>n</literal> est fourni
69             au lieu de <literal>x</literal>, celles-ci sont définies de manière équirépartie et telles que
70             <emphasis>x(1) = min(data) &lt;  x(2) = x(1) + dx  &lt;  ...  &lt; x(n+1) = max(data)</emphasis>
71             avec <emphasis>dx = (x(n+1)-x(1))/n</emphasis>.
72         </para>
73         <para> Les classes sont définies par C1 = [x(1), x(2)] puis  Ci = ] x(i), x(i+1)] pour i = 2,3,...,n.
74             En notant Nmax le nombre total de données (Nmax = length(data)) et Ni le nombre de données
75             se situant dans Ci, la valeur de l'histogramme pour x appartenant à  Ci
76             est égale à  <emphasis>Ni/(Nmax (x(i+1)-x(i)))</emphasis> quand <literal>normalization</literal> est vrai
77             (comportement par défaut) et sinon elle vaut simplement <emphasis>Ni</emphasis>. Quand l'histogramme
78             est normalisé il vérifie la propriété suivante :
79         </para>
80         <para>
81             <latex style="display"><![CDATA[
82     \int_{x(1)}^{x(n+1)}h(x)\,\mathrm{d}x=1
83     ]]></latex>
84         </para>
85         <para>
86             quand <emphasis>x(1)&lt;=min(data)</emphasis> et <emphasis>max(data) &lt;= x(n+1)</emphasis>
87         </para>
88         <para>
89             N'importe quel paramètre optionnel de <link linkend="plot2d">plot2d</link> peut être passé à  histplot ; par exemple
90             pour dessiner votre histogramme avec la couleur numéro 2 (du bleu si vous utilisez la carte
91             des couleurs standard) tout en restreignant le dessin au le rectangle [-3,3]x[0,0.5],
92             vous pouvez utiliser <literal>histplot(n,data, style=2, rect=[-3,0,3,0.5])</literal>.
93         </para>
94         <para>
95             La commande <literal>histplot()</literal> sans argument montre un example.
96         </para>
97     </refsection>
98     <refsection>
99         <title>Exemples</title>
100         <simplelist>
101             <member>
102                 Exemple #1: variations sur l'histogramme d'un échantillon gaussien N(0,1)
103                 <programlisting role="example"><![CDATA[
104 d=rand(1,10000,'normal');
105 clf();histplot(20,d)
106 clf();histplot(20,d,normalization=%f)
107 clf();histplot(20,d,leg='rand(1,10000,''normal'')',style=5)
108 clf();histplot(20,d,leg='rand(1,10000,''normal'')',style=16, rect=[-3,0,3,0.5]);
109 ]]></programlisting>
110                 <scilab:image>
111                     d=rand(1,10000,'normal');
112                     clf();histplot(20,d,leg='rand(1,10000,''normal'')',style=16, rect=[-3,0,3,0.5]);
113                 </scilab:image>
114             </member>
115             <member>
116                 Exemple #2: histogramme d'un échantillon de loi binomiale B(6,0.5)
117                 <programlisting role="example"><![CDATA[
118 d = grand(1000,1,"bin", 6, 0.5);
119 c = linspace(-0.5,6.5,8);
120 clf()
121 subplot(2,1,1)
122 [cf, ind] = histplot(c, d, style=2)
123 xtitle("l''histogramme normalisé")
124 subplot(2,1,2)
125 [cf, ind] = histplot(c, d, normalization=%f, style=5)
126 xtitle("l''histogramme non normalisé")
127 ]]></programlisting>
128                 <scilab:image localized="true">
129                     d = grand(1000,1,"bin", 6, 0.5);
130                     c = linspace(-0.5,6.5,8);
131                     clf()
132                     subplot(2,1,1)
133                     histplot(c, d, style=2)
134                     xtitle("l''histogramme normalisé")
135                     subplot(2,1,2)
136                     histplot(c, d, normalization=%f, style=5)
137                     xtitle("l''histogramme non normalisé")
138                 </scilab:image>
139             </member>
140             <member>
141                 Exemple #3: histogramme d'un échantillon de loi exponentielle E(lambda)
142                 <programlisting role="example"><![CDATA[
143 lambda = 2;
144 X = grand(100000,1,"exp", 1/lambda);
145 Xmax = max(X);
146 clf()
147 histplot(40, X, style=2)
148 x = linspace(0,max(Xmax),100)';
149 plot2d(x,lambda*exp(-lambda*x),strf="000",style=5)
150 legend(["histogramme d''un échantillon E(lambda)" "densité exacte"]);
151 ]]></programlisting>
152                 <scilab:image localized="true">
153                     lambda = 2;
154                     X = grand(100000,1,"exp", 1/lambda);
155                     Xmax = max(X);
156                     clf()
157                     histplot(40, X, style=2)
158                     x = linspace(0,max(Xmax),100)';
159                     plot2d(x,lambda*exp(-lambda*x),strf="000",style=5)
160                     legend(["histogramme d''un échantillon E(lambda)" "densité exacte"]);
161                 </scilab:image>
162             </member>
163         </simplelist>
164     </refsection>
165     <refsection role="see also">
166         <title>Voir aussi</title>
167         <simplelist type="inline">
168             <member>
169                 <link linkend="histc">histc</link>
170             </member>
171             <member>
172                 <link linkend="hist3d">hist3d</link>
173             </member>
174             <member>
175                 <link linkend="plot2d">plot2d</link>
176             </member>
177             <member>
178                 <link linkend="bar">bar</link>
179             </member>
180             <member>
181                 <link linkend="dsearch">dsearch</link>
182             </member>
183         </simplelist>
184     </refsection>
185 </refentry>