Chris@42: .\" Chris@42: .\" Copyright (c) 2003, 2007-14 Matteo Frigo Chris@42: .\" Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology Chris@42: .\" Chris@42: .\" This program is free software; you can redistribute it and/or modify Chris@42: .\" it under the terms of the GNU General Public License as published by Chris@42: .\" the Free Software Foundation; either version 2 of the License, or Chris@42: .\" (at your option) any later version. Chris@42: .\" Chris@42: .\" This program is distributed in the hope that it will be useful, Chris@42: .\" but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@42: .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@42: .\" GNU General Public License for more details. Chris@42: .\" Chris@42: .\" You should have received a copy of the GNU General Public License Chris@42: .\" along with this program; if not, write to the Free Software Chris@42: .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Chris@42: .\" Chris@42: .TH FFTW-WISDOM 1 "February, 2003" "fftw" "fftw" Chris@42: .SH NAME Chris@42: fftwf\-wisdom \- create wisdom (pre-optimized FFTs) Chris@42: .SH SYNOPSIS Chris@42: .B fftwf\-wisdom Chris@42: [\fIOPTION\fR]... [\fISIZE\fR]... Chris@42: .SH DESCRIPTION Chris@42: .PP Chris@42: .\" Add any additional description here Chris@42: .I fftwf\-wisdom Chris@42: is a utility to generate FFTW Chris@42: .B wisdom Chris@42: files, which contain saved information about how to optimally compute Chris@42: (Fourier) transforms of various sizes. FFTW is a free library to Chris@42: compute discrete Fourier transforms in one or more dimensions, for Chris@42: arbitrary sizes, and of both real and complex data, among other Chris@42: related operations. More information on FFTW can be found at the FFTW Chris@42: home page: Chris@42: .I http://www.fftw.org Chris@42: Chris@42: Programs using FFTW can be written to load wisdom from an arbitrary file, Chris@42: string, or other source. Moreover, it is likely that many FFTW-using Chris@42: programs will load the \fBsystem wisdom\fR file, which is stored in Chris@42: .I /etc/fftw/wisdomf Chris@42: by default. Chris@42: .I fftwf\-wisdom Chris@42: can be used to create or add to such wisdom files. In its most Chris@42: typical usage, the wisdom file can be created to pre-plan a canonical Chris@42: set of sizes (see below) via: Chris@42: Chris@42: .ce Chris@42: fftwf\-wisdom \-v \-c \-o wisdomf Chris@42: Chris@42: (this will take many hours, which can be limited by the Chris@42: .B \-t Chris@42: option) and the output Chris@42: .I wisdomf Chris@42: file can then be copied (as root) to Chris@42: .I /etc/fftw/ Chris@42: or whatever. Chris@42: Chris@42: The Chris@42: .I fftwf\-wisdom Chris@42: program normally writes the wisdom directly to standard output, but this Chris@42: can be changed via the Chris@42: .B \-o Chris@42: option, as in the example above. Chris@42: Chris@42: If the system wisdom file Chris@42: .I /etc/fftw/wisdomf Chris@42: already exists, then Chris@42: .I fftwf\-wisdom Chris@42: reads this existing wisdom (unless the Chris@42: .B \-n Chris@42: option is specified) and outputs both the old wisdom and any Chris@42: newly created wisdom. In this way, it can be used to add new transform Chris@42: sizes to the existing system wisdom (or other wisdom file, with the Chris@42: .B \-w Chris@42: option). Chris@42: .SH SPECIFYING SIZES Chris@42: Although a canonical set of sizes to optimize is specified by the Chris@42: .B \-c Chris@42: option, the user can also specify zero or more non-canonical transform Chris@42: sizes and types to optimize, via the Chris@42: .I SIZE Chris@42: arguments following the option flags. Alternatively, the sizes to Chris@42: optimize can be read from standard input (whitespace-separated), if a Chris@42: .I SIZE Chris@42: argument of "\-" is supplied. Chris@42: Chris@42: Sizes are specified by the syntax: Chris@42: Chris@42: .ce Chris@42: <\fItype\fR><\fIinplace\fR><\fIdirection\fR><\fIgeometry\fR> Chris@42: Chris@42: <\fItype\fR> is either \'c\' (complex), \'r\' (real, r2c/c2r), or Chris@42: \'k\' (r2r, per-dimension kinds, specified in the geometry, below). Chris@42: Chris@42: <\fIinplace\fR> is either \'i\' (in place) or \'o\' (out of place). Chris@42: Chris@42: <\fIdirection\fR> is either \'f\' (forward) or \'b\' (backward). The Chris@42: <\fIdirection\fR> should be omitted for \'k\' transforms, where it is Chris@42: specified via the geometry instead. Chris@42: Chris@42: <\fIgeometry\fR> is the size and dimensionality of the transform, Chris@42: where different dimensions are separated by \'x\' (e.g. \'16x32\' for Chris@42: a two-dimensional 16 by 32 transform). In the case of \'k\' Chris@42: transforms, the size of each dimension is followed by a "type" string, Chris@42: which can be one of f/b/h/e00/e01/e10/e11/o00/o01/o10/o11 for Chris@42: R2HC/HC2R/DHT/REDFT00/.../RODFT11, respectively, as defined in the Chris@42: FFTW manual. Chris@42: Chris@42: For example, \'cif12x13x14\' is a three-dimensional 12 by 13 x 14 Chris@42: complex DFT operating in-place. \'rob65536\' is a one-dimensional Chris@42: size-65536 out-of-place complex-to-real (backwards) transform Chris@42: operating on Hermitian-symmetry input. \'ki10hx20e01\' is a Chris@42: two-dimensional 10 by 20 r2r transform where the first dimension is a Chris@42: DHT and the second dimension is an REDFT01 (DCT-III). Chris@42: Chris@42: .SH OPTIONS Chris@42: .TP Chris@42: \fB\-h\fR, \fB\-\-help\fR Chris@42: Display help on the command-line options and usage. Chris@42: .TP Chris@42: \fB\-V\fR, \fB\-\-version\fR Chris@42: Print the version number and copyright information. Chris@42: .TP Chris@42: \fB\-v\fR, \fB\-\-verbose\fR Chris@42: Verbose output. (You can specify this multiple times, or supply a numeric Chris@42: argument greater than 1, to increase the verbosity level.) Note that the Chris@42: verbose output will be mixed with the wisdom output (making it impossible Chris@42: to import), unless you write the wisdom to a file via the Chris@42: .B \-o Chris@42: option. Chris@42: .TP Chris@42: \fB\-c\fR, \fB\-\-canonical\fR Chris@42: Optimize/pre-plan a canonical set of sizes: all powers of two and ten Chris@42: up to 2^20 (1048576), including both real and complex, forward and Chris@42: backwards, in-place and out-of-place transforms. Also includes two- Chris@42: and three-dimensional transforms of equal-size dimensions Chris@42: (e.g. 16x16x16). Chris@42: .TP Chris@42: \fB\-t\fR \fIhours\fR, \fB\-\-time\-limit\fR=\fIhours\fR Chris@42: Stop after a time of Chris@42: .I hours Chris@42: (hours) has elapsed, outputting accumulated wisdom. (The problems are planned Chris@42: in increasing order of size.) Defaults to 0, indicating no time limit. Chris@42: .TP Chris@42: \fB\-o\fR \fIfile\fR, \fB\-\-output-file\fR=\fIfile\fR Chris@42: Send wisdom output to Chris@42: .I file Chris@42: rather than to standard output (the default). Chris@42: .TP Chris@42: \fB\-m\fR, \fB\-\-measure\fR; \fB\-e\fR, \fB\-\-estimate\fR; \fB\-x\fR, \fB\-\-exhaustive\fR Chris@42: Normally, Chris@42: .I fftwf\-wisdom Chris@42: creates plans in FFTW_PATIENT mode, but with these options you can instead Chris@42: use FFTW_MEASURE, FFTW_ESTIMATE, or FFTW_EXHAUSTIVE modes, respectively, Chris@42: as described in more detail by the FFTW manual. Chris@42: Chris@42: Note that wisdom is tagged with the planning patience level, and a Chris@42: single file can mix different levels of wisdom (e.g. you can mostly Chris@42: use the patient default, but plan a few sizes that you especially care Chris@42: about in Chris@42: .B \-\-exhaustive Chris@42: mode). Chris@42: .TP Chris@42: \fB\-n\fR, \fB\-\-no\-system\-wisdom\fR Chris@42: Do not import the system wisdom from Chris@42: .I /etc/fftw/wisdomf Chris@42: (which is normally read by default). Chris@42: .TP Chris@42: \fB\-w\fR \fIfile\fR, \fB\-\-wisdom\-file\fR=\fIfile\fR Chris@42: Import wisdom from Chris@42: .I file Chris@42: (in addition to the system wisdom, unless Chris@42: .B \-n Chris@42: is specified). Multiple wisdom files can be read via multiple Chris@42: .B \-w Chris@42: options. If Chris@42: .I file Chris@42: is "\-", then read wisdom from standard input. Chris@42: .TP Chris@42: \fB\-T\fR \fIN\fR, \fB\--threads\fR=\fIN\fR Chris@42: Plan with Chris@42: .I N Chris@42: threads. This option is only present if FFTW was configured with Chris@42: thread support. Chris@42: .SH BUGS Chris@42: Send bug reports to fftw@fftw.org. Chris@42: .SH AUTHORS Chris@42: Written by Steven G. Johnson and Matteo Frigo. Chris@42: Chris@42: Copyright (c) 2003, 2007-14 Matteo Frigo Chris@42: .br Chris@42: Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology Chris@42: .SH "SEE ALSO" Chris@42: fftw-wisdom-to-conf(1)