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

SVFA Zoom FFT Spectrum (Mag-Phase) VI

Owning Palette: Zoom FFT VIs

Installed With: Sound and Vibration Measurement Suite

Computes the zoom FFT spectrum based on scaled signal [EU] and zoom settings. Zoom FFT results are returned in magnitude [dB EU] and phase [degrees]. Data is accumulated each time this VI is called. However, it returns a new spectrum only when sufficient data has been accumulated. Indicators and subsequent processing should only be called when new spectrum available is TRUE. The data type you wire to the scaled signal [EU] input determines the polymorphic instance to use.

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

SVFA Zoom FFT Spectrum (Mag-Phase) (1 Ch)

scaled signal [EU] specifies the scaled signal expressed in the selected engineering units. To obtain a properly scaled signal, you can use the SVL Scale Voltage to EU VI or define a virtual channel in National Instruments Measurement & Automation Explorer (MAX).
t0 is the start time of the waveform.
dt is the time interval in seconds between data points in the waveform.
Y contains the data values of the waveform.
zoom settings determines the properties of the zoom analysis.
frequency range defines the frequency band of analysis. The valid range for the start frequency and for the stop frequency is between 0 and the Nyquist frequency.
start frequency specifies the lowest frequency of interest for the analysis band in hertz. The valid range is between 0 and the Nyquist frequency.
stop frequency specifies the highest frequency of interest for the analysis band in hertz. The valid range is between 0 and the Nyquist frequency. Specify a value of –1 to select the highest frequency as the maximum frequency of interest.
window specifies the time-domain window used.
Note  The Zoom FFT VIs do not apply the window to each incoming block of data. Instead, the Zoom FFT VIs apply the window to the decimated set of data used by the Discrete Zak Transform (DZT).
0None
1Hanning (default)
2Hamming
3Blackman-Harris
4Exact Blackman
5Blackman
6Flat Top
74 Term B-Harris
87 Term B-Harris
9Low Sidelobe
number of lines specifies the number of spectral lines to compute between start frequency and stop frequency. number of lines determines the size of the FFT that is computed.
% overlap specifies the percentage of data reused by consecutive FFT computations. The valid range is between 0 and 100. You can use % overlap to make the zoom more responsive when the values of frequency range and number of lines require a longer measurement time.The Zoom FFT VIs typically do not return a spectrum each time the VI is called. You can use % overlap to increase the rate at which a new spectrum is computed by reusing acquired data. For example, setting % overlap to 50 causes the VI to compute a new zoom spectrum twice as often as a setting of 0 because half the data is reused with each computation.
view defines how the different results from this VI are returned. view allows you to choose whether magnitude results are displayed in dB, phase results are unwrapped, and phase results are converted from radians to degrees.
dB On specifies if results are expressed in decibels. The default is TRUE.
unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates discontinuities that have an absolute value greater than pi. The default is FALSE, meaning the phase is not unwrapped. When unwrap phase is TRUE, the phase is unwrapped.
convert to degree specifies whether the phase results are converted from radians to degrees. The default is FALSE, which means that results are expressed in radians.
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.
averaging parameters defines how the VI computes the averaging.
Note  If averaging mode is set to No averaging, the VI ignores the weighting mode, number of averages, and linear mode parameters.
averaging mode specifies the averaging mode.

0No averaging (default)
1Vector averaging (unavailable)
2RMS averaging
3Peak hold
weighting mode specifies the weighting mode.
Note  RMS and linear averaging support linear weighting and exponential weighting.


0Linear
1Exponential (default)
number of averages specifies the number of averages used by the selected weighting mode. If weighting mode is set to Linear, the measurement stops or automatically restarts after the value of number of averages has been reached. Whether the measurement stops or automatically restarts depends on the linear mode setting.
linear mode specifies the behavior of the averaging if you set the value of the weighting mode parameter to Linear. If you set weighting mode to Exponential, linear mode is ignored.

0One shot (default)—Specifies that the averaging process stops once the value of number of averages is reached.
1Auto restart—Specifies that the averaging process automatically restarts after the value of number of averages is reached.
restart averaging specifies if the selected averaging process has to be restarted. The default is FALSE. When you call this VI for the first time, the averaging process restarts automatically.
new spectrum available, when TRUE, indicates that the output data is valid, or not empty. Use the output value as the switch to a Case structure. You can perform subsequent measurements or display the results in the TRUE case of the Case structure.
magnitude [dB EU] returns the magnitude of the FFT spectrum.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
magnitude returns the magnitude of the FFT spectrum.
magnitude unit label returns the unit label for the selected magnitude units.
phase [degrees] returns the phase of the FFT spectrum.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
phase returns the phase of the FFT spectrum.
phase unit label returns the unit label for the selected phase units.
spectrum info returns information about the spectrum needed by the Spectrum Extended Measurements VIs, the Waterfall Display VIs, the Distortion VIs, and the Single Tone Measurements VIs. Do not modify the spectrum info values.
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.
averages completed returns the number of averages completed by the VI at that time.
averaging done returns TRUE when the number of averages completed equals or exceeds the number of averages specified in averaging parameters and new spectrum available is TRUE. Otherwise, averaging done returns FALSE. averaging done is always TRUE if averaging mode is No averaging.

