Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / IFFT.schelp
bloba6b9c64eb16fc0ec9947c9bef0d449079faf2a53
1 class:: IFFT
2 summary:: Inverse Fast Fourier Transform
3 related:: Classes/FFT, Guides/FFT-Overview
4 categories::  UGens>FFT
7 Description::
8 The inverse fast fourier transform converts from frequency content to a
9 signal.
11 The fast fourier transform analyzes the frequency content of a signal. The IFFT UGen converts this emphasis::frequency-domain:: information back into emphasis::time-domain:: audio data. Most often this is used as the end of a process which begins with link::Classes/FFT::, followed by frequency-domain processing using PV (phase-vocoder) UGens, followed by IFFT.
13 classmethods::
15 method::new, ar, kr
16 returns a time domain signal from converting the FFT frequency domain signal chain. The *new method is equivalent to the *ar message returns an audio rate signal.
18 argument::buffer
20 The FFT "chain" signal coming originally from an FFT UGen, perhaps via other PV UGens.
22 argument:: wintype
23 Defines how the data is windowed:
24 table::
25 ## -1 || strong::rectangular:: windowing, simple but typically not recommended;
26 ## 0 || (the default) strong::Sine:: windowing, typically recommended for phase-vocoder work;
27 ## 1 || strong::Hann:: windowing, typically recommended for analysis work.
30 argument:: winsize
31 Can be used to account for zero-padding, in the same way as the link::Classes/FFT:: UGen.
33 returns::
34 The emphasis::time-domain:: audio signal.
36 discussion::
37 The IFFT UGen converts the FFT data in-place (in the original FFT buffer) and overlap-adds the result to produce a continuous signal at its output.
39 Examples::
41 code::
43 // without any modification, convert FFT chain (frequency domain signal) back to audio (time domain signal)
45         var in, chain;
46         in = WhiteNoise.ar(0.01);
47         chain = FFT(LocalBuf(2048), in);
48         IFFT.ar(chain) // inverse FFT
49         );
50 }.play;