Component: Fast Fourier Transform (FFT) (DSP)

Author	Matrix Ltd
Version	1.2
Category	DSP

Fast Fourier Transform (FFT) component

Provides a way of converting a buffer full of time domain data into frequency domain data. The output of the FFT is a set of frequency bins which correspond to the frequencies present in the signal. The number of frequency bins is equal to half the input buffer size with each bin being responsible for a portion of the frequency up to 1/2 the nyquist.

Detailed description

No detailed description exists yet for this component

Examples

Example takes two adjustable frequency sine wave inputs and combines them and then passes the collection of 256 samples to the FFT function which produces 128 individual frequency banks which are then plotted from left (lowest frequency) to right (highest frequency) using an XY chart component.

FFT Example

Frequency output for a set of data

Frequency banks can be worked out by using the sample frequency and buffer size. The number of frequency banks is equal to the number of samples divided by 2 minus 1. We subtract the one because bank 0 is always empty and so can be discounted.

FrequencyBanks = (SampleCount / 2) - 1

The frequency ranges present inside a bank can be worked out as follows.

FreqMin = ((SampleRate / 2) / (SampleCount / 2)) * Bank

FreqMax = ((SampleRate / 2) / (SampleCount / 2)) * (Bank + 1)

For example if we sample at 10KHz and collect 256 samples then frequency bank 10 would represent any frequencies in the range of 390.6Hz to 429.7Hz.

Here is a spreadsheet document that will calculate the frequencies present in each bank. The highlighted green fields are editable and will update the rest of the values.

File:FFT Frequency Bank Calculator.xls

Downloadable macro reference

	ReadFrequencyBank
Reads the value from one of the frequency banks after the FFT conversion has been performed. Valid frequency banks range from 1 to the allocated buffer size / 2 assuming the buffers are sized to be equal to a power of 2.
- UINT	BankIdx
- UINT	Return

	FFT
Performs the data conversion from time based data to frequency based data. Takes a full buffer input and converts it into real and imaginary frequency data ready for you to read the individual frequency bins.
- VOID	Return

	QueueData
Takes a single value from the buffer input and stores it, once there are enough values queued up it returns a 1.
[[File:]] -	ProcessWhenFull
0 = Do Nothing when Buffer is full, 1 = Auto call FFT macro when Buffer is full
[[File:]] -	Return

	IsPlaying
Checks to see if the last played track is still playing
[[File:]] -	Return

	GetReplyByte
Reads a single byte from the last reply. Each reply contains 4 bytes starting with the command code.
- BYTE	Index
Range: 0-3 / 0=Command, 1=Feedback, 2=Data MSB, 3=Data LSB
- BYTE	Return

	SkipTrack
Jump to the next or previous track
[[File:]] -	Direction
0=Next, 1=Previous
- VOID	Return

	PlayTrack
Plays track from the selected folder. MP3 & Advert folder track numbers should be 4 characters long e.g. 0001 any name.mp3, Other folder track numbers should be 3 characters long e.g. 001 Any name.mp3, Root the Track played in placement order.
- BYTE	Directory
0=Root, 1=Folder "01" - 99=Folder "99", 100=MP3, 101=Advert
- UINT	Track
Track number 1="001*.MP3" / "0001*.MP3", 100="100*.MP3" / "0100*.MP3"
- VOID	Return

	Initialise
Sets up the UART and does some housekeeping. Must be called before calling any of the other component macros.
- VOID	Return

	ReadAnalogAsInt
Reads one of the analogue components as an Integer value
- BYTE	Channel
0 = LDR, 1 = POT
[[File:]] -	Return

	RemapCharacter
Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters. The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.
- BYTE	RemapIdx
Remap Index, Range: 0 to (Remap Characters - 1)
- BYTE	SearchCharacter
Character to look for a replace
- BYTE	ReplacementCharacter
New character value to use in place of the search character.
- VOID	Return

	Start
Startup routine required by the hardware device. Automatically clears the display after initialising.
- VOID	Return

	SetLEDState
Sets the state of a single LED
- BYTE	Port
0 = PortA, 1 = PortB
- BYTE	LED
0 = LED0, 7 = LED7
- BYTE	State
- VOID	Return

	Initialise
Must be called before any other CAN component macros to enable and initialise the CAN peripheral.
- VOID	Return

Property reference

	Properties
	Connect To
	Buffer Size
Number of individual elements the buffer can store, must be a power of 2, default 256.
	Buffer Type
Sets the buffer data type.
	Filter Input Data
Applies a hamming window filter to the time domain sample data to provide better frequency detection.
	Sample Rate
Sample rate used to perform simple calculations like nyquist and bin size.
	Nyquist Frequency
The maximum frequency that can theoretically be detected by the FFT component assuming the sample rate is setup correctly.
	Frequency Bin Count
The number of frequency bins that the component will provide.
	Frequency Bin Size (Hz)
The frequency range covered by each frequency bin.
	Connections
	Simulations