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

SVFA Get Spectrum Subset (Sound and Vibration Measurement Suite)

Sound and Vibration Measurement Suite 6.0 Help
December 2007

NI Part Number:
372416A-01

»View Product Info

Extracts the subset of the spectrum specified by range. x0 is updated to reflect the new start frequency, dx is the same as in the input spectrum, and the spectrum array is shortened so the last element corresponds with the stop value specified in the range. Use this VI for operations such as limiting subsequent spectrum operations to the region of interest or removing the part of the spectrum outside the alias-free bandwidth, as well as others. You can use this polymorphic VI to take a subset of a single spectrum, N spectra, a single complex spectrum, or N complex spectra. The data type you wire to the phase spectrum input determines the polymorphic instance to use.

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

SVFA Get Spectrum Subset 1 Ch (real spectrum)

spectrum specifies the abscissa scaling and the magnitude of the spectrum.
x0 specifies the start frequency or order of the spectrum.
dx specifies the frequency or order resolution of the spectrum.
magnitude specifies the magnitude of the spectrum.
range defines the band to extract.
start specifies the lowest frequency or order of interest for the analysis band. The valid range is between 0 and the Nyquist frequency or order. Specify a value of -1 to select the lowest frequency or order as the minimum frequency or order of interest.
stop specifies the highest frequency or order of interest for the analysis band. The valid range is between 0 and the Nyquist frequency or order. Specify a value of -1 to select the highest frequency or order as the maximum frequency or order of interest.
spectrum info specifies properties of the computed spectrum. The properties contained in spectrum info include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
Note  spectrum info must be connected when performing extended measurements. Do not modify the spectrum info values.
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. Refer to Controlling Error Notification 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.
spectrum subset returns the portion of the spectrum within the returned actual range.
x0 returns the start frequency or order of the spectrum.
dx returns the frequency or order resolution of the spectrum.
magnitude returns the magnitude of the spectrum.
unit label returns the engineering units.
actual range returns the coerced start and stop frequencies or orders.
start returns the lowest frequency or order of the spectrum subset.
stop returns the highest frequency or order of the spectrum subset.
range label returns a string containing the coerced frequency or order range.
dup spectrum info returns spectrum info unchanged. Do not modify the dup spectrum info values. The properties contained in spectrum info out include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
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.

SVFA Get Spectrum Subset N Ch (real spectrum)

spectra specifies the data for each spectrum.
spectrum specifies the abscissa scaling and the magnitude of the spectrum.
x0 specifies the start frequency or order of the spectrum.
dx specifies the frequency or order resolution of the spectrum.
magnitude specifies the magnitude of the spectrum.
range defines the band to extract.
start specifies the lowest frequency or order of interest for the analysis band. The valid range is between 0 and the Nyquist frequency or order. Specify a value of -1 to select the lowest frequency or order as the minimum frequency or order of interest.
stop specifies the highest frequency or order of interest for the analysis band. The valid range is between 0 and the Nyquist frequency or order. Specify a value of -1 to select the highest frequency or order as the maximum frequency or order of interest.
spectrum info specifies properties of the computed spectrum. The properties contained in spectrum info include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
Note  spectrum info must be connected when performing extended measurements. Do not modify the spectrum info values.
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. Refer to Controlling Error Notification 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.
spectra subsets returns the portions of the spectra within the returned actual ranges.
spectrum subset returns the portion of the spectrum within the returned actual range.
x0 returns the start frequency or order of the spectrum.
dx returns the frequency or order resolution of the spectrum.
magnitude returns the magnitude of the spectrum.
unit labels returns the unit label for each channel.
actual ranges returns the coerced start and stop frequencies or orders for the returned spectra subsets.
actual range returns the coerced start and stop frequencies or orders.
start returns the lowest frequency or order of the spectrum subset.
stop returns the highest frequency or order of the spectrum subset.
range labels returns an array of strings containing the coerced frequency or order ranges.
dup spectrum info returns spectrum info unchanged. Do not modify the dup spectrum info values. The properties contained in spectrum info out include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
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.

SVFA Get Spectrum Subset 1 Ch (complex spectrum)

complex spectrum specifies the complex form of the spectrum.
complex spectrum contains the complex form of the spectrum.
f0 specifies the start frequency, in hertz, of the spectrum.
df specifies the frequency resolution, in hertz, of the spectrum.
complex array specifies the complex form of the spectrum.
spectrum info specifies properties of the computed spectrum. The properties contained in spectrum info include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
Note  spectrum info must be connected when performing extended measurements. Do not modify the spectrum info values.
range defines the band to extract.
start specifies the lowest frequency or order of interest for the analysis band. The valid range is between 0 and the Nyquist frequency or order. Specify a value of -1 to select the lowest frequency or order as the minimum frequency or order of interest.
stop specifies the highest frequency or order of interest for the analysis band. The valid range is between 0 and the Nyquist frequency or order. Specify a value of -1 to select the highest frequency or order as the maximum frequency or order of interest.
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. Refer to Controlling Error Notification 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.
complex spectrum subset returns the portion of the complex spectrum within the returned actual range.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
complex array returns the complex spectrum subset.
actual range returns the coerced start and stop frequencies or orders.
start returns the lowest frequency or order of the spectrum subset.
stop returns the highest frequency or order of the spectrum subset.
range label returns a string containing the coerced frequency or order range.
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.

SVFA Get Spectrum Subset N Ch (complex spectrum)

complex spectra contains the complex forms of the computed spectra.
complex spectrum specifies the complex form of the spectrum.
complex spectrum contains the complex form of the spectrum.
f0 specifies the start frequency, in hertz, of the spectrum.
df specifies the frequency resolution, in hertz, of the spectrum.
complex array specifies the complex form of the spectrum.
spectrum info specifies properties of the computed spectrum. The properties contained in spectrum info include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
Note  spectrum info must be connected when performing extended measurements. Do not modify the spectrum info values.
range defines the band to extract.
start specifies the lowest frequency or order of interest for the analysis band. The valid range is between 0 and the Nyquist frequency or order. Specify a value of -1 to select the lowest frequency or order as the minimum frequency or order of interest.
stop specifies the highest frequency or order of interest for the analysis band. The valid range is between 0 and the Nyquist frequency or order. Specify a value of -1 to select the highest frequency or order as the maximum frequency or order of interest.
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. Refer to Controlling Error Notification 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.
complex spectra subsets returns the portions of the complex spectra within the returned actual range.
f0 returns the start frequency, in hertz, of the spectrum.
df returns the frequency resolution, in hertz, of the spectrum.
complex array returns the complex spectrum subsets.
actual ranges returns the coerced start and stop frequencies or orders for the returned spectra subsets.
actual range returns the coerced start and stop frequencies or orders.
start returns the lowest frequency or order of the spectrum subset.
stop returns the highest frequency or order of the spectrum subset.
range labels returns an array of strings containing the coerced frequency or order ranges.
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