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

SVT Read Swept Harmonic Components VI

Owning Palette: Read Swept Sine Measurements VIs

Installed With: Sound and Vibration Measurement Suite

Returns total harmonic distortion (THD) and individual harmonics values.

Use the SVT Set Swept Sine Distortion Settings VI to configure the harmonic distortion measurements returned by the SVT Read Swept Harmonic Components VI.

desired units specifies the engineering units of the returned measurements.
THD units specifies the units for THD.
0dB (default)
1Linear ratio
2%
harmonic component amplitude units specifies the units for amplitude in harmonic components.
0EU rms (default)
1EU peak
2EU peak-peak
3dB ref fund
fundamental amplitude units specifies the units for fundamental amplitude.

0EU rms (default)
1EU peak
2EU peak-peak
swept sine task in specifies the swept-sine parameters.
Note  Do not modify the swept sine task in values.
swept sine measurements specifies the swept-sine measurements to perform.
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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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.
unit labels returns the unit label for each member of desired units.
THD unit label returns the unit label for THD.
harmonic component amplitudes unit label returns the unit label for amplitude in harmonic components.
fundamental amplitude unit label returns the unit label for fundamental amplitude.
swept sine task out contains the swept-sine parameters.
dup swept sine measurements returns swept sine measurements unchanged.
THD returns the measured total harmonic distortion (THD) and frequency.
frequency returns the frequency, in hertz, of the fundamental tone at each test frequency.
THD returns the measured total harmonic distortion (THD), which is defined as the ratio of the RMS energy of the harmonics to the RMS energy of the fundamental tone.
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.
harmonic components is an array of the measured harmonic components.
harmonic [i] returns the frequency and distortion for an individual harmonic component.
frequency returns the frequency, in hertz, of the harmonic component to visualize at each test frequency.
distortion returns the measured amplitude of the harmonic component to visualize at each test frequency.
fundamental amplitude returns the fundamental amplitude.
frequency [Hz] returns the frequency, in hertz, of the fundamental tone at each test frequency.
amplitude returns the measured amplitude of the fundamental tone at each test frequency.

Resources


 

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