summaryrefslogtreecommitdiff
path: root/help/en_US/pmusic.xml
blob: d299b3a7436d11ec1195ac76ccd1b9c5aa641ce7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from pmusic.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="pmusic" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>pmusic</refname>
    <refpurpose>Psuedospectrum using MUSIC algorithm</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   [S,w] = pmusic(x,p)
   [S,w] = pmusic(x,p,w)
   [S,w] = pmusic(x,p,nfft)
   [S,w] = pmusic(x,p,nfft,fs)
   [S,w] = pmusic(x,p,f,fs)
   [S,f] = pmusic(...,'corr')
   [S,f] = pmusic(x,p,nfft,fs,nwin,noverlap)
   [...] = pmusic(...,freqrange)
   [...,v,e] = pmusic(...)
   
   Parameters:
   x - int|double - vector|matrix
   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)
   p - int|double - scalar|vector
   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.
   w - int|double - vector
   w is the vector of normalized frequencies over which the
   pseuspectrogram is to be computed.
   nfft - int - scalar (Default = 256)
   Length of the fft used to compute pseudospectrum. The length of S
   (and hence w/f) depends on the type of values in x and nfft.
   If x is real, length of s is (nfft/2 + 1) {Range of w = [0, pi]} if
   nfft is even and (nfft+1)/2 {Range of w = [0, pi)} otherwise.
   If x is complex, length of s is nfft.
   fs - int|double - scalar (Default = 1)
   Sampling rate. Used to convert the normalized frequencies (w) to
   actual values (f) and vice-versa.
   nwin - int|double - scalar (int only)|vector (Default = 2*p(1))
   If nwin is scalar, it is the length of the rectangular window.
   Otherwise, the vector input is considered as the window coefficients.
   Not used if 'corr' flag present.
   If x is a vector, windowing not done in nwin in scalar. If x is a
   matrix,
   noverlap - int - scalar (Default = nwin-1)
   number of points by which successive windows overlap. noverlap not
   used if x is a matrix
   freqrange - string
   The range of frequencies over which the pseudospetrogram is
   computed. Three possible values - 'onesided', 'twosided', 'centered'
   'corr' flag
   Presence indicates that the primary input x is actually a
   correlation matrix
   
   Examples:
   TODO:
   
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="pburg">| peig | periodogram | pmtm | prony | pwelch | rooteig | rootmusic</link></member>
   </simplelist>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>Ayush Baid</member>
   <member>References</member>
   <member>[1] Petre Stoica and Randolph Moses, Introduction To Spectral</member>
   <member>Analysis, Prentice-Hall, 1997, pg. 15</member>
   <member>[2] S. J. Orfanidis, Optimum Signal Processing. An Introduction.</member>
   <member>2nd Ed., Macmillan, 1988.</member>
   </simplelist>
</refsection>
</refentry>