Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Extract Multiple Tone Information

LabVIEW 8.2 Help
August 2006

NI Part Number:
371361B-01

»View Product Info

Returns the frequency, amplitude, and phase for each signal tone whose amplitude exceeds a specified threshold. The data type you wire to the time signal in input determines the polymorphic instance to use. If you wire an array of waveforms to time signal in, LabVIEW selects the Extract Multiple Tone Information N Chan instance by default.

Use the pull-down menu to select an instance of this VI.

Extract Multiple Tone Information 1 Chan

time signal in is the time-domain waveform.
export signals selects the signal to export to exported signals.

0none—Fastest computation
1input signal
2detected signal—Single sine tone
3residual signal—Signal minus tone
threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it from time signal in.
max num tones specifies the maximum number of tones that this VI extracts. If you set max num tones to –1, this VI extracts all tones whose amplitude exceeds threshold.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
output sorting specifies the sorting order of the tones that this VI extracts.

0increasing frequency
1decreasing amplitude
exported signals contains the signals specified by export signals.
exported time signal is the waveform containing the exported time signal as selected by export signals.
exported spectrum (dB) is the spectrum of the exported time signal as selected by export signals.
f0 is the start frequency of the spectrum expressed in hertz.
df is the frequency resolution of the spectrum expressed in hertz.
dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input signal expressed in dB.
multiple tone information returns the frequency, amplitude, and phase of each sine tone that this VI extracts. Each element of the array is one sine tone.
detected frequency is the frequency of the detected single sine tone in Hz.
detected amplitude is the amplitude of the detected single sine tone in Vp.
detected phase is the phase of the detected single sine tone in degrees.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Extract Multiple Tone Information N Chan

time signals in is an array of time-domain waveforms.
export signals selects the signal to export to exported signals.

0none—Fastest computation
1input signal
2detected signal—Single sine tone
3residual signal—Signal minus tone
threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it from time signals in.
max num tones specifies the maximum number of tones that this VI extracts. If you set max num tones to –1, this VI extracts all tones whose amplitude exceeds threshold.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
output sorting specifies the sorting order of the tones that this VI extracts.

0increasing frequency
1decreasing amplitude
exported signals is an array of exported signals.
exported time signal is the waveform containing the exported time signal as selected by export signals.
exported spectrum (dB) is the spectrum of the exported time signal as selected by export signals.
f0 is the start frequency of the spectrum expressed in hertz.
df is the frequency resolution of the spectrum expressed in hertz.
dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input signal expressed in dB.
multiple tone information returns the frequency, amplitude, and phase of each sine tone that this VI extracts. Each element of the array is the multiple tone information for one signal in time signals in.
detected frequency is the frequency of the detected single sine tone in Hz.
detected amplitude is the amplitude of the detected single sine tone in Vp.
detected phase is the phase of the detected single sine tone in degrees.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Extract Multiple Tone Information N Chan - N Specs

time signals in is an array of time-domain waveforms.
export signals selects the signals to export to exported signals.

0none—Fastest computation
1input signal
2detected signal—Single sine tone
3residual signal—Signal minus tone
threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it from time signals in. Each element of the array is the threshold for one signal in time signals in.
max num tones specifies the maximum number of tones that this VI extracts from each signal. If you set max num tones to –1, this VI extracts all tones whose amplitude exceeds threshold.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
output sorting specifies the sorting order of the tones that this VI extracts.

0increasing frequency
1decreasing amplitude
exported signals is an array of exported signals.
exported time signal is the waveform containing the exported time signal as selected by export signals.
exported spectrum (dB) is the spectrum of the exported time signal as selected by export signals.
f0 is the start frequency of the spectrum expressed in hertz.
df is the frequency resolution of the spectrum expressed in hertz.
dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input signal expressed in dB.
multiple tone information returns the frequency, amplitude, and phase of each sine tone that this VI extracts. Each element of the array is the multiple tone information for one signal in time signals in.
detected frequency is the frequency of the detected single sine tone in Hz.
detected amplitude is the amplitude of the detected single sine tone in Vp.
detected phase is the phase of the detected single sine tone in degrees.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit