Re-indent XML Files
[scilab.git] / scilab / modules / fftw / help / en_US / fftw.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2007 - INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="fftw">
14   <info>
15     <pubdate>October 2006</pubdate>
16   </info>
17   <refnamediv>
18     <refname>fftw</refname>
19     <refpurpose>fast fourier transform that use fftw library</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>[y]=fftw(x)
24 [y]=fftw(x,sign)
25 [y]=fftw(x,sign,dim,incr)
26 [y]=fftw(x,sign,[dim1 dim2 ...dimN],[incr1 incr2 ...incrN])</synopsis>
27   </refsynopsisdiv>
28   <refsection>
29     <title>Parameters</title>
30     <variablelist>
31       <varlistentry>
32         <term>y,x</term>
33         <listitem>
34           <para>matrix/vector of real/complex data. Input/output data to be transformed.</para>
35         </listitem>
36       </varlistentry>
37       <varlistentry>
38         <term>sign</term>
39         <listitem>
40           <para>Integer. 1 or -1. Set direct or inverse transform.</para>
41         </listitem>
42       </varlistentry>
43       <varlistentry>
44         <term>dim</term>
45         <listitem>
46           <para>integer. Set the dimension (the length) of the transform.</para>
47         </listitem>
48       </varlistentry>
49       <varlistentry>
50         <term>incr</term>
51         <listitem>
52           <para>integer. Set the stride (the span) of the transform.</para>
53         </listitem>
54       </varlistentry>
55     </variablelist>
56   </refsection>
57   <refsection>
58     <title>Description</title>
59     <para>
60     This function realizes direct/inverse Discrete Fourier Transform (DFT) with the help of the FFTW library.
61     </para>
62     <para>
63     One can compute vector, 2D, M-D transform with this function.
64     </para>
65     <para>
66     For more details of fftw syntax see <link xlink:href="fft.htm"><literal>fft</literal></link> scilab function.
67     </para>
68     <para>
69     For more details about FFTW library see FFTW Web site :<link xlink:href="http://www.fftw.org"><literal> http://www.fftw.org </literal>.</link>
70     </para>
71     <para>
72     Remark : fftw function automaticaly stores his last parameters in memory to re-use it in a second time.
73     </para>
74     <para>
75     This results on a time computation improvement when consecutives calls (with same parameters) are used.
76     </para>
77   </refsection>
78   <refsection>
79     <title>Examples</title>
80     <programlisting role="example"><![CDATA[
81   
82   //simple vector direct transform
83   a = rand(50,1)+%i*rand(50,1);
84   y = fftw(a);
85   y = fftw(a,-1);
86   //inverse transform
87   b = fftw(y,1);
88
89   //2D transform
90   a = rand(512,512)+%i*rand(512,512);
91   y = fftw(a);
92
93   //M-D transform -old calling sequence-
94   a = rand(120,1);
95   y = a;
96   dim=[5 6 4];incr=[1 5 30];
97   for i=1:3
98     y = fftw(y,-1,dim(i),incr(i));
99   end
100
101   //M-D transform -new calling sequence-
102   //More efficient than old
103   y = fftw(a,-1,[5 6 4],[1 5 30]);
104   b = fftw(y,1,[5 6 4],[1 5 30]);
105   
106   ]]></programlisting>
107   </refsection>
108   <refsection>
109     <title>See Also</title>
110     <simplelist type="inline">
111       <member>
112         <link linkend="fftw_flags">fftw_flags</link>
113       </member>
114       <member>
115         <link linkend="get_fftw_wisdom">get_fftw_wisdom</link>
116       </member>
117       <member>
118         <link linkend="set_fftw_wisdom">set_fftw_wisdom</link>
119       </member>
120       <member>
121         <link linkend="fftw_forget_wisdom">fftw_forget_wisdom</link>
122       </member>
123     </simplelist>
124   </refsection>
125   <refsection>
126     <title>Bibliography</title>
127     <para>
128     Matteo Frigo and Steven G. Johnson, "FFTW Manual fo version 3.1.2" June 2006. Available : http://www.fftw.org
129     </para>
130   </refsection>
131 </refentry>