<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="fft~" module="msp" category="MSP FFT">
	<digest>
		Fast Fourier transform
	</digest>
	<description>
		<o>fft~</o> performs a Fast Fourier transform on any incoming signal and outputs the real and imaginary parts of that transform as well as a synchronization signal.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			MSP
		</metadata>
		<metadata name="tag">
			MSP FFT
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="signal">
			<digest>
				(signal) Real Input
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="signal">
			<digest>
				(signal) Imaginary Input
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="signal">
			<digest>
				(signal) Real Output
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="signal">
			<digest>
				(signal) Imaginary Output
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="2" type="signal">
			<digest>
				(signal) Ramp from 0 to Number of Points - 1
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="number-of-FFT-samples" optional="1" type="int">
			<digest>
				Number of FFT points
			</digest>
			<description>
				The first argument specifies the number of points (samples) in the FFT. It must be a power of two. The default number of points is 512.
			</description>
		</objarg>
		<objarg name="spectral-frame-size" optional="1" type="int">
			<digest>
				Number of samples between successive FFs
			</digest>
			<description>
				The second argument specifies the number of samples between successive FFTs. This must be at least the number of points, and must also be a power of two. The default interval is 512.
			</description>
		</objarg>
		<objarg name="phase" optional="1" type="int">
			<digest>
				FFT hop size
			</digest>
			<description>
				The third argument specifies the offset into the interval where the FFT will start. This must either be 0 or a multiple of the signal vector size. <o>fft~</o> will correct bad arguments, but if you change the signal vector size after creating an <o>fft~</o> and the offset is no longer a multiple of the vector size, the <o>fft~</o> will not operate when signal processing is turned on.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="phase">
			<arglist>
				<arg name="offset" optional="0" type="int" />
			</arglist>
			<digest>
				Offset from the beginning of a period when the FFT is performed
			</digest>
			<description>
				Offset from the beginning of a period when the FFT is performed.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Function depends on inlet
			</digest>
			<description>
				In left inlet: The real part of a complex signal that will be transformed.
				<br />
				<br />
				In right inlet: The imaginary part of a complex signal that will be transformed.
				<br />
				<br />
				If signals are connected only to the left inlet and left outlet, a real FFT (fast Fourier transform) will be performed. Otherwise, a complex FFT will be performed.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="fft~.png" caption="Fast Fourier transform of an audio signal" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="cartopol" />
		<seealso name="cartopol~" />
		<seealso name="fftin~" />
		<seealso name="fftinfo~" />
		<seealso name="fftout~" />
		<seealso name="frameaccum~" />
		<seealso name="framedelta~" />
		<seealso name="ifft~" />
		<seealso name="index~" />
		<seealso name="pfft~" />
		<seealso name="poltocar" />
		<seealso name="poltocar~" />
		<seealso name="vectral~" />
		<seealso name="14_analysischapter03" module="msp" type="tutorial" />
	</seealsolist>
	<misc name="Output">
		<entry name="signal">
			<description>
				Out left outlet: The real part of the Fourier transform of the input. The output begins after all the points of the input have been received.
				<br />
				<br />
				Out middle outlet: The imaginary part of the Fourier transform of the input. The output begins after all the points of the input have been received.
				<br />
				<br />
				Out right outlet: A sync <m>signal</m> that ramps from 0 to the number of points minus 1 over the period in which the FFT output occurs. You can use this signal as an input to the <o>index~</o> object to perform calculations in the frequency domain. When the FFT is not being sent out (in the case where the interval is larger than the number of points), the sync <m>signal</m> is 0.
			</description>
		</entry>
	</misc>
</c74object>
