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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
*
* This help file was generated from sgolayfilt.sci using help_from_sci().
*
-->
<refentry version="5.0-subset Scilab" xml:id="sgolayfilt" 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>sgolayfilt</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
y = sgolayfilt (x)
y = sgolayfilt (x, p)
y = sgolayfilt (x, p, n)
y = sgolayfilt (x, p, n, m)
y = sgolayfilt (x, p, n, m, ts)
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry><term>x:</term>
<listitem><para> vector or matrix of real or complex numbers</para></listitem></varlistentry>
<varlistentry><term>p:</term>
<listitem><para> polynomial order, real number less than n, default value 3</para></listitem></varlistentry>
<varlistentry><term>n:</term>
<listitem><para> integer, odd number greater than p</para></listitem></varlistentry>
<varlistentry><term>m:</term>
<listitem><para> vector of real positive valued numbers, length n</para></listitem></varlistentry>
<varlistentry><term>ts:</term>
<listitem><para> real number, default value 1</para></listitem></varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<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.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
sgolayfilt([1;2;i;4;7], 0.3, 3, 0, 0)
ans =
1.0000 + 0.3333i
1.0000 + 0.3333i
2.0000 + 0.3333i
3.6667 + 0.3333i
3.6667 + 0.3333i
This function is being called from Octave
]]></programlisting>
</refsection>
</refentry>
|
