summaryrefslogtreecommitdiff
path: root/help/en_US/decimate.xml
blob: 30440dd8c679b23c00716b1740de33e88bd1550d (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
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="decimate" 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>decimate</refname>
    <refpurpose>Decimation — decrease sample rate by integer factor</refpurpose>
  </refnamediv>

<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   y = decimate(x,q)
   y = decimate(x,q,n)
   y = decimate (…, "fir")
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>x:</term>
      <listitem><para> input sequence</para></listitem></varlistentry>
   <varlistentry><term>q:</term>
      <listitem><para> reduction factor </para></listitem></varlistentry>
   <varlistentry><term>n:</term>
      <listitem><para> filter order</para></listitem></varlistentry>
   <varlistentry><term>ftype:</term>
      <listitem><para> filter type: iir or fir</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
y = decimate(x,q) reduces the sample rate of x, the input signal, by a factor of q.
By default, an order n Chebyshev type I filter is used. If n is not specified, the default is 8.
If the optional argument "fir" is given, an order n FIR filter is used, with a default order of 30 if n is not given.
Note that q must be an integer for this rate change method.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
t = 0:.00025:1;
x = sin(2*%pi*30*t) + sin(2*%pi*60*t);
y = decimate(x,4);
subplot(211)
plot2d3((0:120),x(1:121))
subplot(212)
plot2d3((0:30),y(1:31))
   ]]></programlisting>

</refsection>


<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>Ayush Baid</member>
   </simplelist>
</refsection>


</refentry>