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

Amplitude and Levels (Not in Base Package)

LabVIEW 8.2 Help
August 2006

NI Part Number:
371361B-01

»View Product Info

Returns the amplitude, high state level, and low state level of a waveform or an array of waveforms. The data type you wire to the signal in input determines the polymorphic instance to use.

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

Amplitude and Levels 1 chan

signal in is the waveform to measure.
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. 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.
state settings specifies the method used to determine the high and low state levels of a waveform. For pulse and transition waveform measurements, state levels provide a means to identify the position in time of the waveform feature to be measured.
method specifies how the high and low state levels of the waveform are computed.

0Histogram—Returns the levels of the histogram bins with the maximum number of hits in the upper and lower regions of the waveform. The upper and lower regions of the waveform include the upper and lower 40%, respectively, of the waveform's peak-to-peak range.
1Peak—Searches the entire waveform for its maximum and minimum levels.
2Auto select—(Default) Determines if the histogram bins corresponding to the high and low state levels each have over 5% of the total hits. If so, it returns those results, otherwise, it uses the peak method. This ensures a reasonable answer for either a square wave (ignoring the overshoot and preshoot) or a triangle wave (where a histogram fails).
histogram size specifies the number of bins in the histogram used to determine the high and low state levels of the waveform. histogram size is ignored if the peak method is selected.
histogram method specifies how the high and low state levels of the waveform are computed. Currently, mode is the only histogram method available.

0Mode
reserved is reserved for future use.
amplitude is the difference between high state level and low state level.
high state level specifies the level at which a pulse or transition waveform is defined to be in its highest state.
low state level specifies the level at which a pulse or transition waveform is defined to be in its lowest state
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.

Amplitude and Levels N chan

signal(s) in is an array of waveforms containing the signals to measure.
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. 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.
state settings specifies the method used to determine the high and low state levels of a waveform. For pulse and transition waveform measurements, state levels provide a means to identify the position in time of the waveform feature to be measured.
method specifies how the high and low state levels of the waveform are computed.

0Histogram—Returns the levels of the histogram bins with the maximum number of hits in the upper and lower regions of the waveform. The upper and lower regions of the waveform include the upper and lower 40%, respectively, of the waveform's peak-to-peak range.
1Peak—Searches the entire waveform for its maximum and minimum levels.
2Auto select—(Default) Determines if the histogram bins corresponding to the high and low state levels each have over 5% of the total hits. If so, it returns those results, otherwise, it uses the peak method. This ensures a reasonable answer for either a square wave (ignoring the overshoot and preshoot) or a triangle wave (where a histogram fails).
histogram size specifies the number of bins in the histogram used to determine the high and low state levels of the waveform. histogram size is ignored if the peak method is selected.
histogram method specifies how the high and low state levels of the waveform are computed. Currently, mode is the only histogram method available.

0Mode
reserved is reserved for future use.
amplitude is an array containing the amplitude of each waveform in signal(s) in.
high state level is an array containing the high state level of each waveform in signal(s) in.
low state level is an array containing the low state level of each waveform in signal(s) in.
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