GtWaveSetFilterMode

Supported By

GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Sets the filter mode.

Syntax

GtWaveSetFilterMode (nHandle, nChannel, nMode, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Handle to a GX1120 board.
nChannel
SHORT
Specified Channel number.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
nMode
SHORT

Filter mode:

0. GTWAVE_FILTER_MODE_AUTO – the driver applies the best filter for the active waveform automatically.

1. GTWAVE_FILTER_MODE_BAND_PASS – output filter is set to the elliptical band pass mode. This filter is most suitable when the board is in function generator mode and the waveform is not a square waveform.

2. GTWAVE_FILTER_MODE_LOW_PASS - output filter is set to the low pass filter mode. This filter is most suitable when the board is in Arbitrary Waveform Generator mode or when the board is in Function Generator mode and the waveform is a square waveform.

pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The output filter settings are different for Sinusoidal waveform and a Square waveform versus the Arbitrary mode. The user can determine the filter settings or let the driver to apply the best filter for the active waveform.

Example

The following example sets the filter mode to auto:

 

GtWaveSetFilterMode (nHandle, GTWAVE_CHANNEL_A, GTWAVE_FILTER_MODE_AUTO, &nStatus);

 

See Also

GtWaveGetFilterMode, GtWaveGetErrorString