libtiepie-hw  1.1.3

Functions to control the input bandwidth of an oscilloscope channel. More...

Collaboration diagram for Bandwidth:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_get_bandwidths (tiepie_hw_handle handle, uint16_t ch, double *list, uint32_t length)
 Get the supported input bandwidths for a specified channel. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_get_bandwidth (tiepie_hw_handle handle, uint16_t ch)
 Get the current channel input bandwidth. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_set_bandwidth (tiepie_hw_handle handle, uint16_t ch, double bandwidth)
 Set the channel input bandwidth. More...
 

Detailed Description

Functions to control the input bandwidth of an oscilloscope channel.

By default the input bandwidth of a channel is set to the highest value available.

Function Documentation

◆ tiepie_hw_oscilloscope_channel_get_bandwidths()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_get_bandwidths ( tiepie_hw_handle  handle,
uint16_t  ch,
double *  list,
uint32_t  length 
)

Get the supported input bandwidths for a specified channel.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
[out]listA pointer to an array for the input bandwidths.
[in]lengthThe number of elements in the array.
Returns
The total number of bandwidths.
Status values
TIEPIE_HW_STATUS_UNSUCCESSFUL
TIEPIE_HW_STATUS_INVALID_CHANNEL
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
See also
tiepie_hw_oscilloscope_channel_get_bandwidth
tiepie_hw_oscilloscope_channel_set_bandwidth
Since
1.0

◆ tiepie_hw_oscilloscope_channel_get_bandwidth()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_get_bandwidth ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the current channel input bandwidth.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
Returns
The current channel input bandwidth in Hz.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The channel does not support reading the input bandwidth.
TIEPIE_HW_STATUS_INVALID_CHANNEL
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
See also
tiepie_hw_oscilloscope_channel_get_bandwidths
tiepie_hw_oscilloscope_channel_set_bandwidth
Since
1.0

◆ tiepie_hw_oscilloscope_channel_set_bandwidth()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_set_bandwidth ( tiepie_hw_handle  handle,
uint16_t  ch,
double  bandwidth 
)

Set the channel input bandwidth.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
[in]bandwidthThe requested input bandwidth in Hz.
Returns
The actually set channel input bandwidth in Hz.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The channel does not support changing the input bandwidth.
TIEPIE_HW_STATUS_INVALID_CHANNEL
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
See also
tiepie_hw_oscilloscope_channel_get_bandwidths
tiepie_hw_oscilloscope_channel_get_bandwidth
Since
1.0