Table Of Contents

Tone Measurements (Multiple Tone Measurements) (G Dataflow)

Last Modified: January 12, 2018

Extracts tones from a signal and returns their frequency, amplitude, and phase.

connector_pane_image
datatype_icon

export mode

Source of the signal and spectrum to export.

This input accepts an array of enums if signal is an array of waveforms.

Name Description
none Uses the fastest computation.
input signal Exports the input signal only.
detected signal Exports a multiple 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

threshold

Minimum amplitude that each tone must exceed.

This input accepts an array of double-precision floating-point numbers if signal is an array of waveforms.

Default: 0.001

datatype_icon

max number of tones

Maximum number of tones that this node extracts. This input must be greater than 0.

This input accepts an array of 32-bit signed integers if signal is an array of waveforms.

Default: 4

datatype_icon

sorting

The sorting order of the tones that this node extracts.

Name Description
increasing frequency

Sorts the tones by increasing frequency.

decreasing amplitude

Sorts the tones by decreasing amplitude.

Default: increasing frequency

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

Peak amplitude of each detected tone.

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

datatype_icon

frequency

Frequency, in Hz, of each detected tone.

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

datatype_icon

phase

Phase, in degrees, of each detected tone.

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

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

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics