Chris@42: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@42: <html>
Chris@42: <!-- This manual is for FFTW
Chris@42: (version 3.3.5, 30 July 2016).
Chris@42:
Chris@42: Copyright (C) 2003 Matteo Frigo.
Chris@42:
Chris@42: Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@42:
Chris@42: Permission is granted to make and distribute verbatim copies of this
Chris@42: manual provided the copyright notice and this permission notice are
Chris@42: preserved on all copies.
Chris@42:
Chris@42: Permission is granted to copy and distribute modified versions of this
Chris@42: manual under the conditions for verbatim copying, provided that the
Chris@42: entire resulting derived work is distributed under the terms of a
Chris@42: permission notice identical to this one.
Chris@42:
Chris@42: Permission is granted to copy and distribute translations of this manual
Chris@42: into another language, under the above conditions for modified versions,
Chris@42: except that this permission notice may be stated in a translation
Chris@42: approved by the Free Software Foundation. -->
Chris@42: <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
Chris@42: <head>
Chris@42: <title>FFTW 3.3.5: Multi-Dimensional DFTs of Real Data</title>
Chris@42:
Chris@42: <meta name="description" content="FFTW 3.3.5: Multi-Dimensional DFTs of Real Data">
Chris@42: <meta name="keywords" content="FFTW 3.3.5: Multi-Dimensional DFTs of Real Data">
Chris@42: <meta name="resource-type" content="document">
Chris@42: <meta name="distribution" content="global">
Chris@42: <meta name="Generator" content="makeinfo">
Chris@42: <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@42: <link href="index.html#Top" rel="start" title="Top">
Chris@42: <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@42: <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@42: <link href="Tutorial.html#Tutorial" rel="up" title="Tutorial">
Chris@42: <link href="More-DFTs-of-Real-Data.html#More-DFTs-of-Real-Data" rel="next" title="More DFTs of Real Data">
Chris@42: <link href="One_002dDimensional-DFTs-of-Real-Data.html#One_002dDimensional-DFTs-of-Real-Data" rel="prev" title="One-Dimensional DFTs of Real Data">
Chris@42: <style type="text/css">
Chris@42: <!--
Chris@42: a.summary-letter {text-decoration: none}
Chris@42: blockquote.smallquotation {font-size: smaller}
Chris@42: div.display {margin-left: 3.2em}
Chris@42: div.example {margin-left: 3.2em}
Chris@42: div.indentedblock {margin-left: 3.2em}
Chris@42: div.lisp {margin-left: 3.2em}
Chris@42: div.smalldisplay {margin-left: 3.2em}
Chris@42: div.smallexample {margin-left: 3.2em}
Chris@42: div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
Chris@42: div.smalllisp {margin-left: 3.2em}
Chris@42: kbd {font-style:oblique}
Chris@42: pre.display {font-family: inherit}
Chris@42: pre.format {font-family: inherit}
Chris@42: pre.menu-comment {font-family: serif}
Chris@42: pre.menu-preformatted {font-family: serif}
Chris@42: pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@42: pre.smallexample {font-size: smaller}
Chris@42: pre.smallformat {font-family: inherit; font-size: smaller}
Chris@42: pre.smalllisp {font-size: smaller}
Chris@42: span.nocodebreak {white-space:nowrap}
Chris@42: span.nolinebreak {white-space:nowrap}
Chris@42: span.roman {font-family:serif; font-weight:normal}
Chris@42: span.sansserif {font-family:sans-serif; font-weight:normal}
Chris@42: ul.no-bullet {list-style: none}
Chris@42: -->
Chris@42: </style>
Chris@42:
Chris@42:
Chris@42: </head>
Chris@42:
Chris@42: <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
Chris@42: <a name="Multi_002dDimensional-DFTs-of-Real-Data"></a>
Chris@42: <div class="header">
Chris@42: <p>
Chris@42: Next: <a href="More-DFTs-of-Real-Data.html#More-DFTs-of-Real-Data" accesskey="n" rel="next">More DFTs of Real Data</a>, Previous: <a href="One_002dDimensional-DFTs-of-Real-Data.html#One_002dDimensional-DFTs-of-Real-Data" accesskey="p" rel="prev">One-Dimensional DFTs of Real Data</a>, Up: <a href="Tutorial.html#Tutorial" accesskey="u" rel="up">Tutorial</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@42: </div>
Chris@42: <hr>
Chris@42: <a name="Multi_002dDimensional-DFTs-of-Real-Data-1"></a>
Chris@42: <h3 class="section">2.4 Multi-Dimensional DFTs of Real Data</h3>
Chris@42:
Chris@42: <p>Multi-dimensional DFTs of real data use the following planner routines:
Chris@42: </p>
Chris@42: <div class="example">
Chris@42: <pre class="example">fftw_plan fftw_plan_dft_r2c_2d(int n0, int n1,
Chris@42: double *in, fftw_complex *out,
Chris@42: unsigned flags);
Chris@42: fftw_plan fftw_plan_dft_r2c_3d(int n0, int n1, int n2,
Chris@42: double *in, fftw_complex *out,
Chris@42: unsigned flags);
Chris@42: fftw_plan fftw_plan_dft_r2c(int rank, const int *n,
Chris@42: double *in, fftw_complex *out,
Chris@42: unsigned flags);
Chris@42: </pre></div>
Chris@42: <a name="index-fftw_005fplan_005fdft_005fr2c_005f2d"></a>
Chris@42: <a name="index-fftw_005fplan_005fdft_005fr2c_005f3d"></a>
Chris@42: <a name="index-fftw_005fplan_005fdft_005fr2c"></a>
Chris@42:
Chris@42: <p>as well as the corresponding <code>c2r</code> routines with the input/output
Chris@42: types swapped. These routines work similarly to their complex
Chris@42: analogues, except for the fact that here the complex output array is cut
Chris@42: roughly in half and the real array requires padding for in-place
Chris@42: transforms (as in 1d, above).
Chris@42: </p>
Chris@42: <p>As before, <code>n</code> is the logical size of the array, and the
Chris@42: consequences of this on the the format of the complex arrays deserve
Chris@42: careful attention.
Chris@42: <a name="index-r2c_002fc2r-multi_002ddimensional-array-format"></a>
Chris@42: Suppose that the real data has dimensions n<sub>0</sub> × n<sub>1</sub> × n<sub>2</sub> × … × n<sub>d-1</sub> (in row-major order).
Chris@42: Then, after an r2c transform, the output is an n<sub>0</sub> × n<sub>1</sub> × n<sub>2</sub> × … × (n<sub>d-1</sub>/2 + 1) array of
Chris@42: <code>fftw_complex</code> values in row-major order, corresponding to slightly
Chris@42: over half of the output of the corresponding complex DFT. (The division
Chris@42: is rounded down.) The ordering of the data is otherwise exactly the
Chris@42: same as in the complex-DFT case.
Chris@42: </p>
Chris@42: <p>For out-of-place transforms, this is the end of the story: the real
Chris@42: data is stored as a row-major array of size n<sub>0</sub> × n<sub>1</sub> × n<sub>2</sub> × … × n<sub>d-1</sub> and the complex
Chris@42: data is stored as a row-major array of size n<sub>0</sub> × n<sub>1</sub> × n<sub>2</sub> × … × (n<sub>d-1</sub>/2 + 1).
Chris@42: </p>
Chris@42: <p>For in-place transforms, however, extra padding of the real-data array
Chris@42: is necessary because the complex array is larger than the real array,
Chris@42: and the two arrays share the same memory locations. Thus, for
Chris@42: in-place transforms, the final dimension of the real-data array must
Chris@42: be padded with extra values to accommodate the size of the complex
Chris@42: data—two values if the last dimension is even and one if it is odd.
Chris@42: <a name="index-padding-1"></a>
Chris@42: That is, the last dimension of the real data must physically contain
Chris@42: 2 * (n<sub>d-1</sub>/2+1)<code>double</code> values (exactly enough to hold the complex data).
Chris@42: This physical array size does not, however, change the <em>logical</em>
Chris@42: array size—only
Chris@42: n<sub>d-1</sub>values are actually stored in the last dimension, and
Chris@42: n<sub>d-1</sub>is the last dimension passed to the plan-creation routine.
Chris@42: </p>
Chris@42: <p>For example, consider the transform of a two-dimensional real array of
Chris@42: size <code>n0</code> by <code>n1</code>. The output of the r2c transform is a
Chris@42: two-dimensional complex array of size <code>n0</code> by <code>n1/2+1</code>, where
Chris@42: the <code>y</code> dimension has been cut nearly in half because of
Chris@42: redundancies in the output. Because <code>fftw_complex</code> is twice the
Chris@42: size of <code>double</code>, the output array is slightly bigger than the
Chris@42: input array. Thus, if we want to compute the transform in place, we
Chris@42: must <em>pad</em> the input array so that it is of size <code>n0</code> by
Chris@42: <code>2*(n1/2+1)</code>. If <code>n1</code> is even, then there are two padding
Chris@42: elements at the end of each row (which need not be initialized, as they
Chris@42: are only used for output).
Chris@42: </p>
Chris@42: <p>The following illustration depicts the input and output arrays just
Chris@42: described, for both the out-of-place and in-place transforms (with the
Chris@42: arrows indicating consecutive memory locations):
Chris@42: <img src="rfftwnd-for-html.png" alt="rfftwnd-for-html">
Chris@42: </p>
Chris@42: <p>These transforms are unnormalized, so an r2c followed by a c2r
Chris@42: transform (or vice versa) will result in the original data scaled by
Chris@42: the number of real data elements—that is, the product of the
Chris@42: (logical) dimensions of the real data.
Chris@42: <a name="index-normalization-1"></a>
Chris@42: </p>
Chris@42:
Chris@42: <p>(Because the last dimension is treated specially, if it is equal to
Chris@42: <code>1</code> the transform is <em>not</em> equivalent to a lower-dimensional
Chris@42: r2c/c2r transform. In that case, the last complex dimension also has
Chris@42: size <code>1</code> (<code>=1/2+1</code>), and no advantage is gained over the
Chris@42: complex transforms.)
Chris@42: </p>
Chris@42: <hr>
Chris@42: <div class="header">
Chris@42: <p>
Chris@42: Next: <a href="More-DFTs-of-Real-Data.html#More-DFTs-of-Real-Data" accesskey="n" rel="next">More DFTs of Real Data</a>, Previous: <a href="One_002dDimensional-DFTs-of-Real-Data.html#One_002dDimensional-DFTs-of-Real-Data" accesskey="p" rel="prev">One-Dimensional DFTs of Real Data</a>, Up: <a href="Tutorial.html#Tutorial" accesskey="u" rel="up">Tutorial</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@42: </div>
Chris@42:
Chris@42:
Chris@42:
Chris@42: </body>
Chris@42: </html>