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