Table Of Contents

Inverse f Filter (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Designs and implements an IIR filter whose magnitude-squared response is inversely proportional to frequency over a specified frequency range. You can use the inverse-f filter to colorize spectrally flat, or white, noise.

    connector_pane_image
    datatype_icon

    exponent

    Exponent of the desired inverse-f spectral shape. This node designs a digital filter with the desired magnitude-squared response of 1/frequencyexponent.

    Default: 1

    datatype_icon

    reset

    A Boolean that specifies the initialization of the internal state of the node.

    True Initializes the internal state to zero.
    False Initializes the internal state to the final state from the previous call of this node.

    This node automatically initializes the internal state to zero on the first call and runs continuously until this input is True.

    Default: False

    datatype_icon

    signal

    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
    datatype_icon

    low cutoff frequency

    Lower frequency edge of the operating frequency range of the filter.

    Default: 0.1

    datatype_icon

    high cutoff frequency

    Higher frequency edge of the operating frequency range of the filter.

    Default: 100

    datatype_icon

    order

    Number of first order stages of the inverse-f filter.

    Increasing order improves the inverse-f spectral shape but requires more computation time during the filter operation.

    Default: 5

    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

    sampling frequency

    The design sample rate in samples/second.

    Default: 1000

    datatype_icon

    unity gain frequency

    Frequency, in radians per second, at which the ideal inverse-f filter response has unity gain.

    The actual inverse-f filter is designed to approximate the ideal filter over the frequency range defined by low cutoff frequency, high cutoff frequency, and order. Therefore, the actual gain of the filter at unity gain frequency is near unity only if unity gain frequency is within the design frequency range specified in low cutoff frequency, high cutoff frequency, and order.

    Default: 1

    datatype_icon

    filtered signal

    Filtered signal.

    This output can return 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
    datatype_icon

    filter information

    Magnitude and phase of the frequency response of the designed inverse-f filter.

    datatype_icon

    magnitude (dB)

    Magnitude of the frequency response of the designed inverse-f filter in dB.

    datatype_icon

    frequency (Hz)

    Frequencies of the frequency response of the designed inverse-f filter in Hz.

    datatype_icon

    magnitude (dB)

    Magnitudes of the frequency response of the designed inverse-f filter in dB.

    datatype_icon

    phase (deg)

    Phase of the frequency response of the designed inverse-f filter in degrees.

    datatype_icon

    frequency (Hz)

    Frequencies of the frequency response of the designed inverse-f filter in Hz.

    datatype_icon

    phase (deg)

    Phases of the frequency response of the designed inverse-f filter in degrees.

    datatype_icon

    magnitude error

    Magnitude of the deviation of the actual inverse-f filter, in decibels, when measured against the ideal inverse-f filter.

    The ideal filter has a magnitude-squared response proportional to 1/f exponent over the frequency range specified by low cutoff frequency, high cutoff frequency, and order.

    datatype_icon

    frequency (Hz)

    Frequencies of the magnitude error in Hz.

    datatype_icon

    magnitude (dB)

    Magnitudes of the magnitude error in dB.

    datatype_icon

    noise bandwidth

    Expected noise bandwidth of the designed inverse-f filter.

    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.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics