niRFSG_ConfigureSignalBandwidth

NI-RFSG C Function

niRFSG_ConfigureSignalBandwidth

Specific Function

C Function Prototype

ViStatus niRFSG_ConfigureSignalBandwidth (ViSession vi, ViReal64 signalBandwidth);

Purpose

Configures the signal bandwidth of the arbitrary waveform. NI-RFSG defines signal bandwidth as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0 Hz. In such cases, the signal bandwidth is simply the baseband signal's minimum frequency subtracted from its maximum frequency, or fmax minus fmin. The driver uses this value to optimally configure the center frequency of the upconverter to help minimize phase noise. The generated signal will not be filtered to achieve the set bandwidth. However, specifying a bandwidth smaller than the actual bandwidth of the signal could potentially result in spectral distortion.

Note Note  Based on your signal bandwidth, NI-RFSG decides whether to configure the upconverter center frequency in increments of 1 or 5 MHz. Failure to configure this attribute may result in the signal being placed out of the upconverter passband.
The NI-RFSG device must be in the Configuration state before calling this function.

Supported Devices: NI 5670/5671/5672

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.

Default Value: None

signalBandwidth ViReal64 Specifies the signal bandwidth used by NI-RFSG to generate an RF output signal. NI-RFSG sets the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute to this value.

Valid Values:
0 Hz to 20 MHz

Default Value: 100

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an instrument driver function to determine if an error occurred.

To obtain a text description of the status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function.

The general meaning of the status code is as follows:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors