Skip to content

NI RFmx LTE CHP Configuration Functions

Dane Stull edited this page Feb 28, 2022 · 2 revisions

CHP Configuration Functions

RFmxLTE_CHPCfgAveraging

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

Purpose

Configures averaging for the CHP 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_CHP_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXLTE_VAL_CHP_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_CHP_AVERAGING_ENABLED_TRUE.
averagingType int32 Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement.
RFMXLTE_VAL_CHP_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXLTE_VAL_CHP_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithmic scale.
RFMXLTE_VAL_CHP_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXLTE_VAL_CHP_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXLTE_VAL_CHP_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_CHPCfgSweepTime

int32 __stdcall RFmxLTE_CHPCfgSweepTime (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_CHP_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXLTE_VAL_CHP_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_CHP_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_CHPCfgIntegrationBandwidthType

int32 __stdcall RFmxLTE_CHPCfgIntegrationBandwidthType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 integrationBandwidthType);

Purpose

Configures the type of integration bandwidth (IBW), which selects one of the frequency ranges over which the CHP is measured. Refer to the LTE Channel Power (CHP)) topic for more information.

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.
integrationBandwidthType int32 Specifies the integration bandwidth (IBW) type used to measure the power of the acquired signal. Integration bandwidth is the frequency interval over which the power in each frequency bin is added to measure the total power in that interval.
RFMXLTE_VAL_CHP_INTEGRATION_BANDWIDTH_TYPE_SIGNAL_BANDWIDTH (0) The IBW excludes the guard bands at the edges of the carrier or subblock from the power calculation.
RFMXLTE_VAL_CHP_INTEGRATION_BANDWIDTH_TYPE_CHANNEL_BANDWIDTH (1) The IBW includes the guard bands at the edges of the carrier or subblock from the power calculation.

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_CHPCfgRBWFilter

int32 __stdcall RFmxLTE_CHPCfgRBWFilter (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_CHP_RBW_FILTER_AUTO_BANDWIDTH_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXLTE_VAL_CHP_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_CHP_RBW_FILTER_AUTO_BANDWIDTH_FALSE. This value is expressed in Hz.
RBWFilterType int32 Specifies the shape of the digital RBW filter.
RFMXLTE_VAL_CHP_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXLTE_VAL_CHP_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXLTE_VAL_CHP_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

RFmxLTE_CHPValidateNoiseCalibrationData

int32 __stdcall RFmxLTE_CHPValidateNoiseCalibrationData (niRFmxInstrHandle instrumentHandle, char selectorString[], int32* noiseCalibrationDataValid);

Purpose

Indicates whether calibration data is valid for the configuration specified by the signal name in the selectorString parameter.

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.
Output
Name Type Description
noiseCalibrationDataValid int32* Returns whether the calibration data is valid.

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

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally