summaryrefslogtreecommitdiff
path: root/help/en_US/armcov.xml
diff options
context:
space:
mode:
authorSunil Shetye2018-07-25 17:11:09 +0530
committerSunil Shetye2018-07-26 23:50:17 +0530
commit1251f70aa3442736ce6fd9c4fb7fbce412af5a52 (patch)
tree360311ffaf6151c5066439f481e8ac38cfd047b9 /help/en_US/armcov.xml
parent9ca7882cee16ad48b18df989e8300c697010e55a (diff)
downloadFOSSEE-Signal-Processing-Toolbox-1251f70aa3442736ce6fd9c4fb7fbce412af5a52.tar.gz
FOSSEE-Signal-Processing-Toolbox-1251f70aa3442736ce6fd9c4fb7fbce412af5a52.tar.bz2
FOSSEE-Signal-Processing-Toolbox-1251f70aa3442736ce6fd9c4fb7fbce412af5a52.zip
code changes by Kartik Hegde during FOSSEE Fellowship 2018
Diffstat (limited to 'help/en_US/armcov.xml')
-rw-r--r--help/en_US/armcov.xml41
1 files changed, 40 insertions, 1 deletions
diff --git a/help/en_US/armcov.xml b/help/en_US/armcov.xml
index 62e33b7..79ed57c 100644
--- a/help/en_US/armcov.xml
+++ b/help/en_US/armcov.xml
@@ -17,7 +17,46 @@
<refnamediv>
<refname>armcov</refname>
- <refpurpose></refpurpose>
+ <refpurpose>This function uses the modified covariance method to fit a pth-order autoregressive (AR) model to the input signal x </refpurpose>
</refnamediv>
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ a=armcov(x,p)
+ [a,e] = armcov(x,p)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>x:</term>
+ <listitem><para> input signal</para></listitem></varlistentry>
+ <varlistentry><term>p:</term>
+ <listitem><para> order</para></listitem></varlistentry>
+ <varlistentry><term>a:</term>
+ <listitem><para> output of an AR system driven by white noise</para></listitem></varlistentry>
+ <varlistentry><term>e:</term>
+ <listitem><para> variance estimate</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This function uses the modified covariance method to fit a pth-order autoregressive (AR) model to the input signal x.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+A = [1 -2.7607 3.8106 -2.6535 0.9238];
+y = filter(1,A,0.2*rand(1024,1,"normal"));
+arcoeffs = armcov(y,4)
+
+ ]]></programlisting>
+
+</refsection>
</refentry>