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

OAT Get Gap Reference VI

Owning Palette: Reference Data Processing VIs

Installed With: Sound and Vibration Measurement Suite

Computes the gap reference of the scaled signal you acquire from a DC-coupled displacement transducer channel. You can subtract the gap reference value from a signal to calculate the actual movement that the displacement transducer measures. 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.

OAT Get Gap Reference (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.
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).
averaging type specifies the type of averaging this VI uses during the measurement of the DC gap.
0Linear (Default)
1Exponential
window specifies the window this VI applies to the input signal before computing the DC signal.
0Rectangular (none) (Default)
1Hanning
2Low side lobe
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.
gap reference returns the DC gap reference of the scaled signal [EU], in volts.
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 Get Gap Reference (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.
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 Measurement & Automation Explorer (MAX).
averaging type specifies the type of averaging this VI uses during the measurement of the DC gap.

0Linear (Default)
1Exponential
window specifies the window this VI applies to the input signal before computing the DC signal.

0Rectangular (none) (Default)
1Hanning
2Low side lobe
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.
gap references [V] returns the DC gap references of the scaled signals [EU], in volts.
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