[doc] misc. fix & improvements
[scilab.git] / scilab / modules / signal_processing / help / ja_JP / 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="ja_JP" xml:id="convol2d">
9     <refnamediv>
10         <refname>convol2d</refname>
11         <refpurpose>離散 2-D 畳み込み, fftを使用. </refpurpose>
12     </refnamediv>
13     <refsynopsisdiv>
14         <title>呼び出し手順</title>
15         <synopsis>C = convol2d(A,B)</synopsis>
16     </refsynopsisdiv>
17     <refsection>
18         <title>パラメータ</title>
19         <variablelist>
20             <varlistentry>
21                 <term>A</term>
22                 <listitem>
23                     <para>
24                         実数または複素数二次元配列.
25                     </para>
26                 </listitem>
27             </varlistentry>
28             <varlistentry>
29                 <term>B</term>
30                 <listitem>
31                     <para>
32                         実数または複素数二次元配列.
33                     </para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>C</term>
38                 <listitem>
39                     <para>
40                         実数または複素数二次元配列.
41                     </para>
42                 </listitem>
43             </varlistentry>
44         </variablelist>
45     </refsection>
46     <refsection>
47         <title>説明</title>
48         <para>
49             <literal>convol2d</literal> は
50             完全な二次元離散畳み込みを計算するためにfftを使用します.
51             結果 <varname>C</varname> の次元は
52             <literal>size(A)+size(B)-1</literal>で指定されます.
53             <varname>B</varname>の中心要素の添字は
54             <literal>floor((size(B)+1)/2)</literal>で定義されます.
55         </para>
56     </refsection>
57     <refsection>
58         <title>例</title>
59         <programlisting role="example"><![CDATA[
60 s = [1 2 1; 0 0 0; -1 -2 -1] // Sobel horizontal edge kernel
61 A = zeros(10,10); A(3:7,3:7) = 1
62 C = convol2d(s, A);
63 clean(C)
64     ]]></programlisting>
65     <screen><![CDATA[
66 --> s = [1 2 1; 0 0 0; -1 -2 -1] // Sobel horizontal edge kernel
67  s  =
68    1.   2.   1.
69    0.   0.   0.
70   -1.  -2.  -1.
71
72 --> A = zeros(10,10); A(3:7,3:7) = 1
73  A  =
74    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
75    0.   0.   0.   0.   0.   0.   0.   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.   1.   1.   1.   1.   1.   0.   0.   0.
80    0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
81    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
82    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
83    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
84
85 --> C = convol2d(s, A);
86 --> clean(C)
87  ans  =
88    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
89    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
90    0.   0.   1.   3.   4.   4.   4.   3.   1.   0.   0.   0.
91    0.   0.   1.   3.   4.   4.   4.   3.   1.   0.   0.   0.
92    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
93    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
94    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
95    0.   0.  -1.  -3.  -4.  -4.  -4.  -3.  -1.   0.   0.   0.
96    0.   0.  -1.  -3.  -4.  -4.  -4.  -3.  -1.   0.   0.   0.
97    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
98    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
99    0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
100 ]]></screen>
101     </refsection>
102     <refsection role="see also">
103         <title>参照</title>
104         <simplelist type="inline">
105             <member>
106                 <link linkend="conv2">conv2</link>
107             </member>
108             <member>
109                 <link linkend="conv">conv</link>
110             </member>
111             <member>
112                 <link linkend="convol">convol</link>
113             </member>
114             <member>
115                 <link linkend="real">real</link>
116             </member>
117             <member>
118                 <link linkend="clean">clean</link>
119             </member>
120         </simplelist>
121     </refsection>
122     <refsection>
123         <title>履歴</title>
124         <revhistory>
125             <revision>
126                 <revnumber>5.4.0</revnumber>
127                 <revremark>関数convol2dが導入されました.</revremark>
128             </revision>
129         </revhistory>
130     </refsection>
131 </refentry>