diff options
Diffstat (limited to 'help/en_US/wconv.xml')
| -rw-r--r-- | help/en_US/wconv.xml | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/help/en_US/wconv.xml b/help/en_US/wconv.xml new file mode 100644 index 0000000..acbf777 --- /dev/null +++ b/help/en_US/wconv.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from wconv.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="wconv" 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>wconv</refname> + <refpurpose>Performs 1D or 2D convolution.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + y = wconv (type, x, f) + y = wconv (type, x, f, shape) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>type:</term> + <listitem><para> convolution type.</para></listitem></varlistentry> + <varlistentry><term>x:</term> + <listitem><para> Signal vector or matrix.</para></listitem></varlistentry> + <varlistentry><term>f:</term> + <listitem><para> FIR filter coefficients.</para></listitem></varlistentry> + <varlistentry><term>shape:</term> + <listitem><para> Shape.</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It performs 1D or 2D convolution between the signal x and the filter coefficients f. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +a = [1 2 3 4 5] +b = [7 8 9 10] +wconv(1,a,b) +ans = +7 22 46 80 114 106 85 50 + ]]></programlisting> +</refsection> +</refentry> |