* Bug #11664 fixed - Help page of lev had no example. 15/10915/5
Charlotte HECQUET [Wed, 20 Mar 2013 17:43:50 +0000 (18:43 +0100)]
Change-Id: Ib907d353f7e063ad6b8c3a7e77644054bac6d9f7

scilab/CHANGES_5.4.X
scilab/modules/helptools/etc/images_md5.txt
scilab/modules/helptools/images/lev_1.png [new file with mode: 0644]
scilab/modules/signal_processing/help/en_US/filters/lev.xml

index 85c79da..bb9c7c1 100644 (file)
@@ -333,6 +333,8 @@ Bug fixes
 
 * Bug #11639 fixed - Uninstall removed all scilab registry information.
 
+* Bug #11664 fixed - Help page of lev had no example.
+
 * Bug #11665 fixed - Help page of lindquist had no example.
 
 * Bug #11669 fixed - Help page of kalm and srkf functions had no example.
index 0dc29f0..4d32050 100644 (file)
@@ -767,6 +767,7 @@ legendre_1.png=ef5d177f39f62988377e88eeba509bea
 legendre_2.png=b2961924bd202893098731a631335da
 legends_1.png=311d56dc35e38fec75227aa7a7135410
 legends_2.png=b4fcf513e0a038b7b52c8627518beefe
+lev_1.png=f11db4e8008cd7f17b2aebfea2cd9193
 linear_interpn_1.png=6097d912048862430be0c7efc1cb5715
 linear_interpn_2.png=babfba25d7f0743ed8a6f6618379fba9
 lqg_1.png=f3bc1bd865c7d277b7c92e36cb668e57
diff --git a/scilab/modules/helptools/images/lev_1.png b/scilab/modules/helptools/images/lev_1.png
new file mode 100644 (file)
index 0000000..5c985ec
Binary files /dev/null and b/scilab/modules/helptools/images/lev_1.png differ
index 4072ebe..5777f28 100644 (file)
@@ -6,7 +6,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[ar,sigma2,rc]=lev(r)</synopsis>
+        <synopsis>[ar, sigma2, rc]=lev(r)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
     <refsection>
         <title>Description</title>
         <para>
-            resolve the Yule-Walker equations
-        </para>
-        <para>
-            using Levinson's algorithm.
+            This function resolves the Yule-Walker equations using Levinson's algorithm. Generally, it is used to estimate the coefficients of an autoregressive process.
         </para>
     </refsection>
+    <refsection>
+        <title>Example</title>
+        <programlisting role="Example"><![CDATA[
+b=1; //numerator
+a=[1 -0.7 0.8]; //denominator
+x=[1 zeros(1,99)]; //input=impulse
+data=filter(b,a,x); //real data
+a2=lev(data); //modelized data
+a2=a2/a2(1); //normalization
+m_data=filter(1,a2,x);
+// Compare real data and modelized data
+plot(data,"color","blue","lineStyle","none","marker","d");
+plot(m_data,"color","red","lineStyle","none","marker","d");
+]]>
+        </programlisting>
+        <scilab:image>
+            b=1;
+            a=[1 -0.7 0.8];
+            x=[1 zeros(1,99)];
+            data=filter(b,a,x);
+            a2=lev(data);
+            a2=a2/a2(1);
+            m_data=filter(1,a2,x);
+            plot(data,"color","blue","lineStyle","none","marker","d");
+            plot(m_data,"color","red","lineStyle","none","marker","d");
+        </scilab:image>
+    </refsection>
 </refentry>