|
Chris@82
|
1 .\"
|
|
Chris@82
|
2 .\" Copyright (c) 2003, 2007-14 Matteo Frigo
|
|
Chris@82
|
3 .\" Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
|
|
Chris@82
|
4 .\"
|
|
Chris@82
|
5 .\" This program is free software; you can redistribute it and/or modify
|
|
Chris@82
|
6 .\" it under the terms of the GNU General Public License as published by
|
|
Chris@82
|
7 .\" the Free Software Foundation; either version 2 of the License, or
|
|
Chris@82
|
8 .\" (at your option) any later version.
|
|
Chris@82
|
9 .\"
|
|
Chris@82
|
10 .\" This program is distributed in the hope that it will be useful,
|
|
Chris@82
|
11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Chris@82
|
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
Chris@82
|
13 .\" GNU General Public License for more details.
|
|
Chris@82
|
14 .\"
|
|
Chris@82
|
15 .\" You should have received a copy of the GNU General Public License
|
|
Chris@82
|
16 .\" along with this program; if not, write to the Free Software
|
|
Chris@82
|
17 .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
Chris@82
|
18 .\"
|
|
Chris@82
|
19 .TH FFTW-WISDOM 1 "February, 2003" "fftw" "fftw"
|
|
Chris@82
|
20 .SH NAME
|
|
Chris@82
|
21 fftwf\-wisdom \- create wisdom (pre-optimized FFTs)
|
|
Chris@82
|
22 .SH SYNOPSIS
|
|
Chris@82
|
23 .B fftwf\-wisdom
|
|
Chris@82
|
24 [\fIOPTION\fR]... [\fISIZE\fR]...
|
|
Chris@82
|
25 .SH DESCRIPTION
|
|
Chris@82
|
26 .PP
|
|
Chris@82
|
27 .\" Add any additional description here
|
|
Chris@82
|
28 .I fftwf\-wisdom
|
|
Chris@82
|
29 is a utility to generate FFTW
|
|
Chris@82
|
30 .B wisdom
|
|
Chris@82
|
31 files, which contain saved information about how to optimally compute
|
|
Chris@82
|
32 (Fourier) transforms of various sizes. FFTW is a free library to
|
|
Chris@82
|
33 compute discrete Fourier transforms in one or more dimensions, for
|
|
Chris@82
|
34 arbitrary sizes, and of both real and complex data, among other
|
|
Chris@82
|
35 related operations. More information on FFTW can be found at the FFTW
|
|
Chris@82
|
36 home page:
|
|
Chris@82
|
37 .I http://www.fftw.org
|
|
Chris@82
|
38
|
|
Chris@82
|
39 Programs using FFTW can be written to load wisdom from an arbitrary file,
|
|
Chris@82
|
40 string, or other source. Moreover, it is likely that many FFTW-using
|
|
Chris@82
|
41 programs will load the \fBsystem wisdom\fR file, which is stored in
|
|
Chris@82
|
42 .I /etc/fftw/wisdomf
|
|
Chris@82
|
43 by default.
|
|
Chris@82
|
44 .I fftwf\-wisdom
|
|
Chris@82
|
45 can be used to create or add to such wisdom files. In its most
|
|
Chris@82
|
46 typical usage, the wisdom file can be created to pre-plan a canonical
|
|
Chris@82
|
47 set of sizes (see below) via:
|
|
Chris@82
|
48
|
|
Chris@82
|
49 .ce
|
|
Chris@82
|
50 fftwf\-wisdom \-v \-c \-o wisdomf
|
|
Chris@82
|
51
|
|
Chris@82
|
52 (this will take many hours, which can be limited by the
|
|
Chris@82
|
53 .B \-t
|
|
Chris@82
|
54 option) and the output
|
|
Chris@82
|
55 .I wisdomf
|
|
Chris@82
|
56 file can then be copied (as root) to
|
|
Chris@82
|
57 .I /etc/fftw/
|
|
Chris@82
|
58 or whatever.
|
|
Chris@82
|
59
|
|
Chris@82
|
60 The
|
|
Chris@82
|
61 .I fftwf\-wisdom
|
|
Chris@82
|
62 program normally writes the wisdom directly to standard output, but this
|
|
Chris@82
|
63 can be changed via the
|
|
Chris@82
|
64 .B \-o
|
|
Chris@82
|
65 option, as in the example above.
|
|
Chris@82
|
66
|
|
Chris@82
|
67 If the system wisdom file
|
|
Chris@82
|
68 .I /etc/fftw/wisdomf
|
|
Chris@82
|
69 already exists, then
|
|
Chris@82
|
70 .I fftwf\-wisdom
|
|
Chris@82
|
71 reads this existing wisdom (unless the
|
|
Chris@82
|
72 .B \-n
|
|
Chris@82
|
73 option is specified) and outputs both the old wisdom and any
|
|
Chris@82
|
74 newly created wisdom. In this way, it can be used to add new transform
|
|
Chris@82
|
75 sizes to the existing system wisdom (or other wisdom file, with the
|
|
Chris@82
|
76 .B \-w
|
|
Chris@82
|
77 option).
|
|
Chris@82
|
78 .SH SPECIFYING SIZES
|
|
Chris@82
|
79 Although a canonical set of sizes to optimize is specified by the
|
|
Chris@82
|
80 .B \-c
|
|
Chris@82
|
81 option, the user can also specify zero or more non-canonical transform
|
|
Chris@82
|
82 sizes and types to optimize, via the
|
|
Chris@82
|
83 .I SIZE
|
|
Chris@82
|
84 arguments following the option flags. Alternatively, the sizes to
|
|
Chris@82
|
85 optimize can be read from standard input (whitespace-separated), if a
|
|
Chris@82
|
86 .I SIZE
|
|
Chris@82
|
87 argument of "\-" is supplied.
|
|
Chris@82
|
88
|
|
Chris@82
|
89 Sizes are specified by the syntax:
|
|
Chris@82
|
90
|
|
Chris@82
|
91 .ce
|
|
Chris@82
|
92 <\fItype\fR><\fIinplace\fR><\fIdirection\fR><\fIgeometry\fR>
|
|
Chris@82
|
93
|
|
Chris@82
|
94 <\fItype\fR> is either \'c\' (complex), \'r\' (real, r2c/c2r), or
|
|
Chris@82
|
95 \'k\' (r2r, per-dimension kinds, specified in the geometry, below).
|
|
Chris@82
|
96
|
|
Chris@82
|
97 <\fIinplace\fR> is either \'i\' (in place) or \'o\' (out of place).
|
|
Chris@82
|
98
|
|
Chris@82
|
99 <\fIdirection\fR> is either \'f\' (forward) or \'b\' (backward). The
|
|
Chris@82
|
100 <\fIdirection\fR> should be omitted for \'k\' transforms, where it is
|
|
Chris@82
|
101 specified via the geometry instead.
|
|
Chris@82
|
102
|
|
Chris@82
|
103 <\fIgeometry\fR> is the size and dimensionality of the transform,
|
|
Chris@82
|
104 where different dimensions are separated by \'x\' (e.g. \'16x32\' for
|
|
Chris@82
|
105 a two-dimensional 16 by 32 transform). In the case of \'k\'
|
|
Chris@82
|
106 transforms, the size of each dimension is followed by a "type" string,
|
|
Chris@82
|
107 which can be one of f/b/h/e00/e01/e10/e11/o00/o01/o10/o11 for
|
|
Chris@82
|
108 R2HC/HC2R/DHT/REDFT00/.../RODFT11, respectively, as defined in the
|
|
Chris@82
|
109 FFTW manual.
|
|
Chris@82
|
110
|
|
Chris@82
|
111 For example, \'cif12x13x14\' is a three-dimensional 12 by 13 x 14
|
|
Chris@82
|
112 complex DFT operating in-place. \'rob65536\' is a one-dimensional
|
|
Chris@82
|
113 size-65536 out-of-place complex-to-real (backwards) transform
|
|
Chris@82
|
114 operating on Hermitian-symmetry input. \'ki10hx20e01\' is a
|
|
Chris@82
|
115 two-dimensional 10 by 20 r2r transform where the first dimension is a
|
|
Chris@82
|
116 DHT and the second dimension is an REDFT01 (DCT-III).
|
|
Chris@82
|
117
|
|
Chris@82
|
118 .SH OPTIONS
|
|
Chris@82
|
119 .TP
|
|
Chris@82
|
120 \fB\-h\fR, \fB\-\-help\fR
|
|
Chris@82
|
121 Display help on the command-line options and usage.
|
|
Chris@82
|
122 .TP
|
|
Chris@82
|
123 \fB\-V\fR, \fB\-\-version\fR
|
|
Chris@82
|
124 Print the version number and copyright information.
|
|
Chris@82
|
125 .TP
|
|
Chris@82
|
126 \fB\-v\fR, \fB\-\-verbose\fR
|
|
Chris@82
|
127 Verbose output. (You can specify this multiple times, or supply a numeric
|
|
Chris@82
|
128 argument greater than 1, to increase the verbosity level.) Note that the
|
|
Chris@82
|
129 verbose output will be mixed with the wisdom output (making it impossible
|
|
Chris@82
|
130 to import), unless you write the wisdom to a file via the
|
|
Chris@82
|
131 .B \-o
|
|
Chris@82
|
132 option.
|
|
Chris@82
|
133 .TP
|
|
Chris@82
|
134 \fB\-c\fR, \fB\-\-canonical\fR
|
|
Chris@82
|
135 Optimize/pre-plan a canonical set of sizes: all powers of two and ten
|
|
Chris@82
|
136 up to 2^20 (1048576), including both real and complex, forward and
|
|
Chris@82
|
137 backwards, in-place and out-of-place transforms. Also includes two-
|
|
Chris@82
|
138 and three-dimensional transforms of equal-size dimensions
|
|
Chris@82
|
139 (e.g. 16x16x16).
|
|
Chris@82
|
140 .TP
|
|
Chris@82
|
141 \fB\-t\fR \fIhours\fR, \fB\-\-time\-limit\fR=\fIhours\fR
|
|
Chris@82
|
142 Stop after a time of
|
|
Chris@82
|
143 .I hours
|
|
Chris@82
|
144 (hours) has elapsed, outputting accumulated wisdom. (The problems are planned
|
|
Chris@82
|
145 in increasing order of size.) Defaults to 0, indicating no time limit.
|
|
Chris@82
|
146 .TP
|
|
Chris@82
|
147 \fB\-o\fR \fIfile\fR, \fB\-\-output-file\fR=\fIfile\fR
|
|
Chris@82
|
148 Send wisdom output to
|
|
Chris@82
|
149 .I file
|
|
Chris@82
|
150 rather than to standard output (the default).
|
|
Chris@82
|
151 .TP
|
|
Chris@82
|
152 \fB\-m\fR, \fB\-\-measure\fR; \fB\-e\fR, \fB\-\-estimate\fR; \fB\-x\fR, \fB\-\-exhaustive\fR
|
|
Chris@82
|
153 Normally,
|
|
Chris@82
|
154 .I fftwf\-wisdom
|
|
Chris@82
|
155 creates plans in FFTW_PATIENT mode, but with these options you can instead
|
|
Chris@82
|
156 use FFTW_MEASURE, FFTW_ESTIMATE, or FFTW_EXHAUSTIVE modes, respectively,
|
|
Chris@82
|
157 as described in more detail by the FFTW manual.
|
|
Chris@82
|
158
|
|
Chris@82
|
159 Note that wisdom is tagged with the planning patience level, and a
|
|
Chris@82
|
160 single file can mix different levels of wisdom (e.g. you can mostly
|
|
Chris@82
|
161 use the patient default, but plan a few sizes that you especially care
|
|
Chris@82
|
162 about in
|
|
Chris@82
|
163 .B \-\-exhaustive
|
|
Chris@82
|
164 mode).
|
|
Chris@82
|
165 .TP
|
|
Chris@82
|
166 \fB\-n\fR, \fB\-\-no\-system\-wisdom\fR
|
|
Chris@82
|
167 Do not import the system wisdom from
|
|
Chris@82
|
168 .I /etc/fftw/wisdomf
|
|
Chris@82
|
169 (which is normally read by default).
|
|
Chris@82
|
170 .TP
|
|
Chris@82
|
171 \fB\-w\fR \fIfile\fR, \fB\-\-wisdom\-file\fR=\fIfile\fR
|
|
Chris@82
|
172 Import wisdom from
|
|
Chris@82
|
173 .I file
|
|
Chris@82
|
174 (in addition to the system wisdom, unless
|
|
Chris@82
|
175 .B \-n
|
|
Chris@82
|
176 is specified). Multiple wisdom files can be read via multiple
|
|
Chris@82
|
177 .B \-w
|
|
Chris@82
|
178 options. If
|
|
Chris@82
|
179 .I file
|
|
Chris@82
|
180 is "\-", then read wisdom from standard input.
|
|
Chris@82
|
181 .TP
|
|
Chris@82
|
182 \fB\-T\fR \fIN\fR, \fB\--threads\fR=\fIN\fR
|
|
Chris@82
|
183 Plan with
|
|
Chris@82
|
184 .I N
|
|
Chris@82
|
185 threads. This option is only present if FFTW was configured with
|
|
Chris@82
|
186 thread support.
|
|
Chris@82
|
187 .SH BUGS
|
|
Chris@82
|
188 Send bug reports to fftw@fftw.org.
|
|
Chris@82
|
189 .SH AUTHORS
|
|
Chris@82
|
190 Written by Steven G. Johnson and Matteo Frigo.
|
|
Chris@82
|
191
|
|
Chris@82
|
192 Copyright (c) 2003, 2007-14 Matteo Frigo
|
|
Chris@82
|
193 .br
|
|
Chris@82
|
194 Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
|
|
Chris@82
|
195 .SH "SEE ALSO"
|
|
Chris@82
|
196 fftw-wisdom-to-conf(1)
|
