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

OAT Order Magnitude and Phase VI

Owning Palette: Order Analysis VIs

Installed With: Sound and Vibration Measurement Suite

Computes the magnitudes and phases of designated orders in an even-angle signal. The data type you wire to the even-angle signal input or the order waveforms [EU] input determines the polymorphic instance to use.

Example

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

OAT Order Magnitude and Phase (Even Angle Signal, 1 Channel)

reset? specifies the initialization of the internal states. The first time this VI runs, or when reset? is TRUE, the internal states initialize to zero. If reset? is FALSE, this VI sets the internal states to the final states from the previous call to the VI. The default is FALSE.
x-axis selection specifies the scale type to use for the x-axis of the output XY plot.
0Time
1Revolution
2RPM (Default)
even-angle signal specifies the even-angle-resampled data. even-angle signal is synchronous to the rotational speed with a constant number of samples per revolution.
r0 specifies the starting index value for counting revolutions.
dr specifies the revolution interval between two sequential samples.
Y specifies the value of the even-angle-spaced sample in a scaled engineering unit.
even-angle channel info specifies the information about the measurement configuration that this VI uses to acquire the resampled data. Do not change the values in even-angle channel info.
even-angle position info specifies the position information of the even-angle signal.
positions [s] specifies the locations of the samples, in seconds.
samples/rev specifies the number of samples in each revolution.
orders to compute specifies the orders to use to compute the magnitude and phase. The default is 1.00.
error in describes error conditions that occur before this node runs. The default is no error. If an error occurred before this node runs, the node passes the error in value to error out. This node runs normally only if no error occurred before this node runs. If an error occurs while this node 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 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 node ran or FALSE (checkmark) to indicate a warning or that no error occurred before this node 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 node that produced the error or warning. The default is an empty string.
bandwidth [order] specifies an order span centered at the order that you specify in orders to compute. Use a bandwidth [order] value between 0 and 1. If bandwidth [order] is less than or equal to 0 or greater than 1, this VI sets bandwidth [order] to 1. The default is 1.00.
view specifies the view settings for the magnitudes [RMS] and the phases [phase lag].
dB on? specifies whether to return the magnitude in decibels. If dB on? is FALSE, this VI returns the magnitude linearly. The default is FALSE.
unwrap phase? specifies whether to unwrap the phase. If unwrap phase? is FALSE, this VI wraps the phase between 0 and 360 degrees, or between 0 and 2pi. If unwrap phase? is TRUE, this VI removes discontinuities less than 0 degrees or greater than 360 degrees from the phase and does not restrict the phase to values between 0 and 360 degrees. The default is TRUE.
unit in degree? specifies whether to return the phase in degrees. If unit in degree? is TRUE, this VI returns the phase in degrees. If unit in degree? is FALSE, this VI returns the phase in radians. The default is TRUE.
zero delay? specifies whether filter delay exists between the input signal and the output signal. The default is FALSE.
unit labels returns the unit labels for the resulting magnitude and phase.
x unit returns the engineering unit for the x-axis.
magnitude unit returns the engineering unit for the y-axis of the magnitude plot.
phase unit returns the engineering unit for the y-axis of the phase plot.
magnitudes [RMS] returns the magnitude plot, in RMS values, of the specified orders.
time/rev/RPM returns the x-axis value of the plot. The unit you specified in x-axis selection determines the unit of time/rev/RPM.
magnitude returns the y-axis, in RMS values, of the magnitude plot.
phases [phase lag] returns the phase plot, in phase lag value, of the specified orders.
time/rev/RPM returns the x-axis value of the plot. The unit you specified in x-axis selection determines the unit of time/rev/RPM.
phase returns the y-axis, in phase lag value, of the phase plot.
magnitude/phase position info returns the position information for the resulting magnitude and phases.
positions [s] returns the locations of the samples, in seconds.
samples/rev returns the number of samples in each revolution.
magnitude info returns information about the resulting magnitudes, such as the spectrum type, unit label, window type, and so on. Do not modify the magnitude info values.
error out contains error information. If error in indicates that an error occurred before this node ran, error out contains the same error information. Otherwise, it describes the error status that this node 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 node that produced the error or warning.

