niScope_ConfigureRefLevels

NI High-Speed Digitizers Help (NI-SCOPE)

Edition Date: January 2017

Part Number: 370592AB-01

View Product Info

DOWNLOAD (Windows Only)


NI-SCOPE (English | Japanese)

C Function Prototype

ViStatus niScope_ConfigureRefLevels (ViSession vi, ViReal64 low, ViReal64 mid, ViReal64 high);

Purpose

This function is included for compliance with the IviScope Class Specification.

Configures the reference levels for all channels of the digitizer. The levels may be set on a per channel basis by setting NISCOPE_ATTR_MEAS_CHAN_HIGH_REF_LEVEL, NISCOPE_ATTR_MEAS_CHAN_LOW_REF_LEVEL , and NISCOPE_ATTR_MEAS_CHAN_MID_REF_LEVEL.

This function configures the reference levels for waveform measurements. Call this function before calling niScope_FetchMeasurement to take a rise time, fall time, width negative, width positive, duty cycle negative, or duty cycle positive measurement.

Parameters

Input
Name Type Description
vi ViSession The instrument handle you obtain from niScope_init that identifies a particular instrument session.
low ViReal64 Pass the low reference you want the digitizer to use for waveform measurements.

Units: Either a percentage or voltage based on NISCOPE_ATTR_MEAS_REF_LEVEL_UNITS. A percentage is calculated with the voltage low and voltage high measurements representing 0% and 100%, respectively.

Default Value: 10.0

mid ViReal64 Pass the mid reference you want the digitizer to use for waveform measurements.

Units: Either a percentage or voltage based on NISCOPE_ATTR_MEAS_REF_LEVEL_UNITS. A percentage is calculated with the voltage low and voltage high measurements representing 0% and 100%, respectively.

Default Value: 50.0

high ViReal64 Pass the high reference you want the digitizer to use for waveform measurements.

Units: Either a percentage or voltage based on NISCOPE_ATTR_MEAS_REF_LEVEL_UNITS. A percentage is calculated with the voltage low and voltage high measurements representing 0% and 100%, respectively.

Default Value: 90.0

Return Value

Name Type Description
Status ViStatus Reports the status of this operation. To obtain a text description of the status code, call niScope_GetErrorMessage. To obtain additional information concerning the error condition, use niScope_GetError and niScope_ClearError. The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful