comparison Lib/fftw-3.2.1/doc/html/.svn/text-base/Complex-Multi_002dDimensional-DFTs.html.svn-base @ 0:25bf17994ef1

First commit. VS2013, Codeblocks and Mac OSX configuration
author Geogaddi\David <d.m.ronan@qmul.ac.uk>
date Thu, 09 Jul 2015 01:12:16 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:25bf17994ef1
1 <html lang="en">
2 <head>
3 <title>Complex Multi-Dimensional DFTs - FFTW 3.2.1</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="FFTW 3.2.1">
6 <meta name="generator" content="makeinfo 4.8">
7 <link title="Top" rel="start" href="index.html#Top">
8 <link rel="up" href="Tutorial.html#Tutorial" title="Tutorial">
9 <link rel="prev" href="Complex-One_002dDimensional-DFTs.html#Complex-One_002dDimensional-DFTs" title="Complex One-Dimensional DFTs">
10 <link rel="next" href="One_002dDimensional-DFTs-of-Real-Data.html#One_002dDimensional-DFTs-of-Real-Data" title="One-Dimensional DFTs of Real Data">
11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
12 <!--
13 This manual is for FFTW
14 (version 3.2.1, 5 February 2009).
15
16 Copyright (C) 2003 Matteo Frigo.
17
18 Copyright (C) 2003 Massachusetts Institute of Technology.
19
20 Permission is granted to make and distribute verbatim copies of
21 this manual provided the copyright notice and this permission
22 notice are preserved on all copies.
23
24 Permission is granted to copy and distribute modified versions of
25 this manual under the conditions for verbatim copying, provided
26 that the entire resulting derived work is distributed under the
27 terms of a permission notice identical to this one.
28
29 Permission is granted to copy and distribute translations of this
30 manual into another language, under the above conditions for
31 modified versions, except that this permission notice may be
32 stated in a translation approved by the Free Software Foundation.
33 -->
34 <meta http-equiv="Content-Style-Type" content="text/css">
35 <style type="text/css"><!--
36 pre.display { font-family:inherit }
37 pre.format { font-family:inherit }
38 pre.smalldisplay { font-family:inherit; font-size:smaller }
39 pre.smallformat { font-family:inherit; font-size:smaller }
40 pre.smallexample { font-size:smaller }
41 pre.smalllisp { font-size:smaller }
42 span.sc { font-variant:small-caps }
43 span.roman { font-family:serif; font-weight:normal; }
44 span.sansserif { font-family:sans-serif; font-weight:normal; }
45 --></style>
46 </head>
47 <body>
48 <div class="node">
49 <p>
50 <a name="Complex-Multi-Dimensional-DFTs"></a>
51 <a name="Complex-Multi_002dDimensional-DFTs"></a>
52 Next:&nbsp;<a rel="next" accesskey="n" href="One_002dDimensional-DFTs-of-Real-Data.html#One_002dDimensional-DFTs-of-Real-Data">One-Dimensional DFTs of Real Data</a>,
53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Complex-One_002dDimensional-DFTs.html#Complex-One_002dDimensional-DFTs">Complex One-Dimensional DFTs</a>,
54 Up:&nbsp;<a rel="up" accesskey="u" href="Tutorial.html#Tutorial">Tutorial</a>
55 <hr>
56 </div>
57
58 <h3 class="section">2.2 Complex Multi-Dimensional DFTs</h3>
59
60 <p>Multi-dimensional transforms work much the same way as one-dimensional
61 transforms: you allocate arrays of <code>fftw_complex</code> (preferably
62 using <code>fftw_malloc</code>), create an <code>fftw_plan</code>, execute it as
63 many times as you want with <code>fftw_execute(plan)</code>, and clean up
64 with <code>fftw_destroy_plan(plan)</code> (and <code>fftw_free</code>). The only
65 difference is the routine you use to create the plan:
66
67 <pre class="example"> fftw_plan fftw_plan_dft_2d(int n0, int n1,
68 fftw_complex *in, fftw_complex *out,
69 int sign, unsigned flags);
70 fftw_plan fftw_plan_dft_3d(int n0, int n1, int n2,
71 fftw_complex *in, fftw_complex *out,
72 int sign, unsigned flags);
73 fftw_plan fftw_plan_dft(int rank, const int *n,
74 fftw_complex *in, fftw_complex *out,
75 int sign, unsigned flags);
76 </pre>
77 <p><a name="index-fftw_005fplan_005fdft_005f2d-38"></a><a name="index-fftw_005fplan_005fdft_005f3d-39"></a><a name="index-fftw_005fplan_005fdft-40"></a>
78 These routines create plans for <code>n0</code> by <code>n1</code> two-dimensional
79 (2d) transforms, <code>n0</code> by <code>n1</code> by <code>n2</code> 3d transforms,
80 and arbitrary <code>rank</code>-dimensional transforms, respectively. In the
81 <a name="index-rank-41"></a>third case, <code>n</code> is a pointer to an array <code>n[rank]</code> denoting
82 an <code>n[0]</code> by <code>n[1]</code> by <small class="dots">...</small> by <code>n[rank-1]</code>
83 transform. All of these transforms operate on contiguous arrays in
84 the C-standard <dfn>row-major</dfn> order, so that the last dimension has
85 the fastest-varying index in the array. This layout is described
86 further in <a href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array Format</a>.
87
88 <p>You may have noticed that all the planner routines described so far
89 have overlapping functionality. For example, you can plan a 1d or 2d
90 transform by using <code>fftw_plan_dft</code> with a <code>rank</code> of <code>1</code>
91 or <code>2</code>, or even by calling <code>fftw_plan_dft_3d</code> with <code>n0</code>
92 and/or <code>n1</code> equal to <code>1</code> (with no loss in efficiency). This
93 pattern continues, and FFTW's planning routines in general form a
94 &ldquo;partial order,&rdquo; sequences of
95 <a name="index-partial-order-42"></a>interfaces with strictly increasing generality but correspondingly
96 greater complexity.
97
98 <p><code>fftw_plan_dft</code> is the most general complex-DFT routine that we
99 describe in this tutorial, but there are also the advanced and guru interfaces,
100 <a name="index-advanced-interface-43"></a><a name="index-guru-interface-44"></a>which allow one to efficiently combine multiple/strided transforms
101 into a single FFTW plan, transform a subset of a larger
102 multi-dimensional array, and/or to handle more general complex-number
103 formats. For more information, see <a href="FFTW-Reference.html#FFTW-Reference">FFTW Reference</a>.
104
105 <!-- -->
106 </body></html>
107