scilab/modules/signal_processing/help/en_US/correlation_convolution/convol2d.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Add some comments about XML file
   4 -->
   5 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
   6           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
   7           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
   8           xml:lang="en_US" xml:id="convol2d">
   9     <refnamediv>
  10         <refname>convol2d</refname>
  11         <refpurpose>discrete 2-D convolution, using fft. </refpurpose>
  12     </refnamediv>
  13     <refsynopsisdiv>
  14         <title>Syntax</title>
  15         <synopsis>C = convol2d(A, B)</synopsis>
  16     </refsynopsisdiv>
  17     <refsection>
  18         <title>Parameters</title>
  19         <variablelist>
  20             <varlistentry>
  21                 <term>A</term>
  22                 <listitem>
  23                     <para>
  24                         a real or complex 2-D array.
  25                     </para>
  26                 </listitem>
  27             </varlistentry>
  28             <varlistentry>
  29                 <term>B</term>
  30                 <listitem>
  31                     <para>
  32                         a real or complex 2-D array.
  33                     </para>
  34                 </listitem>
  35             </varlistentry>
  36             <varlistentry>
  37                 <term>C</term>
  38                 <listitem>
  39                     <para>
  40                         a real or complex 2-D array.
  41                     </para>
  42                 </listitem>
  43             </varlistentry>
  44         </variablelist>
  45     </refsection>
  46     <refsection>
  47         <title>Description</title>
  48         <para>
  49             <literal>convol2d</literal> uses fft to compute the full two-dimensional discrete
  50             convolution. The dimensions of the result <varname>C</varname> are given by
  51             <literal>size(A)+size(B)-1</literal>. The indices of the center element of
  52             <varname>B</varname> are defined as <literal>floor((size(B)+1)/2)</literal>.
  53         </para>
  54     </refsection>
  55     <refsection>
  56         <title>Examples</title>
  57         <programlisting role="example"><![CDATA[
  58 s = [1 2 1; 0 0 0; -1 -2 -1] // Sobel horizontal edge kernel
  59 A = zeros(10,10); A(3:7,3:7) = 1
  60 C = convol2d(s, A);
  61 clean(C)
  62     ]]></programlisting>
  63     <screen><![CDATA[
  64 --> s = [1 2 1; 0 0 0; -1 -2 -1] // Sobel horizontal edge kernel
  65  s  =
  66    1.   2.   1.
  67    0.   0.   0.
  68   -1.  -2.  -1.
  69
  70 --> A = zeros(10,10); A(3:7,3:7) = 1
  71  A  =
  72    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  73    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  74    0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
  75    0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
  76    0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
  77    0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
  78    0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
  79    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  80    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  81    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  82
  83 --> C = convol2d(s, A);
  84 --> clean(C)
  85  ans  =
  86    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  87    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  88    0.   0.   1.   3.   4.   4.   4.   3.   1.   0.   0.   0.
  89    0.   0.   1.   3.   4.   4.   4.   3.   1.   0.   0.   0.
  90    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  91    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  92    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  93    0.   0.  -1.  -3.  -4.  -4.  -4.  -3.  -1.   0.   0.   0.
  94    0.   0.  -1.  -3.  -4.  -4.  -4.  -3.  -1.   0.   0.   0.
  95    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  96    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  97    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
  98 ]]></screen>
  99     </refsection>
 100     <refsection role="see also">
 101         <title>See also</title>
 102         <simplelist type="inline">
 103             <member>
 104                 <link linkend="conv2">conv2</link>
 105             </member>
 106             <member>
 107                 <link linkend="conv">conv</link>
 108             </member>
 109             <member>
 110                 <link linkend="convol">convol</link>
 111             </member>
 112             <member>
 113                 <link linkend="real">real</link>
 114             </member>
 115             <member>
 116                 <link linkend="clean">clean</link>
 117             </member>
 118         </simplelist>
 119     </refsection>
 120     <refsection>
 121         <title>History</title>
 122         <revhistory>
 123             <revision>
 124                 <revnumber>5.4.0</revnumber>
 125                 <revremark>Function convol2d introduced.</revremark>
 126             </revision>
 127         </revhistory>
 128     </refsection>
 129 </refentry>