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

OAT Spectral Map VI

Owning Palette: Order Analysis VIs

Installed With: Sound and Vibration Measurement Suite

Computes a spectral map of the scaled signal [EU] as a function of time or rotational speed. This VI can return the spectral map as a 2D numeric array, a colormap, or a waterfall graph.

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

OAT Spectral Map (Intensity)

plot type specifies the axis units of the 2D-array spectral map.
0Frequency-Time—(Default) Displays the time on the x-axis and frequency on the y-axis.
1Time-Frequency—Displays the frequency on the x-axis and the time on the y-axis.
2Order-Time—Displays the time on the x-axis and the order on the y-axis.
3Time-Order—Displays the order on the x-axis and the time on the y-axis.
4Frequency-RPM—Displays the RPM on the x-axis and the frequency on the y-axis.
5RPM-Frequency—Displays the frequency on the x-axis and the frequency on the y-axis.
6Order-RPM—Displays the RPM on the x-axis and the order on the y-axis.
7RPM-Order—Displays the order on the x-axis and the RPM on the y-axis.
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.
dB on? specifies whether to return the resulting 2D-array spectral map in decibels. If dB on? is FALSE, this VI returns the 2D-array spectral map linearly. The default is TRUE.
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 Measurement & Automation Explorer (MAX).
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.
time/speed segment [s or RPM] specifies the segment of the input signal to analyze. time/speed segment [s or RPM] uses second as the unit when the plot type is Frequency-Time, Time-Frequency, Time-Order, or Order-Time. time/speed segment [s or RPM] uses RPM as the unit when the plot type is Frequency-RPM, RPM-Frequency, RPM-Order, or Order-RPM.
start specifies the start value of time or rotational speed. The default value is 0.00. The default condition causes this VI to use zero as the start value of time or speed in run-up conditions, or use the actual start RPM value as the start value of speed in run-down conditions.
end specifies the end value of time or rotational speed. The default is 0.00. The default condition causes this VI to use positive infinity as the end value of time or speed in run-up conditions, or use zero as the end value of speed in run-down conditions.
step size specifies the time or rotational speed interval between two spectra. step size must be greater than 0. When specifying the time segment, the default is 0.00, which causes this VI to use 0.1 as step size. When specifying the speed segment, the default is 0.00, which causes this VI to use 50 as step size.
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.
max order specifies the maximum order to analyze. If max order is less than or equal to 0, this VI automatically sets a maximum order to analyze. The default is 0.
windows info specifies the window settings to compute the 2D-array spectral map.
window type specifies the window to apply to the 2D-array spectral map.
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 2D-array spectral map. 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 or order resolution but decreases the time or speed resolution. The default is 2048.

When the plot type is Frequency-Time, Time-Frequency, Frequency-RPM, or RPM-Frequency, window length equals twice the number of frequency bins. When the plot type is Time-Order, Order-Time, RPM-Order, or Order-RPM, window length equals twice the number of order bins.
spectral map returns the two-dimensional representation of the spectra for the input signal.
spectral map info returns the scaling information about the spectral map.
scales returns the axis scales of the spectral map.
x scale returns the scaling information associated with the first index value of the 2D spectral map. offset and multiplier specify scaling values such that the final scaling value equals (deltaX)*X + X0.
offset returns the offset, or initial value, for scaling the data using (deltaX)*X + X0. If you change the offset, the scale no longer uses 0 as the origin of the plot.
multiplier returns the multiplier, or interval, for scaling data using (deltaX)*X + X0.
y scale returns the scaling information associated with the second index value of the 2D spectral map. offset and multiplier specify scaling values such that the final scaling value equals (deltaY)*Y + Y0.
offset returns the offset, or initial value, for scaling the data using (deltaY)*Y + Y0. If you change the offset, the scale no longer uses 0 as the origin of the plot.
multiplier returns the multiplier, or interval, for scaling data using (deltaY)*Y + Y0.
unit labels returns the units of the spectral map.
x unit returns the x-axis unit label of the spectral map.
y unit returns the y-axis unit label of the spectral map.
z unit returns the z-axis unit label of the spectral map.
plot type returns the plot type of the spectral map.
dB on? returns TRUE if the spectral map is in decibels.
spectrum info returns information about the spectrum for the Extended Measurements VIs. Do not modify the spectrum info values.
end reached? indicates whether the input signal reaches the end time or speed value that you specified in time/speed segment [s or RPM]. When end reached? is TRUE, this VI does not return new spectra.
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 Spectral Map (Colormap)

