libtiepie-hw
1.2.1
|
Functions to control the sample rate of the oscilloscope. More...
Functions | |
TIEPIE_HW_API double | tiepie_hw_oscilloscope_get_sample_rate_max (tiepie_hw_handle handle) |
Get the maximum supported sample rate of a specified oscilloscope. More... | |
TIEPIE_HW_API double | tiepie_hw_oscilloscope_get_sample_rate (tiepie_hw_handle handle) |
Get the currently selected sample rate of a specified oscilloscope. More... | |
TIEPIE_HW_API double | tiepie_hw_oscilloscope_set_sample_rate (tiepie_hw_handle handle, double value) |
Set the sample rate of a specified oscilloscope. More... | |
Functions to control the sample rate of the oscilloscope.
The rate at which samples are taken by the oscilloscope is called the sample rate, the number of samples per second. A higher sample rate corresponds to a shorter interval between the samples. With a higher sample rate, the original signal can be reconstructed much better from the measured samples.
The maximum supported sample rate depends on the used instrument and its configuration. Use tiepie_hw_oscilloscope_get_sample_rate_max to determine the maximum supported sample rate of a oscilloscope.
The sample rate can be affected by changing the channel enable, resolution and/or measure mode.
By default the sample rate is set to the highest value available.
TIEPIE_HW_API double tiepie_hw_oscilloscope_get_sample_rate_max | ( | tiepie_hw_handle | handle | ) |
Get the maximum supported sample rate of a specified oscilloscope.
[in] | handle | A device handle identifying the oscilloscope. |
0
when unsuccessful. TIEPIE_HW_STATUS_INVALID_HANDLE | The handle is not a valid oscilloscope handle. |
TIEPIE_HW_STATUS_OBJECT_GONE | |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API double tiepie_hw_oscilloscope_get_sample_rate | ( | tiepie_hw_handle | handle | ) |
Get the currently selected sample rate of a specified oscilloscope.
[in] | handle | A device handle identifying the oscilloscope. |
0
when unsuccessful. TIEPIE_HW_STATUS_INVALID_HANDLE | The handle is not a valid oscilloscope handle. |
TIEPIE_HW_STATUS_OBJECT_GONE | |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |
TIEPIE_HW_API double tiepie_hw_oscilloscope_set_sample_rate | ( | tiepie_hw_handle | handle, |
double | value | ||
) |
Set the sample rate of a specified oscilloscope.
[in] | handle | A device handle identifying the oscilloscope. |
[in] | value | The required sample rate in Hz. |
0
when unsuccessful. TIEPIE_HW_STATUS_VALUE_CLIPPED | The requested sample rate is outside the valid range and clipped to the closest limit. |
TIEPIE_HW_STATUS_VALUE_MODIFIED | The requested sample rate is within the valid range but not available. The closest valid value is set. |
TIEPIE_HW_STATUS_INVALID_VALUE | |
TIEPIE_HW_STATUS_INVALID_HANDLE | The handle is not a valid oscilloscope handle. |
TIEPIE_HW_STATUS_OBJECT_GONE | |
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED | |
TIEPIE_HW_STATUS_SUCCESS |