SVFA Zoom FFT Spectrum (Mag-Phase) (N Ch)

scaled signals [EU] specifies the scaled signals expressed in the selected engineering units. To obtain a properly scaled signal, you can use the SVL Scale Voltage to EU VI or define a virtual channel in National Instruments Measurement & Automation Explorer (MAX).
zoom settings determines the properties of the zoom analysis.
frequency range defines the frequency band of analysis. The valid range for the start frequency and for the stop frequency is between 0 and the Nyquist frequency.
start frequency specifies the lowest frequency of interest for the analysis band in hertz. The valid range is between 0 and the Nyquist frequency.
stop frequency specifies the highest frequency of interest for the analysis band in hertz. The valid range is between 0 and the Nyquist frequency. Specify a value of –1 to select the highest frequency as the maximum frequency of interest.
window specifies the time-domain window used.
Note  The Zoom FFT VIs do not apply the window to each incoming block of data. Instead, the Zoom FFT VIs apply the window to the decimated set of data used by the Discrete Zak Transform (DZT).


0None
1Hanning (default)
2Hamming
3Blackman-Harris
4Exact Blackman
5Blackman
6Flat Top
74 Term B-Harris
87 Term B-Harris
9Low Sidelobe
number of lines specifies the number of spectral lines to compute between start frequency and stop frequency. number of lines determines the size of the FFT that is computed.
% overlap specifies the percentage of data reused by consecutive FFT computations. The valid range is between 0 and 100. You can use % overlap to make the zoom more responsive when the values of frequency range and number of lines require a longer measurement time.

The Zoom FFT VIs typically do not return a spectrum each time the VI is called. You can use % overlap to increase the rate at which a new spectrum is computed by reusing acquired data. For example, setting % overlap to 50 causes the VI to compute a new zoom spectrum twice as often as a setting of 0 because half the data is reused with each computation.
view defines how the different results from this VI are returned. view allows you to choose whether magnitude results are displayed in dB, phase results are unwrapped, and phase results are converted from radians to degrees.
dB On specifies if results are expressed in decibels. The default is TRUE.
unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates discontinuities that have an absolute value greater than pi. The default is FALSE, meaning the phase is not unwrapped. When unwrap phase is TRUE, the phase is unwrapped.
convert to degree specifies whether the phase results are converted from radians to degrees. The default is FALSE, which means that results are expressed in radians.
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.
averaging parameters defines how the VI computes the averaging.
Note  If averaging mode is set to No averaging, the VI ignores the weighting mode, number of averages, and linear mode parameters.
averaging mode specifies the averaging mode.

0No averaging (default)
1Vector averaging (unavailable)
2RMS averaging
3Peak hold
weighting mode specifies the weighting mode.
Note  RMS and linear averaging support linear weighting and exponential weighting.


0Linear
1Exponential (default)
number of averages specifies the number of averages used by the selected weighting mode. If weighting mode is set to Linear, the measurement stops or automatically restarts after the value of number of averages has been reached. Whether the measurement stops or automatically restarts depends on the linear mode setting.
linear mode specifies the behavior of the averaging if you set the value of the weighting mode parameter to Linear. If you set weighting mode to Exponential, linear mode is ignored.

0One shot (default)—Specifies that the averaging process stops once the value of number of averages is reached.
1Auto restart—Specifies that the averaging process automatically restarts after the value of number of averages is reached.
restart averaging specifies if the selected averaging process has to be restarted. The default is FALSE. When you call this VI for the first time, the averaging process restarts automatically.
new spectrum available, when TRUE, indicates that the output data is valid, or not empty. Use the output value as the switch to a Case structure. You can perform subsequent measurements or display the results in the TRUE case of the Case structure.
magnitudes [dB EU] returns the magnitude of each spectrum.
magnitude [dB EU] returns the magnitude of the FFT spectrum.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
magnitude returns the magnitude of the FFT spectrum.
magnitude unit labels returns the magnitude unit label of each spectrum.
phases [degrees] returns the phase of each spectrum.
phase [degrees] returns the phase of the FFT spectrum.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
phase returns the phase of the FFT spectrum.
phase unit labels returns the phase unit label of each spectrum.
spectrum info returns information about the spectrum needed by the Spectrum Extended Measurements VIs, the Waterfall Display VIs, the Distortion VIs, and the Single Tone Measurements VIs. Do not modify the spectrum info values.
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.
averages completed returns the number of averages completed by the VI at that time.
averaging done returns TRUE when the number of averages completed equals or exceeds the number of averages specified in averaging parameters and new spectrum available is TRUE. Otherwise, averaging done returns FALSE. averaging done is always TRUE if averaging mode is No averaging.

Resources


 

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