OAT Order Magnitude and Phase (Even Angle Signal, N Channels)

reset? specifies the initialization of the internal states. The first time this VI runs, or when reset? is TRUE, the internal states initialize to zero. If reset? is FALSE, this VI sets the internal states to the final states from the previous call to the VI. The default is FALSE.
x-axis selection specifies the scale type to use for the x-axis of the output XY plot.
0Time
1Revolution
2RPM (Default)
even-angle signals specifies the even-angle-resampled data. even-angle signals are synchronous to the rotational speed with constant number of samples per revolution.
r0 specifies the starting index value for counting revolutions.
dr specifies the revolution interval between two sequential samples.
Y specifies the value of the even-angle-spaced sample in scaled engineering unit.
even-angle channel info specifies information about the measurement configuration this VI uses to acquire the resampled data. Do not change the values in even-angle channel info.
even-angle position info specifies the position information of the even-angle signals.
positions [s] specifies the locations of the samples, in seconds.
samples/rev specifies the number of samples in one revolution.
orders to compute specifies the orders to use to compute the magnitude and phase. The default is 1.00.
error in describes error conditions that occur before this node runs. The default is no error. If an error occurred before this node runs, the node passes the error in value to error out. This node runs normally only if no error occurred before this node runs. If an error occurs while this node 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 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 node ran or FALSE (checkmark) to indicate a warning or that no error occurred before this node 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 node that produced the error or warning. The default is an empty string.
bandwidth [order] specifies an order span centered at the order that you specify in orders to compute. Use a bandwidth [order] value between 0 and 1. If bandwidth [order] is less than or equal to 0 or greater than 1, this VI sets bandwidth [order] to 1. The default is 1.00.
view specifies the view settings for the magnitudes [RMS] and the phases [phase lag].
dB on? specifies whether to return the magnitude in decibels. If dB on? is FALSE, this VI returns the magnitude linearly. The default is FALSE.
unwrap phase? specifies whether to unwrap the phase. If unwrap phase? is FALSE, this VI wraps the phase between 0 and 360 degrees, or between 0 and 2pi. If unwrap phase? is TRUE, this VI removes discontinuities less than 0 degrees or greater than 360 degrees from the phase and does not restrict the phase to values between 0 and 360 degrees. The default is TRUE.
unit in degree? specifies whether to return the phase in degrees. If unit in degree? is TRUE, this VI returns the phase in degrees. If unit in degree? is FALSE, this VI returns the phase in radians. The default is TRUE.
zero delay? specifies whether filter delay exists between the input signal and the output signal. The default is FALSE.
unit labels returns the unit labels for the resulting magnitude and phase plot for each channel.
x unit returns the engineering unit for the x-axis.
magnitude unit returns the engineering unit for the y-axis of the magnitude plot.
phase unit returns the engineering unit for the y-axis of the phase plot.
magnitudes [RMS] returns the magnitude plot, in RMS values, of the specified orders for each channel. The row index is the channel and the column index is the order.
time/rev/RPM returns the x-axis value of the plot. The unit you specified in x-axis selection determines the unit of time/rev/RPM.
magnitude returns the y-axis, in RMS values, of the magnitude plot.
phases [phase lag] returns the phase plot, in phase lag value, of the specified orders for each channel. The row index is the channel and the column index is the order.
time/rev/RPM returns the x-axis value of the plot. The unit you specified in x-axis selection determines the unit of time/rev/RPM.
phase returns the y-axis, in phase lag value, of the phase plot.
magnitude/phase position info returns the position information for the resulting magnitude and phases.
positions [s] returns the locations of the samples, in seconds.
samples/rev returns the number of samples in each revolution.
magnitudes info returns information about the resulting magnitudes, such as the spectrum type, unit label, window type, and so on. Do not modify the magnitudes info values.
error out contains error information. If error in indicates that an error occurred before this node ran, error out contains the same error information. Otherwise, it describes the error status that this node 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 node that produced the error or warning.

