Online help : converted XML files that valid the new scilab.rnc schema.
[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"><info><pubdate>October 2006</pubdate></info><refnamediv><refname>fftw</refname><refpurpose>fast fourier transform that use fftw library</refpurpose></refnamediv>
14   
15   
16   
17   
18   
19   <refsynopsisdiv><title>Calling Sequence</title><synopsis>[y]=fftw(x)
20 [y]=fftw(x,sign)
21 [y]=fftw(x,sign,dim,incr)
22 [y]=fftw(x,sign,[dim1 dim2 ...dimN],[incr1 incr2 ...incrN])</synopsis></refsynopsisdiv>
23   <refsection><title>Parameters</title>
24     <variablelist>
25       <varlistentry>
26         <term>y,x</term>
27         <listitem>
28           <para>matrix/vector of real/complex data. Input/output data to be transformed.</para>
29         </listitem>
30       </varlistentry>
31       <varlistentry>
32         <term>sign</term>
33         <listitem>
34           <para>Integer. 1 or -1. Set direct or inverse transform.</para>
35         </listitem>
36       </varlistentry>
37       <varlistentry>
38         <term>dim</term>
39         <listitem>
40           <para>integer. Set the dimension (the length) of the transform.</para>
41         </listitem>
42       </varlistentry>
43       <varlistentry>
44         <term>incr</term>
45         <listitem>
46           <para>integer. Set the stride (the span) of the transform.</para>
47         </listitem>
48       </varlistentry>
49     </variablelist>
50   </refsection>
51   <refsection><title>Description</title>
52     <para>
53     This function realizes direct/inverse Discrete Fourier Transform (DFT) with the help of the FFTW library.
54     </para>
55     <para>
56     One can compute vector, 2D, M-D transform with this function.
57     </para>
58     <para>
59     For more details of fftw syntax see <link xlink:href="fft.htm"><literal>fft</literal></link> scilab function.
60     </para>
61     <para>
62     For more details about FFTW library see FFTW Web site :<link xlink:href="http://www.fftw.org"><literal> http://www.fftw.org </literal>.</link>
63     </para>
64     <para>
65     Remark : fftw function automaticaly stores his last parameters in memory to re-use it in a second time.
66     </para>
67     <para>
68     This results on a time computation improvement when consecutives calls (with same parameters) are used.
69     </para>
70   </refsection>
71   <refsection><title>Examples</title><programlisting role="example"><![CDATA[
72   
73   //simple vector direct transform
74   a = rand(50,1)+%i*rand(50,1);
75   y = fftw(a);
76   y = fftw(a,-1);
77   //inverse transform
78   b = fftw(y,1);
79
80   //2D transform
81   a = rand(512,512)+%i*rand(512,512);
82   y = fftw(a);
83
84   //M-D transform -old calling sequence-
85   a = rand(120,1);
86   y = a;
87   dim=[5 6 4];incr=[1 5 30];
88   for i=1:3
89     y = fftw(y,-1,dim(i),incr(i));
90   end
91
92   //M-D transform -new calling sequence-
93   //More efficient than old
94   y = fftw(a,-1,[5 6 4],[1 5 30]);
95   b = fftw(y,1,[5 6 4],[1 5 30]);
96   
97   ]]></programlisting></refsection>
98
99   <refsection><title>See Also</title><simplelist type="inline">
100     <member><link linkend="fftw_flags">fftw_flags</link></member>
101     <member><link linkend="get_fftw_wisdom">get_fftw_wisdom</link></member>
102     <member><link linkend="set_fftw_wisdom">set_fftw_wisdom</link></member>
103     <member><link linkend="fftw_forget_wisdom">fftw_forget_wisdom</link></member>
104   </simplelist></refsection>
105
106   <refsection><title>Bibliography</title>
107     <para>
108     Matteo Frigo and Steven G. Johnson, "FFTW Manual fo version 3.1.2" June 2006. Available : http://www.fftw.org
109     </para>
110   </refsection>
111
112 </refentry>