blob: bbdfcd0ad67f9ab95cb3f719f9e07416434d0919 (
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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
*
* This help file was generated from downsample.sci using help_from_sci().
*
-->
<refentry version="5.0-subset Scilab" xml:id="downsample" 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>downsample</refname>
<refpurpose>This function downsamples the signal by selecting every nth element.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
y = downsample (x, n)
y = downsample (x, n, phase)
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry><term>x:</term>
<listitem><para> scalar, vector or matrix of real or complex numbers</para></listitem></varlistentry>
<varlistentry><term>n:</term>
<listitem><para> real number or vector</para></listitem></varlistentry>
<varlistentry><term>phase:</term>
<listitem><para> integer value, 0 <= phase <= (n - 1), default value 0, or logical</para></listitem></varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
This is an Octave function.
This function downsamples the signal by selecting every nth element supplied as parameter 2. If x is a matrix, the function downsamples every column.
If the phase is specified, every nth element is selected starting from the sample phase. The default phase is 0.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
downsample([1,2,4],2)
ans =
1. 4.
]]></programlisting>
</refsection>
</refentry>
|