OAT Order Magnitude and Phase (Order Waveforms)

x-axis selection specifies the scale type to use for the x-axis of the output XY plot.

0Time
1Revolution
2RPM (Default)
order waveforms [EU] specifies the time waveforms of orders.
speed profile specifies the arrival time and the rotational speed of each tachometer pulse.
time [s] specifies the arrival time, in seconds, of each tachometer pulse.
speed [RPM] specifies the rotational speed, in revolutions per minute, of each tachometer pulse.
pulse/revolution specifies the number of pulses the tachometer generates during each revolution. The default is 1.
orders to compute specifies the orders to use to compute the magnitude and phase. The default is 1.00.
error in describes error conditions that occur before this node runs. The default is no error. If an error occurred before this node runs, the node passes the error in value to error out. This node runs normally only if no error occurred before this node runs. If an error occurs while this node 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 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 node ran or FALSE (checkmark) to indicate a warning or that no error occurred before this node 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 node that produced the error or warning. The default is an empty string.
window info specifies the window information for the Gabor transform and expansion.
window type specifies the type of window you apply to the Gabor transform and expansion.

0None
1Hanning
2Hamming
3Blackman-Harris
4Exact Blackman
5Blackman
6Flat Top
74 Term B-Harris
87 Term B-Harris
9Low Sidelobe
10Gaussian (Default)
window length specifies the length of the window to apply to the Gabor transform and expansion. window length must be a power of two and greater than or equal to 128. This VI rounds window length to the nearest valid value when window length is less than 128 or not a power of two. Increasing the value of window length can improve the frequency resolution but decreases the time resolution.
view specifies the view settings for the magnitudes [RMS] and the phases [phase lag].
dB on? specifies whether to return the magnitude in decibels. If dB on? is FALSE, this VI returns the magnitude linearly. The default is FALSE.
unwrap phase? specifies whether to unwrap the phase. If unwrap phase? is FALSE, this VI wraps the phase between 0 and 360 degrees, or between 0 and 2pi. If unwrap phase? is TRUE, this VI removes discontinuities less than 0 degrees or greater than 360 degrees from the phase and does not restrict the phase to values between 0 and 360 degrees. The default is TRUE.
unit in degree? specifies whether to return the phase in degrees. If unit in degree? is TRUE, this VI returns the phase in degrees. If unit in degree? is FALSE, this VI returns the phase in radians. The default is TRUE.
unit labels returns the unit labels for the resulting magnitude and phase.
x unit returns the engineering unit for the x-axis.
magnitude unit returns the engineering unit for the y-axis of the magnitude plot.
phase unit returns the engineering unit for the y-axis of the phase plot.
magnitudes [RMS] returns the magnitude plot, in RMS values, of the specified orders.
time/rev/RPM returns the x-axis value of the plot. The unit you specified in x-axis selection determines the unit of time/rev/RPM.
magnitude returns the y-axis, in RMS values, of the magnitude plot.
phases [phase lag] returns the phase plot, in phase lag value, of the specified orders.
time/rev/RPM returns the x-axis value of the plot. The unit you specified in x-axis selection determines the unit of time/rev/RPM.
phase returns the y-axis, in phase lag value, of the phase plot.
magnitude/phase position info returns the position information for the resulting magnitude and phases.
positions [s] returns the locations of the samples, in seconds.
samples/rev returns the number of samples in each revolution.
magnitude info returns information about the resulting magnitudes, such as the spectrum type, unit label, window type, and so on. Do not modify the magnitude info values.
error out contains error information. If error in indicates that an error occurred before this node ran, error out contains the same error information. Otherwise, it describes the error status that this node 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 node that produced the error or warning.

Example

Refer to the Order Tracking Magnitude and Phase (Offline) VI in the labview\examples\Order Analysis\Order Tracking Magnitude and Phase directory for an example of using the OAT Order Magnitude and Phase VI.


Resources


 

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