bad place
[scilab.git] / scilab / modules / fftw / help / en_US / fftw.xml
1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
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 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
14 <MAN>
15   <LANGUAGE>eng</LANGUAGE>
16   <TITLE>fftw</TITLE>
17   <TYPE>Scilab Function</TYPE>
18   <DATE>October 2006</DATE>
19   <SHORT_DESCRIPTION name="fftw">fast fourier transform that use fftw library</SHORT_DESCRIPTION>
20   <CALLING_SEQUENCE>
21     <CALLING_SEQUENCE_ITEM>[y]=fftw(x)</CALLING_SEQUENCE_ITEM>
22     <CALLING_SEQUENCE_ITEM>[y]=fftw(x,sign)</CALLING_SEQUENCE_ITEM>
23     <CALLING_SEQUENCE_ITEM>[y]=fftw(x,sign,dim,incr)</CALLING_SEQUENCE_ITEM>
24     <CALLING_SEQUENCE_ITEM>[y]=fftw(x,sign,[dim1 dim2 ...dimN],[incr1 incr2 ...incrN])</CALLING_SEQUENCE_ITEM>
25   </CALLING_SEQUENCE>
26   <PARAM>
27     <PARAM_INDENT>
28       <PARAM_ITEM>
29         <PARAM_NAME>y,x</PARAM_NAME>
30         <PARAM_DESCRIPTION>
31           <SP>: matrix/vector of real/complex data. Input/output data to be transformed.</SP>
32         </PARAM_DESCRIPTION>
33       </PARAM_ITEM>
34       <PARAM_ITEM>
35         <PARAM_NAME>sign</PARAM_NAME>
36         <PARAM_DESCRIPTION>
37           <SP>: Integer. 1 or -1. Set direct or inverse transform.</SP>
38         </PARAM_DESCRIPTION>
39       </PARAM_ITEM>
40       <PARAM_ITEM>
41         <PARAM_NAME>dim</PARAM_NAME>
42         <PARAM_DESCRIPTION>
43           <SP>: integer. Set the dimension (the length) of the transform.</SP>
44         </PARAM_DESCRIPTION>
45       </PARAM_ITEM>
46       <PARAM_ITEM>
47         <PARAM_NAME>incr</PARAM_NAME>
48         <PARAM_DESCRIPTION>
49           <SP>: integer. Set the stride (the span) of the transform.</SP>
50         </PARAM_DESCRIPTION>
51       </PARAM_ITEM>
52     </PARAM_INDENT>
53   </PARAM>
54   <DESCRIPTION>
55     <P>
56     This function realizes direct/inverse Discrete Fourier Transform (DFT) with the help of the FFTW library.
57     </P>
58     <P>
59     One can compute vector, 2D, M-D transform with this function.
60     </P>
61     <P>
62     For more details of fftw syntax see <A href='fft.htm'><VERB>fft</VERB></A> scilab function.
63     </P>
64     <P>
65     For more details about FFTW library see FFTW Web site :<A href='http://www.fftw.org'><VERB> http://www.fftw.org </VERB>.</A>
66     </P>
67     <SP>
68     Remark : fftw function automaticaly stores his last parameters in memory to re-use it in a second time.
69     </SP>
70     <SP>
71     This results on a time computation improvement when consecutives calls (with same parameters) are used.
72     </SP>
73   </DESCRIPTION>
74   <EXAMPLE>
75   <![CDATA[
76   //simple vector direct transform
77   a = rand(50,1)+%i*rand(50,1);
78   y = fftw(a);
79   y = fftw(a,-1);
80   //inverse transform
81   b = fftw(y,1);
82
83   //2D transform
84   a = rand(512,512)+%i*rand(512,512);
85   y = fftw(a);
86
87   //M-D transform -old calling sequence-
88   a = rand(120,1);
89   y = a;
90   dim=[5 6 4];incr=[1 5 30];
91   for i=1:3
92     y = fftw(y,-1,dim(i),incr(i));
93   end
94
95   //M-D transform -new calling sequence-
96   //More efficient than old
97   y = fftw(a,-1,[5 6 4],[1 5 30]);
98   b = fftw(y,1,[5 6 4],[1 5 30]);
99   ]]>
100   </EXAMPLE>
101
102   <SEE_ALSO>
103     <SEE_ALSO_ITEM><LINK>fftw_flags</LINK></SEE_ALSO_ITEM>
104     <SEE_ALSO_ITEM><LINK>get_fftw_wisdom</LINK></SEE_ALSO_ITEM>
105     <SEE_ALSO_ITEM><LINK>set_fftw_wisdom</LINK></SEE_ALSO_ITEM>
106     <SEE_ALSO_ITEM><LINK>fftw_forget_wisdom</LINK></SEE_ALSO_ITEM>
107   </SEE_ALSO>
108
109   <BIBLIO>
110     <P>
111     Matteo Frigo and Steven G. Johnson, &quot;FFTW Manual fo version 3.1.2&quot; June 2006. Available : http://www.fftw.org
112     </P>
113   </BIBLIO>
114
115 </MAN>