plot type specifies the axis units of the colormap.

0Frequency-Time—(Default) Displays the time on the x-axis and frequency on the y-axis.
1Time-Frequency—Displays the frequency on the x-axis and the time on the y-axis.
2Order-Time—Displays the time on the x-axis and the order on the y-axis.
3Time-Order—Displays the order on the x-axis and the time on the y-axis.
4Frequency-RPM—Displays the RPM on the x-axis and the frequency on the y-axis.
5RPM-Frequency—Displays the frequency on the x-axis and the RPM on the y-axis.
6Order-RPM—Displays the RPM on the x-axis and the order on the y-axis.
7RPM-Order—Displays the order on the x-axis and the RPM on the y-axis.
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.
dB on? specifies whether to return the resulting colormap in decibels. If dB on? is FALSE, this VI returns the colormap linearly. The default is TRUE.
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 Measurement & Automation Explorer (MAX).
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.
time/speed segment [s or RPM] specifies the segment of the input signal to analyze. time/speed segment [s or RPM] uses second as the unit when the plot type is Frequency-Time, Time-Frequency, Time-Order, or Order-Time. time/speed segment [s or RPM] uses RPM as the unit when the plot type is Frequency-RPM, RPM-Frequency, RPM-Order, or Order-RPM.
start specifies the start value of time or rotational speed. The default value is 0.00. The default condition causes this VI to use zero as the start value of time or speed in run-up conditions, or use the actual start RPM value as the start value of speed in run-down conditions.
end specifies the end value of time or rotational speed. The default is 0.00. The default condition causes this VI to use positive infinity as the end value of time or speed in run-up conditions, or use zero as the end value of speed in run-down conditions.
step size specifies the time or rotational speed interval between two spectra. step size must be greater than 0. When specifying the time segment, the default is 0.00, which causes this VI to use 0.1 as step size. When specifying the speed segment, the default is 0.00, which causes this VI to use 50 as step size.
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.
max order specifies the maximum order to analyze. If max order is less than or equal to 0, this VI automatically sets a maximum order to analyze. The default is 0.
windows info specifies the window settings to compute the colormap.
window type specifies the window to apply to the colormap.

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 colormap. 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 or order resolution but decreases the time or speed resolution. The default is 2048.

When the plot type is Frequency-Time, Time-Frequency, Frequency-RPM, or RPM-Frequency, window length equals twice the number of frequency bins. When the plot type is Time-Order, Order-Time, RPM-Order, or Order-RPM, window length equals twice the number of order bins.
colormap returns the colormap representation of the spectra for the input signal.
value returns the value of the resulting colormap.
x scale returns the scaling information associated with the first index value of the 2D spectral map. offset and multiplier specify scaling values such that the final scaling value equals (deltaX)*X + X0.
offset returns the offset, or initial value, for scaling the data using (deltaX)*X + X0. If you change the offset, the scale no longer uses 0 as the origin of the plot.
multiplier returns the multiplier, or interval, for scaling data using (deltaX)*X + X0.
y scale returns the scaling information associated with the second index value of the 2D spectral map. offset and multiplier specify scaling values such that the final scaling value equals (deltaY)*Y + Y0.
offset returns the offset, or initial value, for scaling the data using (deltaY)*Y + Y0. If you change the offset, the scale no longer uses 0 as the origin of the plot.
multiplier returns the multiplier, or interval, for scaling data using (deltaY)*Y + Y0.
colormap unit labels returns the units of the colormap.
x-axis unit label returns the x-axis unit label of the colormap.
y-axis unit label returns the y-axis unit label of the colormap.
z-axis unit label returns the z-axis unit label of the colormap.
spectrum info returns information about the spectrum for the Extended Measurements VIs. Do not modify the spectrum info values.
end reached? indicates whether the input signal reaches the end time or speed value that you specified in time/speed segment [s or RPM]. When end reached? is TRUE, this VI does not return new spectra.
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 Spectral Map (Waterfall)

