summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/sgolayfilt.html
blob: 9512ea6f56dd6dd8b2ff3d23a306544be5e92394 (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
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>sgolayfilt</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="sgolay.html">&lt;&lt; sgolay</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="shanwavf.html">shanwavf &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>



    <span class="path"><a href="index.html">FOSSEE Signal Processing Toolbox</a> &gt;&gt; <a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a> &gt; sgolayfilt</span>

    <br /><br />
    <div class="refnamediv"><h1 class="refname">sgolayfilt</h1>
    <p class="refpurpose"></p></div>


<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
   <div class="synopsis"><pre><span class="default">y</span><span class="default"> = </span><span class="functionid">sgolayfilt</span><span class="default"> (</span><span class="default">x</span><span class="default">)</span>
<span class="default">y</span><span class="default"> = </span><span class="functionid">sgolayfilt</span><span class="default"> (</span><span class="default">x</span><span class="default">, </span><span class="default">p</span><span class="default">)</span>
<span class="default">y</span><span class="default"> = </span><span class="functionid">sgolayfilt</span><span class="default"> (</span><span class="default">x</span><span class="default">, </span><span class="default">p</span><span class="default">, </span><span class="default">n</span><span class="default">)</span>
<span class="default">y</span><span class="default"> = </span><span class="functionid">sgolayfilt</span><span class="default"> (</span><span class="default">x</span><span class="default">, </span><span class="default">p</span><span class="default">, </span><span class="default">n</span><span class="default">, </span><span class="default">m</span><span class="default">)</span>
<span class="default">y</span><span class="default"> = </span><span class="functionid">sgolayfilt</span><span class="default"> (</span><span class="default">x</span><span class="default">, </span><span class="default">p</span><span class="default">, </span><span class="default">n</span><span class="default">, </span><span class="default">m</span><span class="default">, </span><span class="default">ts</span><span class="default">)</span></pre></div></div>

<div class="refsection"><h3 class="title">Parameters</h3>
   <dl><dt><span class="term">x:</span>
      <dd><p class="para">vector or matrix of real or complex numbers</p></dd></dt>
   <dt><span class="term">p:</span>
      <dd><p class="para">polynomial order, real number less than n, default value 3</p></dd></dt>
   <dt><span class="term">n:</span>
      <dd><p class="para">integer, odd number greater than p</p></dd></dt>
   <dt><span class="term">m:</span>
      <dd><p class="para">vector of real positive valued numbers, length n</p></dd></dt>
   <dt><span class="term">ts:</span>
      <dd><p class="para">real number, default value 1</p></dd></dt></dl></div>

<div class="refsection"><h3 class="title">Description</h3>
   <p class="para">This function applies a Savitzky-Golay FIR smoothing filter to the data given in the vector x; if x is a matrix, this function operates
on each column.
The polynomial order p should be real, less than the size of the frame given by n.
m is a weighting vector with default value identity matrix.
ts is the dimenstion along which the filter operates. If not specified, the function operates along the first non singleton dimension.</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">sgolayfilt</span><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">;</span><span class="scilabnumber">2</span><span class="scilabdefault">;</span><span class="scilabid">i</span><span class="scilabdefault">;</span><span class="scilabnumber">4</span><span class="scilabdefault">;</span><span class="scilabnumber">7</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span> <span class="scilabnumber">0.3</span><span class="scilabdefault">,</span> <span class="scilabnumber">3</span><span class="scilabdefault">,</span> <span class="scilabnumber">0</span><span class="scilabdefault">,</span> <span class="scilabnumber">0</span><span class="scilabopenclose">)</span>
<span class="scilabid">ans</span> <span class="scilaboperator">=</span>
<span class="scilabnumber">1.0000</span> <span class="scilaboperator">+</span> <span class="scilabnumber">0.3333</span><span class="scilabid">i</span>
<span class="scilabnumber">1.0000</span> <span class="scilaboperator">+</span> <span class="scilabnumber">0.3333</span><span class="scilabid">i</span>
<span class="scilabnumber">2.0000</span> <span class="scilaboperator">+</span> <span class="scilabnumber">0.3333</span><span class="scilabid">i</span>
<span class="scilabnumber">3.6667</span> <span class="scilaboperator">+</span> <span class="scilabnumber">0.3333</span><span class="scilabid">i</span>
<span class="scilabnumber">3.6667</span> <span class="scilaboperator">+</span> <span class="scilabnumber">0.3333</span><span class="scilabid">i</span>
<span class="scilabid">This</span> <span class="scilabfkeyword">function</span> <span class="scilabid">being</span> <span class="scilabid">called</span> <span class="scilabid">from</span> <span class="scilabid">Octave</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>
    <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="sgolay.html">&lt;&lt; sgolay</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="shanwavf.html">shanwavf &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>
  </body>
</html>