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