LibTiePie  0.4.2
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Groups Pages
Hysteresis

The channel trigger hysteresis property is used to control the sensitivity of the trigger system. More...

Functions

uint32_t ScpChTrGetHysteresisCount (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the number of trigger hystereses for a specified channel with the current trigger kind.
 
double ScpChTrGetHysteresis (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex)
 Get the currently set channel trigger hysteresis value for a specified channel and trigger hysteresis.
 
double ScpChTrSetHysteresis (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex, double dHysteresis)
 Set the channel trigger hysteresis value for a specified channel and trigger hysteresis.
 

Detailed Description

The channel trigger hysteresis property is used to control the sensitivity of the trigger system.

The number of available trigger hystereses depends on the currently set trigger kind. Use ScpChTrGetHysteresisCount to determine the number of trigger hystereses for the currently set trigger kind.

The trigger hysteresis is set as a floating point value between 0 and 1, corresponding to a percentage of the full scale input range:

By default the trigger hysteresis is set to 0.05 (5%) of the full-scale range.

Function Documentation

double ScpChTrGetHysteresis ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex 
)

Get the currently set channel trigger hysteresis value for a specified channel and trigger hysteresis.

Parameters
hDeviceA device handle.
wChChannel number, 0 to ScpGetChannelCount() - 1.
dwIndexTrigger hysteresis index, 0 to ScpChTrGetHysteresisCount() - 1.
Returns
The currently set trigger hysteresis value, a number between 0 and 1.
uint32_t ScpChTrGetHysteresisCount ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get the number of trigger hystereses for a specified channel with the current trigger kind.

Parameters
hDeviceA device handle.
wChChannel number, 0 to ScpGetChannelCount() - 1.
Returns
The number of available trigger hystereses for the currently set trigger kind.
See Also
ScpChTrGetKind
ScpChTrGetHysteresis
ScpChTrSetHysteresis
double ScpChTrSetHysteresis ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex,
double  dHysteresis 
)

Set the channel trigger hysteresis value for a specified channel and trigger hysteresis.

Parameters
hDeviceA device handle.
wChChannel number, 0 to ScpGetChannelCount() - 1.
dwIndexTrigger hysteresis index, 0 to ScpChTrGetHysteresisCount() - 1.
dHysteresisThe required trigger hysteresis value, a number between 0 and 1.
Returns
The actually set trigger hysteresis value, a number between 0 and 1.