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