diff options
| author | Sunil Shetye | 2018-07-25 17:11:09 +0530 |
|---|---|---|
| committer | Sunil Shetye | 2018-07-26 23:50:17 +0530 |
| commit | 1251f70aa3442736ce6fd9c4fb7fbce412af5a52 (patch) | |
| tree | 360311ffaf6151c5066439f481e8ac38cfd047b9 /help/en_US/decimate.xml | |
| parent | 9ca7882cee16ad48b18df989e8300c697010e55a (diff) | |
| download | FOSSEE-Signal-Processing-Toolbox-1251f70aa3442736ce6fd9c4fb7fbce412af5a52.tar.gz FOSSEE-Signal-Processing-Toolbox-1251f70aa3442736ce6fd9c4fb7fbce412af5a52.tar.bz2 FOSSEE-Signal-Processing-Toolbox-1251f70aa3442736ce6fd9c4fb7fbce412af5a52.zip | |
code changes by Kartik Hegde during FOSSEE Fellowship 2018
Diffstat (limited to 'help/en_US/decimate.xml')
| -rw-r--r-- | help/en_US/decimate.xml | 58 |
1 files changed, 57 insertions, 1 deletions
diff --git a/help/en_US/decimate.xml b/help/en_US/decimate.xml index bc0efe7..30440dd 100644 --- a/help/en_US/decimate.xml +++ b/help/en_US/decimate.xml @@ -17,7 +17,63 @@ <refnamediv> <refname>decimate</refname> - <refpurpose>rhs = argn(2)</refpurpose> + <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> |