* Bug #12827 fixed - Cacsd doc: improved noisegen() 67/12367/3
Paul BIGNIER [Tue, 27 Aug 2013 15:16:26 +0000 (17:16 +0200)]
Change-Id: I8f87c6e272d5bef1ce09a5763b22bf90206646ac

scilab/CHANGES_5.5.X
scilab/modules/cacsd/help/en_US/noisegen.xml
scilab/modules/cacsd/help/fr_FR/noisegen.xml [new file with mode: 0644]

index 8766656..a16725b 100644 (file)
@@ -567,6 +567,8 @@ Bug fixes
 
 * Bug #12823 fixed - In help generation (toolbox) links were not correctly handled.
 
+* Bug #12827 fixed - Cacsd doc: noisgen() improved.
+
 * Bug #12830 fixed - In SciNotes, it was not possible to replace from the caret position.
 
 * Bug #12831 fixed - In SciNotes toolbar, there was no button to open code navigator.
index 95eb8be..1e520e1 100644 (file)
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * Copyright (C) INRIA - 
- * 
+ * Copyright (C) INRIA -
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
  *
  -->
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>b=noisegen(pas,Tmax,sig)</synopsis>
+        <synopsis>b = noisegen(pas, Tmax, sig)</synopsis>
     </refsynopsisdiv>
     <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>pas</term>
+                <listitem>
+                    <para>real scalar, the time increment</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Tmax</term>
+                <listitem>
+                    <para>real scalar, the final time of the interval of noise generation</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>sig</term>
+                <listitem>
+                    <para>real scalar, the standard deviation of the noise</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
         <title>Description</title>
         <para>
-            generates a Scilab function <literal>[b]=Noise(t)</literal>
-            where <literal>Noise(t)</literal> is a piecewise constant function 
-            ( constant on  <literal>[k*pas,(k+1)*pas]</literal> ). The value on each constant 
-            interval are random values from  i.i.d  Gaussian variables of 
-            standard deviation sig. The function is constant for <literal>t&lt;=0</literal> and 
-            <literal>t&gt;=Tmax</literal>.
+            <literal>noisegen()</literal> generates a Scilab function <literal>b = Noise(t)</literal>
+            where <literal>Noise(t)</literal> is a piecewise constant function
+            (constant on  <literal>[k*pas, (k+1)*pas]</literal>). The value on each constant
+            interval are random values from i.i.d Gaussian variables of
+            standard deviation <literal>sig</literal>. The function is constant for <literal>t&lt; = 0</literal> and
+            <literal>t&gt; = Tmax</literal>.
+        </para>
+        <para>
+            <note>
+                Note: Random number generator functions such as <link linkend="rand">rand</link> and
+                <link linkend="grand">grand</link> are another alternative to generate noises
+                from a wide variety of probability distribution (see example 2 below).
+            </note>
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
-noisegen(0.5,30,1.0);
-x=-5:0.01:35;
-y=feval(x,Noise);
-plot(x,y);
+        Example #1: noisegen()
+        <programlisting role="example"><![CDATA[
+noisegen(0.5, 30, 1.0);
+x = -5:0.01:35;
+y = feval(x, Noise);
+plot(x, y);
  ]]></programlisting>
         <scilab:image>
-            noisegen(0.5,30,1.0);
-            x=-5:0.01:35;
-            y=feval(x,Noise);
-            plot(x,y);
+            noisegen(0.5, 30, 1.0);
+            x = -5:0.01:35;
+            y = feval(x, Noise);
+            plot(x, y);
         </scilab:image>
+        Example #2: rand()
+        <programlisting role="example"><![CDATA[
+// Plot a zero mean gaussian white noise with the variance 1.
+// To use a different variance, multiply rand() by the square root of the variance.
+t = 0:.5:30;
+sig = 1; // Standard deviation of the white gaussian noise
+noise = sig*rand(t, "normal");
+plot2d2(t, noise)
+ ]]></programlisting>
+        <scilab:image>
+            t = 0:.5:30;
+            sig = 1;
+            noise = sig*rand(t, "normal");
+            plot2d2(t, noise)
+        </scilab:image>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="rand">rand</link>
+            </member>
+            <member>
+                <link linkend="grand">grand</link>
+            </member>
+        </simplelist>
     </refsection>
 </refentry>
diff --git a/scilab/modules/cacsd/help/fr_FR/noisegen.xml b/scilab/modules/cacsd/help/fr_FR/noisegen.xml
new file mode 100644 (file)
index 0000000..a91b016
--- /dev/null
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Paul Bignier
+ *
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at
+ * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
+ *
+ -->
+<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="noisegen">
+    <refnamediv>
+        <refname>noisegen</refname>
+        <refpurpose>génération de bruit</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Séquence d'appel</title>
+        <synopsis>b = noisegen(pas, Tmax, sig)</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Paramètres</title>
+        <variablelist>
+            <varlistentry>
+                <term>pas</term>
+                <listitem>
+                    <para>scalaire réel, le pas de temps</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Tmax</term>
+                <listitem>
+                    <para>scalaire réel, le temps final de l'intervalle de génération</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>sig</term>
+                <listitem>
+                    <para>scalaire réel, l'écart-type du bruit</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+       <refsection>
+        <title>Description</title>
+        <para>
+                       <literal>noisegen()</literal> génère une fonction Scilab <literal>b = Noise(t)</literal>
+            où <literal>Noise(t)</literal> est une fonction constante par morceaux
+            (constante sur  <literal>[k*pas, (k+1)*pas]</literal>). Les valeurs de chaque intervalle
+            constant sont aléatoires, i.i.d Gaussiennes à écart-type <literal>sig</literal>.
+            La fonction est constante à <literal>t&lt; = 0</literal> et
+            <literal>t&gt; = Tmax</literal>.
+        </para>
+        <para>
+            <note>
+            Remarque: des fonctions de génération aléatoires telles que <link linkend="rand">rand</link> et
+                       <link linkend="grand">grand</link> sont une alternative à la génération de bruit
+                       contenant un large panel de lois de distribution(voir exemple 2 ce-dessous).
+            </note>
+        </para>
+    </refsection>
+    <refsection>
+        <title>Exemples</title>
+                       Exemple #1: noisegen()
+        <programlisting role="example"><![CDATA[
+noisegen(0.5, 30, 1.0);
+x = -5:0.01:35;
+y = feval(x, Noise);
+plot(x, y);
+ ]]></programlisting>
+        <scilab:image>
+            noisegen(0.5, 30, 1.0);
+            x = -5:0.01:35;
+            y = feval(x, Noise);
+            plot(x, y);
+        </scilab:image>
+                       Exemple #2: rand()
+                <programlisting role="example"><![CDATA[
+// Tracer un bruit blanc gaussien de moyenne nulle à variance 1.
+// Pour utiliser une variance différente, multiplier rand() par la racine carrée de la variance.
+t = 0:.5:30;
+sig = 1; // Ecart-type du bruit blanc gaussien.
+noise = sig*rand(t, "normal");
+plot2d2(t, noise)
+ ]]></programlisting>
+                <scilab:image>
+            t = 0:.5:30;
+                       sig = 1;
+                       noise = sig*rand(t, "normal");
+                       plot2d2(t, noise)
+                </scilab:image>
+    </refsection>
+    <refsection role="see also">
+        <title>Vori aussi</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="rand">rand</link>
+            </member>
+            <member>
+                <link linkend="grand">grand</link>
+                       </member>
+        </simplelist>
+    </refsection>
+</refentry>