LabVIEW Sound and Vibration API Reference

SVT Gain and Phase VI

  • Updated2024-06-18
  • 10 minute(s) read

SVT Gain and Phase VI

Owning Palette: Tone and Distortion VIs

Requires: Sound and Vibration Toolkit

Computes the gain and phase between stimulus signal X and response signal Y at the fundamental frequency. This VI returns the detected fundamental frequency, detected response amplitude, gain, and phase lag. This VI does not maintain state internally; you can use this VI in a loop to process multiple blocks. Wire data to the stimulus signal X [Eux] and response signal Y [Euy] inputs to determine the polymorphic instance to use or manually select the instance.

Example

SVT Gain and Phase (Time)

desired units specifies the engineering units of the returned measurements.
gain specifies the units for gain.

0dB (default)
1Linear ratio
phase specifies the units for phase measurements.

0deg (default)
1rad
detected tone stimulus amplitude units specifies the units for the amplitude of the fundamental tone as measured on the stimulus channel.

0EU rms (default)
1EU peak
2EU peak-peak
detected tone response amplitude units specifies the units for the amplitude of the fundamental tone as measured on the response channel.

0EU rms (default)
1EU peak
2EU peak-peak
stimulus signal X [EUx] specifies the scaled signal acquired from the stimulus channel expressed in the selected engineering units.
t0 specifies the start time of the waveform.
dt specifies the time interval in seconds between data points in the waveform.
Y specifies the data values of the waveform.
response signal Y [EUy] specifies the scaled response signal expressed in the selected engineering units.
t0 specifies the start time of the waveform.
dt specifies the time interval in seconds between data points in the waveform.
Y specifies the data values of the waveform.
advanced span [Hz] specifies a frequency span centered at the identified fundamental frequency in which noise and spurious components are ignored for the measurement. Specify a value of 0 if the frequency is known and time invariant. Specify a value of –1 to permit the measurement to automatically compute the minimum frequency span suitable for the time-domain window applied to the signal. The default is –0 Hz.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
expected fundamental frequency specifies the expected frequency of the fundamental tone in hertz. Use expected fundamental frequency when the fundamental tone is not the largest amplitude component of the input signal. The default is –1.00 Hz.
unit labels returns the unit label for each member of desired units.
gain unit label returns a string that corresponds to the selected gain units.
phase unit label returns the unit label for the selected phase units.
detected tone stimulus amplitude unit label returns a string that corresponds to the selected amplitude units for the amplitude of the fundamental tone as measured on the stimulus channel.
detected tone response amplitude unit label returns a string that corresponds to the selected amplitude units for the amplitude of the fundamental tone as measured on the response channel.
complex spectrum stimulus X returns the complex form of the computed spectrum for the stimulus channel.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
complex spectrum returns the complex form of the computed spectrum.
complex spectrum response Y returns the complex form of the computed spectrum for the response channel.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
complex spectrum returns the complex form of the computed spectrum.
gain returns the ratio of the response amplitude to the stimulus amplitude.
phase lag returns the phase delay of the tone at the detected fundamental frequency between the stimulus and response channels.
error out contains error information. This output provides standard error out functionality.
detected tone stimulus returns frequency and amplitude of the detected stimulus tone.
frequency [Hz] returns the frequency of the detected tone in Hertz.
amplitude returns the amplitude of the detected tone.
detected tone response returns the frequency and amplitude of the detected response tone.
frequency [Hz] returns the frequency of the detected tone in Hertz.
amplitude returns the amplitude of the detected tone.

SVT Gain and Phase (Spectrum)

desired units specifies the engineering units of the returned measurements.
gain specifies the units for gain.

0dB (default)
1Linear ratio
phase specifies the units for phase measurements.

0deg (default)
1rad
detected tone stimulus amplitude units specifies the units for the amplitude of the fundamental tone as measured on the stimulus channel.

0EU rms (default)
1EU peak
2EU peak-peak
detected tone response amplitude units specifies the units for the amplitude of the fundamental tone as measured on the response channel.

0EU rms (default)
1EU peak
2EU peak-peak
complex spectrum stimulus X specifies the complex form of the computed spectrum for the stimulus channel.
f0 specifies the start frequency, in hertz, of the spectrum.
df specifies the frequency resolution, in hertz, of the spectrum.
complex spectrum specifies the complex form of the computed spectrum.
complex spectrum response Y specifies the complex form of the computed spectrum for the response channel.
f0 specifies the start frequency, in hertz, of the spectrum.
df specifies the frequency resolution, in hertz, of the spectrum.
complex spectrum specifies the complex form of the computed spectrum.
advanced span [Hz] specifies a frequency span centered at the identified fundamental frequency in which noise and spurious components are ignored for the measurement. Specify a value of 0 if the frequency is known and time invariant. Specify a value of –1 to permit the measurement to automatically compute the minimum frequency span suitable for the time-domain window applied to the signal. The default is –0 Hz.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
expected fundamental frequency specifies the expected frequency of the fundamental tone in hertz. Use expected fundamental frequency when the fundamental tone is not the largest amplitude component of the input signal. The default is –1.00 Hz.
unit labels returns the unit label for each member of desired units.
gain unit label returns a string that corresponds to the selected gain units.
phase unit label returns the unit label for the selected phase units.
detected tone stimulus amplitude unit label returns a string that corresponds to the selected amplitude units for the amplitude of the fundamental tone as measured on the stimulus channel.
detected tone response amplitude unit label returns a string that corresponds to the selected amplitude units for the amplitude of the fundamental tone as measured on the response channel.
dup complex spectrum stimulus X returns complex spectrum stimulus X unchanged.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
complex spectrum returns the complex form of the computed spectrum.
dup complex spectrum response Y returns complex spectrum response Y unchanged.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
complex spectrum returns the complex form of the computed spectrum.
gain returns the ratio of the measured response amplitude to the measured stimulus amplitude at the detected fundamental frequency.
phase lag returns the phase delay of the tone at the detected fundamental frequency between the stimulus and response channels.
error out contains error information. This output provides standard error out functionality.
detected tone stimulus returns frequency and amplitude of the detected stimulus tone.
frequency [Hz] returns the frequency of the detected tone in Hertz.
amplitude returns the amplitude of the detected tone.
detected tone response returns the frequency and amplitude of the detected response tone.
frequency [Hz] returns the frequency of the detected tone in Hertz.
amplitude returns the amplitude of the detected tone.

Example

Refer to the One Shot Gain Phase and Distortion (DAQmx) VI in the labview\examples\Sound and Vibration\Audio Measurements directory for an example of using the SVT Gain and Phase VI.

Log in to get a better experience