Table Of Contents

Filter (Lowpass » Butterworth) (G Dataflow)

Version:
    Last Modified: March 31, 2017

    Filters a signal using a Butterworth lowpass filter. Lowpass filters pass low frequencies and attenuate high frequencies.

    connector_pane_image
    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:

    • Waveform
    • Double-precision, floating-point number
    • Complex double-precision, floating-point number
    • 1D array of waveforms
    • 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
    datatype_icon

    cutoff frequency

    Cutoff frequency of the filter.

    Default: 0.125

    datatype_icon

    order

    Order of the filter.

    Default: 2

    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

    Sampling frequency in Hz. sampling frequency must be greater than zero.

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

    • 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

    Default: 1, which is the normalized sampling frequency

    datatype_icon

    filtered signal

    Result of filtering the input signal.

    This output can return the following data types:

    • Waveform
    • Double-precision, floating-point number
    • Complex double-precision, floating-point number
    • 1D array of waveforms
    • 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
    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