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