plot type specifies the axis units of the waterfall graph. You cannot set plot type to Time-Frequency, Time-Order, RPM-Frequency, or RPM-Order for a waterfall graph.

0Frequency-Time—(Default) Displays the time on the x-axis and frequency on the y-axis.
1Time-Frequency—Displays the frequency on the x-axis and the time on the y-axis.
2Order-Time—Displays the time on the x-axis and the order on the y-axis.
3Time-Order—Displays the order on the x-axis and the time on the y-axis.
4Frequency-RPM—Displays the RPM on the x-axis and the frequency on the y-axis.
5RPM-Frequency—Displays the frequency on the x-axis and the frequency on the y-axis.
6Order-RPM—Displays the RPM on the x-axis and the order on the y-axis.
7RPM-Order—Displays the order on the x-axis and the RPM on the y-axis.
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.
dB on? specifies whether to return the resulting waterfall graph in decibels. If dB on? is FALSE, this VI returns the waterfall graph linearly. The default is FALSE.
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 Measurement & Automation Explorer (MAX).
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.
time/speed segment [s or RPM] specifies the segment of the input signal to analyze. time/speed segment [s or RPM] uses second as the unit when the plot type is Frequency-Time or Order-Time. time/speed segment [s or RPM] uses RPM as the unit when the plot type is Frequency-RPM or Order-RPM.
start specifies the start value of time or rotational speed. The default value is 0.00. The default condition causes this VI to use zero as the start value of time or speed in run-up conditions, or use the actual start RPM value as the start value of speed in run-down conditions.
end specifies the end value of time or rotational speed. The default is 0.00. The default condition causes this VI to use positive infinity as the end value of time or speed in run-up conditions, or use zero as the end value of speed in run-down conditions.
step size specifies the time or rotational speed interval between two spectra. step size must be greater than 0. When specifying the time segment, the default is 0.00, which causes this VI to use 0.1 as step size. When specifying the speed segment, the default is 0.00, which causes this VI to use 50 as step size.
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.
max order specifies the maximum order to analyze. If max order is less than or equal to 0, this VI automatically sets a maximum order to analyze. The default is 0.
windows info specifies the window settings to compute the waterfall graph.
window type specifies the window to apply to the waterfall graph.

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 waterfall graph. 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 or order resolution but decreases the time or speed resolution. The default is 2048.

When the plot type is Frequency-Time or Frequency-RPM, window length equals twice the number of frequency bins. When the plot type is Order-Time or Order-RPM, window length equals twice the number of order bins.
waterfall graph returns the waterfall graph representation of the spectra for the input signal.
z0 returns the initial value of the first plot on the z-axis.
dz returns the interval between plots on the z-axis.
waveforms returns the waveform data of the waterfall graph.
f0 returns the start frequency of the waveform expressed in hertz.
df returns the frequency resolution of the waveform expressed in hertz.
magnitude returns the magnitude of the waveform.
waterfall unit labels returns the units of the waterfall graph.
x-axis unit label returns the x-axis unit label of the waterfall graph.
y-axis unit label returns the y-axis unit label of the waterfall graph.
z-axis unit label returns the z-axis unit label of the waterfall graph.
spectrum info returns information about the spectrum for the Extended Measurements VIs. Do not modify the spectrum info values.
end reached? indicates whether the input signal reaches the end time or speed value that you specified in time/speed segment [s or RPM]. When end reached? is TRUE, this VI does not return new spectra.
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.

Resources


 

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