Pre samples

This section contains all pre samples related functions. More...

Functions
double	ScpGetPreSampleRatio (TpDeviceHandle_t hDevice)
	Get the current pre sample ratio.
double	ScpSetPreSampleRatio (TpDeviceHandle_t hDevice, double dPreSampleRatio)
	Set the pre sample ratio.

Detailed Description

This section contains all pre samples related functions.

When pre samples are selected (pre sample ratio > 0), the trigger point is located at position (pre sample ratio * record length), dividing the record in pre samples and post samples. This way it is possible to "look back in time" since the pre samples were captured before the trigger moment.

Pre sample ratio is set as a number between 0 and 1, representing the percentage of the total record length:

• 0 equals a trigger point at the start of the record, 0% pre samples and 100% post samples
• 0.5 equals a trigger point half way the record, 50% pre samples and 50% post samples
• 1 equals a trigger point at the end of the record, 100% pre samples and 0% post samples

By default the pre sample ratio is: 0 (no pre samples).

Function Documentation

double ScpGetPreSampleRatio

(

TpDeviceHandle_t

hDevice

)

Get the current pre sample ratio.

Parameters

hDevice

A device handle.

Returns

The currently set pre sample ratio, a value between 0 and 1.

Since

0.4.0

double ScpSetPreSampleRatio	(	TpDeviceHandle_t	hDevice,
		double	dPreSampleRatio
	)

Set the pre sample ratio.

Parameters

hDevice	A device handle.
dPreSampleRatio	The required pre sample ratio, a number between 0 and 1.

Returns

The actually set pre sample ratio, a number between 0 and 1.

Since

0.4.0