NI RFmx SpecAn IQ Configuration Functions - ni/grpc-device GitHub Wiki

IQ Configuration Functions

RFmxSpecAn_IQCfgAcquisition

int32 __stdcall RFmxSpecAn_IQCfgAcquisition (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 sampleRate, int32 numberOfRecords, float64 acquisitionTime, float64 pretriggerTime);

Purpose

Configures the acquisition settings for the I/Q measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
sampleRate float64 Specifies the acquisition sample rate, in samples per second (S/s).
numberOfRecords int32 Specifies the number of records to acquire.
acquisitionTime float64 Specifies the acquisition time, in seconds, for the I/Q measurement.
pretriggerTime float64 Specifies the pretrigger time, in seconds, for the I/Q measurement.

Return Value

Name Type Description
status int32 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 RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_IQCfgBandwidth

int32 __stdcall RFmxSpecAn_IQCfgBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 bandwidthAuto, float64 bandwidth);

Purpose

Configures the bandwidth for the I/Q measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
bandwidthAuto int32 Specifies whether the measurement computes the minimum acquisition bandwidth.
RFMXSPECAN_VAL_IQ_AUTO_BANDWIDTH_FALSE (0) The measurement uses the value of the bandwidth parameter as the minimum acquisition bandwidth.
RFMXSPECAN_VAL_IQ_AUTO_BANDWIDTH_TRUE (1) The measurement uses 0.8 * sample rate as the minimum signal bandwidth.
bandwidth float64 Specifies the minimum acquisition bandwidth, in hertz (Hz), when you set the bandwidthAuto parameter to RFMXSPECAN_VAL_IQ_AUTO_BANDWIDTH_FALSE.

Return Value

Name Type Description
status int32 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 RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors
⚠️ **GitHub.com Fallback** ⚠️