NI RFmx LTE OBW Configuration Functions - ni/grpc-device GitHub Wiki

OBW Configuration Functions

RFmxLTE_OBWCfgAveraging

int32 __stdcall RFmxLTE_OBWCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount, int32 averagingType);

Purpose

Configures averaging for the OBW measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXLTE_VAL_OBW_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXLTE_VAL_OBW_AVERAGING_ENABLED_TRUE (1) The measurement is averaged over multiple acquisitions. The number of acquisitions is obtained by the averagingCount parameter.
averagingCount int32 Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXLTE_VAL_OBW_AVERAGING_ENABLED_TRUE.
averagingType int32 Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement.
RFMXLTE_VAL_OBW_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXLTE_VAL_OBW_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithmic scale.
RFMXLTE_VAL_OBW_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXLTE_VAL_OBW_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXLTE_VAL_OBW_AVERAGING_TYPE_MINIMUM (4) The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next.

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 RFmxLTE_GetError) function.

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

RFmxLTE_OBWCfgSweepTime

int32 __stdcall RFmxLTE_OBWCfgSweepTime (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 sweepTimeAuto, float64 sweepTimeInterval);

Purpose

Configures the sweep time.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXLTE_VAL_OBW_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXLTE_VAL_OBW_SWEEP_TIME_AUTO_TRUE (1) The measurement uses a sweep time of 1 ms.
sweepTimeInterval float64 Specifies the sweep time when you set the sweepTimeAuto parameter to RFMXLTE_VAL_OBW_SWEEP_TIME_AUTO_FALSE. This value is expressed in seconds.

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 RFmxLTE_GetError) function.

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

RFmxLTE_OBWCfgRBWFilter

int32 __stdcall RFmxLTE_OBWCfgRBWFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 RBWAuto, float64 RBW, int32 RBWFilterType);

Purpose

Configures the RBW filter.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
RBWAuto int32 Specifies whether the measurement computes the RBW.
RFMXLTE_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXLTE_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_TRUE (1) The measurement computes the RBW.
RBW float64 Specifies the bandwidth of the resolution bandwidth (RBW) filter, used to sweep the acquired signal, when you set the RBWAuto parameter to RFMXLTE_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_FALSE. This value is expressed in Hz.
RBWFilterType int32 Specifies the shape of the digital RBW filter.
RFMXLTE_VAL_OBW_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXLTE_VAL_OBW_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXLTE_VAL_OBW_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.

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 RFmxLTE_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** ⚠️