diff options
author | shamikam | 2017-11-07 15:59:48 +0530 |
---|---|---|
committer | shamikam | 2017-11-07 15:59:48 +0530 |
commit | c0c0582462720ed597b00e116506570577614e89 (patch) | |
tree | 31dedd23698e5357b19c810b7d7a8464100ef44a /help/en_US/downsample.xml | |
download | FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.tar.gz FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.tar.bz2 FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.zip |
initial commit
Diffstat (limited to 'help/en_US/downsample.xml')
-rw-r--r-- | help/en_US/downsample.xml | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/help/en_US/downsample.xml b/help/en_US/downsample.xml new file mode 100644 index 0000000..bbdfcd0 --- /dev/null +++ b/help/en_US/downsample.xml @@ -0,0 +1,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> |