You are here: NI Home > Support > Product Reference > Manuals > Sound and Vibration Measurement Suite 6.0 Help

Wraps the phase spectra to the specified range, so that all phase values are coerced to the specified band. You also can use this VI to unwrap phase spectra to eliminate discontinuities with absolute values exceeding 180 degrees = pi radians = 0.5 cycles. You can use this polymorphic VI to wrap/unwrap a single spectrum, N spectra, a single channel of XY data, or N channels of XY data. The data type you wire to the phase spectrum in input determines the polymorphic instance to use.

Details  

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

Select an instance SVFA Wrap or Unwrap Phase 1 ChSVFA Wrap or Unwrap Phase N ChSVFA Wrap or Unwrap Phase 1 Ch (XY Spectrum)SVFA Wrap or Unwrap Phase N Ch (XY Spectrum)

SVFA Wrap or Unwrap Phase 1 Ch

	phase spectrum in contains the frequency spacing and the phase of the spectrum. The units for phase spectrum in are specified in spectrum info. f0 specifies the start frequency, in hertz, of the spectrum. df specifies the frequency resolution, in hertz, of the spectrum. phase specifies the phase of the spectrum.
	desired wrapping specifies whether the returned phase wraps to the selected range or unwraps to remove discontinuities in the phase spectrum greater than pi. 0 No change 1 Unwrap 2 Wrap: –360 to 0 3 Wrap: –270 to 90 4 Wrap: –180 to 180 (default) 5 Wrap: –90 to 270 6 Wrap: 0 to 360 7 Wrap: custom range
	custom wrap range specifies the range for the returned phase spectrum when desired wrapping is Wrap: custom range. The custom range must span at least 2pi = 360 deg = 1 cycle to guarantee that each phase can be mapped to the desired range. If the custom range is greater than 2pi = 360 deg = 1 cycle, the minimum correction is applied to each phase value to map the value to the desired range. Enter minimum phase and maximum phase with the same units as phase spectrum in. minimum phase specifies the minimum phase of the spectrum. maximum phase specifies the maximum phase of the spectrum.
	spectrum info specifies the 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.
	phase spectrum out returns the phase spectrum wrapped or unwrapped according to the desired wrapping. 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 spectrum.
	unit label returns the selected engineering units.
	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 Wrap or Unwrap Phase N Ch

	phase spectra in contains the frequency spacing and the phase for each spectrum. The units for phase spectra in are specified in spectrum info. phase spectrum in contains the frequency spacing and the phase of the spectrum. The units for phase spectrum in are specified in spectrum info. f0 specifies the start frequency, in hertz, of the spectrum. df specifies the frequency resolution, in hertz, of the spectrum. phase specifies the phase of the spectrum.
	desired wrapping specifies whether the returned phase wraps to the selected range or unwraps to remove discontinuities in the phase spectrum greater than pi. 0 No change 1 Unwrap 2 Wrap: –360 to 0 3 Wrap: –270 to 90 4 Wrap: –180 to 180 (default) 5 Wrap: –90 to 270 6 Wrap: 0 to 360 7 Wrap: custom range
	custom wrap range specifies the range for the returned phase spectrum when desired wrapping is Wrap: custom range. The custom range must span at least 2pi = 360 deg = 1 cycle to guarantee that each phase can be mapped to the desired range. If the custom range is greater than 2pi = 360 deg = 1 cycle, the minimum correction is applied to each phase value to map the value to the desired range. Enter minimum phase and maximum phase with the same units as phase spectrum in. minimum phase specifies the minimum phase of the spectrum. maximum phase specifies the maximum phase of the spectrum.
	spectrum info specifies the properties of the computed spectrum. spectrum info specifies the 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.
	phase spectra out returns the phase spectra wrapped or unwrapped according to the desired wrapping. phase spectrum out returns the phase spectrum wrapped or unwrapped according to the desired wrapping. X returns the abscissa of the phase spectrum. phase returns the phase of the spectrum.
	unit labels returns the unit label for each channel.
	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 Wrap or Unwrap Phase 1 Ch (XY Spectrum)

	phase spectrum in specifies the abscissa values and the phase of the spectrum. The units for phase spectrum in are specified in spectrum info. X specifies the abscissa of the phase spectrum. phase specifies the phase of the spectrum.
	desired wrapping specifies whether the returned phase wraps to the selected range or unwraps to remove discontinuities in the phase spectrum greater than pi. 0 No change 1 Unwrap 2 Wrap: –360 to 0 3 Wrap: –270 to 90 4 Wrap: –180 to 180 (default) 5 Wrap: –90 to 270 6 Wrap: 0 to 360 7 Wrap: custom range
	custom wrap range specifies the range for the returned phase spectrum when desired wrapping is Wrap: custom range. The custom range must span at least 2pi = 360 deg = 1 cycle to guarantee that each phase can be mapped to the desired range. If the custom range is greater than 2pi = 360 deg = 1 cycle, the minimum correction is applied to each phase value to map the value to the desired range. Enter minimum phase and maximum phase with the same units as phase spectrum in. minimum phase specifies the minimum phase of the spectrum. maximum phase specifies the maximum phase of the spectrum.
	spectrum info specifies the 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.
	phase spectrum out returns the phase spectrum wrapped or unwrapped according to the desired wrapping. X returns the abscissa of the phase spectrum. phase returns the phase of the spectrum.
	unit label returns the selected engineering units.
	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 Wrap or Unwrap Phase N Ch (XY Spectrum)

	phase spectra in contains the abscissa values and the phase for each spectrum. The units for phase spectra in are specified in spectrum info. phase spectrum in specifies the abscissa values and the phase of the spectrum. The units for phase spectrum in are specified in spectrum info. X specifies the abscissa of the phase spectrum. phase specifies the phase of the spectrum.
	desired wrapping specifies whether the returned phase wraps to the selected range or unwraps to remove discontinuities in the phase spectrum greater than pi. 0 No change 1 Unwrap 2 Wrap: –360 to 0 3 Wrap: –270 to 90 4 Wrap: –180 to 180 (default) 5 Wrap: –90 to 270 6 Wrap: 0 to 360 7 Wrap: custom range
	custom wrap range specifies the range for the returned phase spectrum when desired wrapping is Wrap: custom range. The custom range must span at least 2pi = 360 deg = 1 cycle to guarantee that each phase can be mapped to the desired range. If the custom range is greater than 2pi = 360 deg = 1 cycle, the minimum correction is applied to each phase value to map the value to the desired range. Enter minimum phase and maximum phase with the same units as phase spectrum in. minimum phase specifies the minimum phase of the spectrum. maximum phase specifies the maximum phase of the spectrum.
	spectrum info specifies the properties of the computed spectrum. spectrum info specifies the 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.
	phase spectra out returns the phase spectra wrapped or unwrapped according to the desired wrapping. phase spectrum out returns the phase spectrum wrapped or unwrapped according to the desired wrapping. X returns the abscissa of the phase spectrum. phase returns the phase of the spectrum.
	unit labels returns the unit label for each channel.
	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 Wrap or Unwrap Phase Details

You can use wrapped values for display, because you can restrict the range of phase values to a span of 360 degrees. Unwrapped phase values can show the phase spectrum more clearly in frequency ranges dominated by time delay or resonances.