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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>peak2rms</title>
<style type="text/css" media="all">
@import url("scilab_code.css");
@import url("xml_code.css");
@import url("c_code.css");
@import url("style.css");
</style>
</head>
<body>
<div class="manualnavbar">
<table width="100%"><tr>
<td width="30%">
<span class="previous"><a href="peak2peak.html"><< peak2peak</a></span>
</td>
<td width="40%" class="center">
<span class="top"><a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a></span>
</td>
<td width="30%" class="next">
<span class="next"><a href="pei_tseng_notch.html">pei_tseng_notch >></a></span>
</td>
</tr></table>
<hr />
</div>
<span class="path"><a href="index.html">FOSSEE Signal Processing Toolbox</a> >> <a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a> > peak2rms</span>
<br /><br />
<div class="refnamediv"><h1 class="refname">peak2rms</h1>
<p class="refpurpose">This function calculates the ratio of peak magnitude to the Root Mean Square(RMS) value.</p></div>
<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
<div class="synopsis"><pre><span class="default">OUT</span><span class="default">=</span><span class="functionid">peak2rms</span><span class="default">(</span><span class="default">IN</span><span class="default">)</span>
<span class="default">OUT</span><span class="default">=</span><span class="functionid">peak2rms</span><span class="default">(</span><span class="default">IN</span><span class="default">,</span><span class="default">orientation</span><span class="default">)</span></pre></div></div>
<div class="refsection"><h3 class="title">Parameters</h3>
<dl><dt><span class="term">in:</span>
<dd><p class="para">Vector or Matrix of real or complex elements.</p></dd></dt>
<dt><span class="term">orientation:</span>
<dd><p class="para">A string with possible values "r", "c" or "m" giving the dimension along which the peak2rms value is to be calculated.</p></dd></dt>
<dt><span class="term">out:</span>
<dd><p class="para">A scalar with real value when input is a vector.When input is a matrix, out is the peak magnitude to RMS value along the orientation specified or the default one when not specified.</p></dd></dt></dl></div>
<div class="refsection"><h3 class="title">Description</h3>
<p class="para">For vector as input, the output is the ratio of peak value to the RMS value. The RMS value can be calculated by taking the square root of mean value of the squared sum of the elements.</p>
<p class="para">When a matrix is given as input the output is peak to RMS ratio in the orientation specified.
The orientation can be given as string with values "r","c" or "m".</p>
<p class="para">peak2rms(in, 1) calculates the values of ratio of peak to RMS of columns of matrix. The output in this case is a row vector with peak2rms value of each column of in.</p>
<p class="para">peak2rms(in, 2) calculates the values of ratio of peak to RMS of rows of matrix, where the output would be a column vector having peak2rms value of each row of in.</p>
<p class="para">The default orientation is chosen to be the index of first dimension of input greater than 1.Hence peak2rms(in) is equivalent to peak2rms(in, "m").</p>
<p class="para">For an N dimensional array the orientation is the index of first non singleton dimension of the array.</p>
<p class="para">If the elements of matrix are complex the absolute values are considered in the calculation of RMS value.</p>
<p class="para"></p></div>
<div class="refsection"><h3 class="title">Examples</h3>
<div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">To</span> <span class="scilabid">calculate</span> <span class="scilabid">peak2rms</span> <span class="scilabid">of</span> <span class="scilabid">a</span> <span class="scilabid">vector</span><span class="scilabspecial">:</span>
<span class="scilabid">IN</span><span class="scilaboperator">=</span><span class="scilabopenclose">[</span><span class="scilabnumber">6</span> <span class="scilabnumber">19</span> <span class="scilabnumber">10</span> <span class="scilabnumber">25</span><span class="scilabopenclose">]</span>
<span class="scilabid">OUT</span><span class="scilaboperator">=</span><span class="scilabid">peak2rms</span><span class="scilabopenclose">(</span><span class="scilabid">IN</span><span class="scilabopenclose">)</span>
<span class="scilabid">The</span> <span class="scilabid">output</span> <span class="scilabid">is</span> <span class="scilabid">OUT</span><span class="scilaboperator">=</span>
<span class="scilabnumber">1.4638501</span>
<span class="scilabnumber">1.3887301</span>
<span class="scilabnumber">1.119186</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>
<div class="refsection"><h3 class="title">Examples</h3>
<div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">To</span> <span class="scilabid">calculate</span> <span class="scilabid">peak2rms</span> <span class="scilabid">of</span> <span class="scilabid">rows</span> <span class="scilabid">of</span> <a class="scilabcommand" href="scilab://matrix">matrix</a><span class="scilabspecial">:</span>
<span class="scilabid">IN</span><span class="scilaboperator">=</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span> <span class="scilabnumber">3</span> <span class="scilabnumber">5</span><span class="scilabdefault">;</span><span class="scilabnumber">2</span> <span class="scilabnumber">4</span> <span class="scilabnumber">6</span><span class="scilabdefault">;</span><span class="scilabnumber">7</span> <span class="scilabnumber">8</span> <span class="scilabnumber">9</span><span class="scilabopenclose">]</span>
<span class="scilabid">OUT</span><span class="scilaboperator">=</span><span class="scilabid">peak2rms</span><span class="scilabopenclose">(</span><span class="scilabid">IN</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabopenclose">)</span>
<span class="scilabid">The</span> <span class="scilabid">output</span> <span class="scilabid">is</span>
<span class="scilabid">OUT</span><span class="scilaboperator">=</span> <span class="scilabnumber">1.3719887</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>
<div class="refsection"><h3 class="title">Examples</h3>
<div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">To</span> <span class="scilabid">calculate</span> <span class="scilabid">peak</span> <span class="scilabid">magnitude</span> <span class="scilabid">to</span> <span class="scilabid">RMS</span> <span class="scilabid">value</span> <span class="scilabid">of</span> <span class="scilabid">sinusoid</span><span class="scilabspecial">:</span>
<span class="scilabid">t</span><span class="scilaboperator">=</span><span class="scilabnumber">0</span><span class="scilabspecial">:</span><span class="scilabnumber">0.6</span><span class="scilabspecial">:</span><span class="scilabnumber">9</span>
<span class="scilabid">IN</span><span class="scilaboperator">=</span><a class="scilabcommand" href="scilab://cos">cos</a><span class="scilabopenclose">(</span><span class="scilabnumber">6</span><span class="scilaboperator">*</span><span class="scilabconstants">%pi</span><span class="scilaboperator">*</span><span class="scilabid">t</span><span class="scilabopenclose">)</span><span class="scilabdefault">;</span>
<span class="scilabid">OUT</span><span class="scilaboperator">=</span> <span class="scilabid">peak2rms</span><span class="scilabopenclose">(</span><span class="scilabid">IN</span><span class="scilabopenclose">)</span>
<span class="scilabid">The</span> <span class="scilabid">output</span> <span class="scilabid">is</span>
<span class="scilabid">OUT</span><span class="scilaboperator">=</span> <span class="scilabnumber">1.3719887</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>
<div class="refsection"><h3 class="title">See also</h3>
<ul class="itemizedlist"><li class="member"><a href="scilab://abs" class="link">abs</a></li>
<li class="member"><a href="scilab://mean" class="link">mean</a></li>
<li class="member"><a href="scilab://max" class="link">max</a></li>
<li class="member"><a href="scilab://sqrt" class="link">sqrt</a></li>
<li class="member"><a href="scilab://isempty" class="link">isempty</a></li></ul></div>
<div class="refsection"><h3 class="title">Authors</h3>
<ul class="itemizedlist"><li class="member">Indira Askaukar</li></ul></div>
<div class="refsection"><h3 class="title">Bibliography</h3>
<p class="para">Matlab help document.</p>
<p class="para">Modified to accept char i/p</p>
<p class="para">MOdified function to match MATLAB input arguments</p>
<p class="para">Now for calculating the values of ratio of peak to RMS of columns of matrix use peak2rms(in,1)</p>
<p class="para">And for calculates the values of ratio of peak to RMS of rows of matrix. use peak2rms(in,2)</p>
<p class="para">Updated help comments accordingly</p>
<p class="para">MOdifications done by by Debdeep Dey</p></div>
<br />
<div class="manualnavbar">
<table width="100%">
<tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
<tr>
<td width="30%">
<span class="previous"><a href="peak2peak.html"><< peak2peak</a></span>
</td>
<td width="40%" class="center">
<span class="top"><a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a></span>
</td>
<td width="30%" class="next">
<span class="next"><a href="pei_tseng_notch.html">pei_tseng_notch >></a></span>
</td>
</tr></table>
<hr />
</div>
</body>
</html>
|
