LibTiePie  0.4.4
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Groups Pages
Sample frequency

This section contains all sample frequency related functions. More...

Functions

double ScpGetSampleFrequencyMax (TpDeviceHandle_t hDevice)
 Get the maximum supported sample frequency of a specified device.
 
double ScpGetSampleFrequency (TpDeviceHandle_t hDevice)
 Get the currently selected sample frequency.
 
double ScpSetSampleFrequency (TpDeviceHandle_t hDevice, double dSampleFrequency)
 Set the sample frequency.
 

Detailed Description

This section contains all sample frequency related functions.

The rate at which samples are taken by the oscilloscope is called the sample frequency, the number of samples per second. A higher sample frequency corresponds to a shorter interval between the samples. With a higher sample frequency, the original signal can be reconstructed much better from the measured samples.

The maximum supported sample frequency depends on the used instrument and its configuration. Use ScpGetSampleFrequencyMax to determine the maximum supported sample frequency of a device.

By default the sample frequency is set to the highest value available.

Function Documentation

double ScpGetSampleFrequencyMax ( TpDeviceHandle_t  hDevice)

Get the maximum supported sample frequency of a specified device.

Parameters
hDeviceA device handle.
Returns
The maximum supported sample frequency, in Hz.
Since
0.4.0
double ScpGetSampleFrequency ( TpDeviceHandle_t  hDevice)

Get the currently selected sample frequency.

Parameters
hDeviceA device handle.
Returns
The currently selected sample frequency, in Hz.
Since
0.4.0
double ScpSetSampleFrequency ( TpDeviceHandle_t  hDevice,
double  dSampleFrequency 
)

Set the sample frequency.

Parameters
hDeviceA device handle.
dSampleFrequencyThe required sample frequency, in Hz.
Returns
The actually selected sample frequency, in Hz.
Remarks
Changing the sample frequency may affect the record length, trigger time out, trigger delay and/or channel trigger time(s) value(s).
Changing the sample frequency may change the resolution if auto resolution mode is AR_NATIVEONLY or AR_ALL.
Since
0.4.0