FFT Function

Description

The FFT function performs forward FFT calculation from input data. The input data must be a batch of complex numbers (i.e. real and imaginary). The output data is the magnitude and frequency result.

Configuration

To add the FFT Function to a stream, follow the steps below:

  1. Ensure you have a use case open in the stream designer, this can be a new use case or an existing use case
  2. From the toolbox on the left expand the Function option and scroll down until you can see “FFT Function”
    • You can also use the search in the header to find the stream object quickly
  3. Click and drag the FFT Function from the toolbox onto the canvas
  4. Rename the Function by clicking into the text button on the action bar
  5. Save the Stream by clicking the save button in the action bar
  6. Hover over the icon for the stream object until it turns orange and then double click to open the configuration page
    • You can optionally use the configure option on the action bar once you have selected the specific stream object and then clicking this option
  7. Configuration options
    • The drop-down allows you to associate this stream object with a specific collection. The default option is derived from the default specified against the specific use case and is generated left as the same option. If you do need to change it to another collection make the change by selecting the new collection in the drop-down.
  8. Enter Settings
    • Select Method from drop-down list
    • Enter Sampling Frequency
  9. Click Apply on the action bar, and then save the stream using the save button.
This agent expects the input data structure to contain the following fields:

  • Real
  • Imaginary
  • Note: The length of inputs must be 2^n, the action agent would fill zero values to make up the length of input to 2^n. The maximum number of input is 2^14 i.e. 16,384.

The output data structure will have the following fields:

  • Magnitude (Forward)
  • Frequency (Forward)
  • Real
  • Imaginary
Limitations

None at this time

Release Notes
Version: 1.3
Released: 8-Aug-2018
Release Notes: Added error endpoint
Version Released Release Notes
1.2 16-Jul-2018 Upgraded to V3
1.1 08-Nov-2017 Moved to Functions sub type vs into Action Agent group
1.0 01-Jun-2017 Initial Release

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

X