summaryrefslogtreecommitdiff
path: root/help/en_US/downsample.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/downsample.xml')
-rw-r--r--help/en_US/downsample.xml40
1 files changed, 1 insertions, 39 deletions
diff --git a/help/en_US/downsample.xml b/help/en_US/downsample.xml
index bbdfcd0..3e25d21 100644
--- a/help/en_US/downsample.xml
+++ b/help/en_US/downsample.xml
@@ -17,45 +17,7 @@
<refnamediv>
<refname>downsample</refname>
- <refpurpose>This function downsamples the signal by selecting every nth element.</refpurpose>
+ <refpurpose>[nargout,nargin]=argn();</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 &lt;= phase &lt;= (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>