Table Of Contents

FFT (G Dataflow)

Version:
    Last Modified: March 30, 2017

    Computes the fast Fourier transform (FFT) of a sequence.

    connector_pane_image
    datatype_icon

    reset

    A Boolean that specifies whether to reset the internal state of the node.

    True Resets the internal state of the node.
    False Does not reset the internal state of the node.

    This input is available only if you wire a double-precision, floating-point number or a complex double-precision, floating-point number to x.

    Default: False

    datatype_icon

    x

    Input signal.

    This input accepts the following data types:

    • Double-precision, floating-point number
    • Complex double-precision, floating-point number
    • 1D array of double-precision, floating-point numbers
    • 1D array of complex double-precision, floating-point numbers
    • 2D array of double-precision, floating-point numbers
    • 2D array of complex double-precision, floating-point numbers
    datatype_icon

    FFT size

    Length of the FFT you want to perform.

    This input changes to m if you wire a 2D array of double-precision, floating-point numbers or a 2D array of complex double-precision, floating-point numbers to x.

    Node Behavior When x is a 1D Array of Numbers

    When you wire a 1D array of double-precision, floating-point numbers or a 1D array of complex double-precision, floating-point numbers to x, if FFT size is greater than the number of elements in x, this node adds zeros to the end of x to match the size of FFT size. If FFT size is less than the number of elements in x, this node uses only the first n elements in x to perform the FFT, where n is FFT size. If FFT size is less than or equal to 0, this node uses the length of x as the FFT size.

    Node Behavior When x is a Single Data Point

    When you wire a double-precision, floating-point number or a complex double-precision, floating-point number to x, if FFT size is greater than sample length, this node collects data according to sample length but adds zeros to the end of the data set to match the size of FFT size. If FFT size is less than sample length, this node ignores sample length and uses only the first n elements in the data set to perform the FFT, where n is FFT size. If FFT size is less than or equal to 0, this node uses sample length as the FFT size.

    Default: -1

    datatype_icon

    m

    Number of rows of the 2D FFT. This node truncates or zero-pads x to an m × n array before performing the FFT.

    This input is available only if you wire a 2D array of double-precision, floating-point numbers or a 2D array of complex double-precision, floating-point numbers to x.

    Default: -1

    datatype_icon

    sample length

    Length of each set of data. The node performs computation for each set of data.

    sample length must be greater than zero.

    This input is available only if you wire a double-precision, floating-point number or a complex double-precision, floating-point number to x.

    Default: 100

    datatype_icon

    n

    Number of columns of the 2D FFT. This node truncates or zero-pads x to an m × n array before performing the FFT.

    This input is available only if you wire a 2D array of double-precision, floating-point numbers or a 2D array of complex double-precision, floating-point numbers to x.

    Default: -1

    datatype_icon

    shift?

    A Boolean that determines whether the DC component is at the center of the FFT of the input sequence.

    True The DC component is at the center of the FFT{x}.
    False The DC component is not at the center of the FFT{x}.

    This input is available only if you wire one of the following data types to x:

    • 1D array of double-precision, floating-point numbers
    • 1D array of complex double-precision, floating-point numbers
    • 2D array of double-precision, floating-point numbers
    • 2D array of complex double-precision, floating-point numbers

    How This Input Affects 1D FFT

    The following table illustrates the pattern of the elements of FFT{x} with various length of the FFT, when shift? is False. Y is FFT{x} and n is the length of the FFT:

    n is even (k = n/2) n is odd (k = (n-1)/2)
    Array Element Corresponding Frequency Array Element Corresponding Frequency
    Y0 DC component Y0 DC component
    Y1 Δf Y1 Δf
    Y2 f Y2 f
    Y3 f Y3 f
    Yk-2 (k - 2)Δf Yk-2 (k - 2)Δf
    Yk-1 (k - 1)Δf Yk-1 (k - 1)Δf
    Yk Nyquist Frequency Yk kΔf
    Yk+1 -(k - 1)Δf Yk+1 -kΔf
    Yk+2 -(k - 2)Δf Yk+2 -(k - 1)Δf
    Yn-3 -3Δf Yn-3 -3Δf
    Yn-2 -2Δf Yn-2 -2Δf
    Yn-1 f Yn-1 f

    The following table illustrates the pattern of the elements of FFT{x} with various length of the FFT, when shift? is True. Y is FFT{x} and n is the length of the FFT:

    n is even (k = n/2) n is odd (k = (n-1)/2)
    Array Element Corresponding Frequency Array Element Corresponding Frequency
    Y0 -(Nyquist Frequency) Y0 -kΔf
    Y1 -(k - 1)Δf Y1 -(k - 1)Δf
    Y2 -(k - 2)Δf Y2 -(k - 2)Δf
    Y3 -(k - 3)Δf Y3 -(k - 3)Δf
    Yk-2 -2Δf Yk-2 -2Δf
    Yk-1 f Yk-1 f
    Yk DC component Yk DC component
    Yk+1 Δf Yk+1 Δf
    Yk+2 f Yk+2 f
    Yn-3 (k - 3)Δf Yn-3 (k - 2)Δf
    Yn-2 (k - 2)Δf Yn-2 (k - 1)Δf
    Yn-1 (k - 1)Δf Yn-1 kΔf

    How This Input Affects 2D FFT

    The illustration below shows the effect of shift? on the 2D FFT result:

    2D input signals FFT without shift FFT with shift

    Default: False

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    FFT{x}

    FFT of the input signal.

    This output can be a 1D or 2D array of complex double-precision, floating-point numbers.

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Algorithm Definition for 1D FFT

    For 1D signals, this node computes the discrete Fourier transform (DFT) of the input sequence with a fast Fourier transform algorithm. The 1D DFT is defined as:

    Y k = n = 0 N 1 x n e j 2 π k n / N for n = 0 , 1 , 2 , ... , N 1

    where x is the input sequence, N is the number of elements of x, and Y is the transform result.

    The frequency resolution, or the frequency spacing between the components of Y, is:

    Δ f = f s N

    where fs is the sampling frequency.

    Algorithm Definition for 2D FFT

    For 2D signals, this node computes the discrete Fourier transform (DFT) of the input matrix. This node performs a 1D FFT on the rows of the input matrix and then performs a 1D FFT on the columns of the output of the preceding step. The DFT of an M-by-N matrix is defined as:

    Y ( u , v ) = m = 0 M 1 n = 0 N 1 x ( m , n ) e j 2 π m u / M e j 2 π n v / N for u = 0 , 1 , ... , M 1 , v = 0 , 1 , ... , N 1

    where x is the input matrix and Y is the transform result.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics