niRFSA_ConfigureSpectrumFrequencyCenterSpan

NI RF Vector Signal Analyzers

niRFSA_ConfigureSpectrumFrequencyCenterSpan

ViStatus = niRFSA_ConfigureSpectrumFrequencyCenterSpan( ViSession vi, ViConstString channelList, ViReal64 centerFrequency, ViReal64 span);

Purpose

Configures the span and center frequency of a spectrum acquisition. An acquisition consists of a span of data surrounding the center frequency.

Note  If you configure the spectrum span (stop frequency – start frequency) to a value larger than 20 MHz, RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or the niRFSA_initWithOptions functions and identifies a particular instrument session.
channelList ViConstString Identifies channels to apply settings. Use "" or VI_NULL to specify all channels.
centerFrequency ViReal64 Specifies the center frequency in a spectrum acquisition. The value is expressed in Hertz.
span ViReal64 Specifies the span of a spectrum acquisition. The value is expressed in Hertz.

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. You 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 niRFSA_error_message function. To obtain additional information about the error condition, call the niRFSA_GetError function. To clear the error information from the driver, call the niRFSA_ClearError function.

The general meaning of the status code is as follows:

Value
Meaning
0 Success
Positive Values Warnings
Negative Values Errors