Table Of Contents

Tone Measurements (Single Tone Measurements) (G Dataflow)

Version:
    Last Modified: March 31, 2017

    Finds the single tone with the highest amplitude in a signal.

    connector_pane_image
    datatype_icon

    export mode

    Source of the signal and spectrum to export.

    Name Description
    none Uses the fastest computation.
    input signal Exports the input signal only.
    detected signal Exports a single tone.
    residual signal Exports a signal minus the tone.

    Default: none

    datatype_icon

    signal

    Input signal.

    This input accepts the following data types:

    • Waveform
    • Waveform in complex double-precision, floating-point numbers
    • 1D array of waveforms
    • 1D array of waveforms in complex double-precision, floating-point numbers
    datatype_icon

    center frequency

    Center frequency to use in the frequency-domain search for the single tone.

    Default: -1

    datatype_icon

    frequency width

    Frequency width, as a percentage of the sampling rate, for the frequency-domain search for the single tone frequency.

    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

    exported spectrum

    Spectrum of the exported signal.

    This output can return a cluster or a 1D array of clusters.

    datatype_icon

    f0

    Start frequency, in Hz, of the spectrum.

    datatype_icon

    df

    Frequency resolution, in Hz, of the spectrum.

    datatype_icon

    spectrum

    Computed spectrum.

    datatype_icon

    exported signal

    Waveform of the exported signal.

    This output can return the following data types:

    • Waveform
    • Waveform in complex double-precision, floating-point numbers
    • 1D array of waveforms
    • 1D array of waveforms in complex double-precision, floating-point numbers
    datatype_icon

    amplitude

    The peak amplitude of the detected tone.

    This output can return a double-precision, floating-point number or a 1D array of double-precision, floating-point numbers.

    datatype_icon

    frequency

    The frequency, in hertz, of the detected tone.

    This output can return a double-precision, floating-point number or a 1D array of double-precision, floating-point numbers.

    datatype_icon

    phase

    Phase, in degrees, of the detected tone.

    This output can return a double-precision, floating-point number or a 1D 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