summaryrefslogtreecommitdiff
path: root/help/en_US/rooteig.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/rooteig.xml')
-rw-r--r--help/en_US/rooteig.xml88
1 files changed, 3 insertions, 85 deletions
diff --git a/help/en_US/rooteig.xml b/help/en_US/rooteig.xml
index b8ad409..13f9f7d 100644
--- a/help/en_US/rooteig.xml
+++ b/help/en_US/rooteig.xml
@@ -24,99 +24,17 @@
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
+ w = rooteig(x,p)
[w,pow] = rooteig(x,p)
- [w,pow] = rooteig(...,fs)
+ [f,pow] = rooteig(...,fs)
[w,pow] = rooteig(...,'corr')
-
+
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
- <varlistentry><term>x:</term>
- <listitem><para> int|double - vector|matrix</para>
-<para>Input signal. In case of a matrix, each row of x represents a
- seperate observation of the signal. If 'corr' flag is specified,
- then x is the correlation matrix.
- If w is not specified in the input, it is determined by the
- algorithm. If x is real valued, then range of w is [0, pi].
- Otherwise, the range of w is [0, 2pi)</para>
-</listitem></varlistentry>
- </variablelist>
-
-<variablelist>
- <varlistentry><term>p:</term>
- <listitem><para> int|double - scalar|vector</para>
-<para>p(1) is the dimension of the signal subspace
- p(2), if specified, represents a threshold that is multiplied by
- the smallest estimated eigenvalue of the signal's correlation matrix.</para>
-
-</listitem></varlistentry>
</variablelist>
-
-<variablelist>
-<varlistentry><term>w:</term>
- <listitem><para> int|double - vector</para>
-<para>w is the vector of normalized frequencies over which the
- pseuspectrogram is to be computed.</para>
-
-</listitem></varlistentry>
-
-</variablelist>
-
-
-
-
-<variablelist>
-<varlistentry><term>fs:</term>
- <listitem><para> int|double - scalar (Default = 1)</para>
-<para>Sampling rate. Used to convert the normalized frequencies (w) to
- actual values (f) and vice-versa.</para>
-
-</listitem></varlistentry>
-
-</variablelist>
-
-
-</refsection>
-
-
-
-
-
-
-
-<refsection>
-<title>Description</title>
-[w,pow] = rooteig(x,p) estimates the frequency content in the time samples of a signal x, and returns w, a vector of frequencies in rad/sample, and the corresponding signal power in the vector pow in units of power, such as volts^2. The input signal x is specified either as:
- <para> A row or column vector representing one observation of the signal
-
- </para>
-<para>A rectangular array for which each row of x represents a separate observation of the signal (for example, each row is one output of an array of sensors, as in array processing), such that x'*x is an estimate of the correlation matrix</para>
-</refsection>
-<refsection>
- <title>Examples</title>
- <programlisting role="example"><![CDATA[
- n=0:99;
- s=exp(1*%i*%pi/2*n)+2*exp(1*%i*%pi/4*n)+exp(1*%i*%pi/3*n)+rand(1,100,"normal");
- X = corrmtx(s,12,'mod');
- [W,P] = rooteig(X,3);
- ]]></programlisting>
-</refsection>
-<refsection>
- <title>See also</title>
- <simplelist type="inline">
- <member><link linkend="corrmtx">| peig | pmusic | rootmusic</link></member>
- <member><link linkend="References">References</link></member>
- <member><link linkend="1)">Stoica, P. and R. Moses, INTRODUCTION TO SPECTRAL ANALYSIS,</link></member>
- <member><link linkend="Prentice-Hall">Prentice-Hall</link></member>
- <member><link linkend="Output">arguments</link></member>
- <member><link linkend="w">- double - vector</link></member>
- <member><link linkend="Estimated">frequencies of the complex sinusoids</link></member>
- <member><link linkend="pow">- double - vector</link></member>
- <member><link linkend="estimated">absolute value squared amplitudes of the sinusoids at</link></member>
- <member><link linkend="the">frequencies w</link></member>
- </simplelist>
</refsection>
</refentry>