NI RFmx NR OBW Attributes

OBW Attributes

• RFMXNR_ATTR_OBW_MEASUREMENT_ENABLED
• Span
  • RFMXNR_ATTR_OBW_SPAN_AUTO
  • RFMXNR_ATTR_OBW_SPAN
• RBW Filter
  • RFMXNR_ATTR_OBW_RBW_FILTER_AUTO_BANDWIDTH
  • RFMXNR_ATTR_OBW_RBW_FILTER_BANDWIDTH
  • RFMXNR_ATTR_OBW_RBW_FILTER_TYPE
• Sweep Time
  • RFMXNR_ATTR_OBW_SWEEP_TIME_AUTO
  • RFMXNR_ATTR_OBW_SWEEP_TIME_INTERVAL
• Averaging
  • RFMXNR_ATTR_OBW_AVERAGING_ENABLED
  • RFMXNR_ATTR_OBW_AVERAGING_COUNT
  • RFMXNR_ATTR_OBW_AVERAGING_TYPE
• FFT
  • RFMXNR_ATTR_OBW_FFT_WINDOW
• RFMXNR_ATTR_OBW_AMPLITUDE_CORRECTION_TYPE
• RFMXNR_ATTR_OBW_ALL_TRACES_ENABLED
• RFMXNR_ATTR_OBW_NUMBER_OF_ANALYSIS_THREADS
• Results
  • Subblock
    • RFMXNR_ATTR_OBW_RESULTS_OCCUPIED_BANDWIDTH
    • RFMXNR_ATTR_OBW_RESULTS_ABSOLUTE_POWER
    • RFMXNR_ATTR_OBW_RESULTS_START_FREQUENCY
    • RFMXNR_ATTR_OBW_RESULTS_STOP_FREQUENCY

RFMXNR_ATTR_OBW_MEASUREMENT_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies whether to enable the OBW measurement. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_FALSE. Get Function: RFmxNR_OBWGetMeasurementEnabled Set Function: RFmxNR_OBWSetMeasurementEnabled

Span

RFMXNR_ATTR_OBW_SPAN_AUTO

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies whether the frequency range of the spectrum used for the OBW measurement is auto computed or configured by the user. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_OBW_SPAN_AUTO_TRUE. Get Function: RFmxNR_OBWGetSpanAuto Set Function: RFmxNR_OBWSetSpanAuto
Values:

RFMXNR_VAL_OBW_SPAN_AUTO_FALSE (0)	Indicates that the user-configured span is used.
RFMXNR_VAL_OBW_SPAN_AUTO_TRUE (1)	Indicates that the measurement will auto compute the span based on the configuration.

RFMXNR_ATTR_OBW_SPAN

Data Type:	float64
Access:	read/write
Functions:	RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64
Description:	Specifies the frequency range around the subblock center frequency, which is used to find the Subblock Occupied Bandwidth. When RFMXNR_ATTR_OBW_SPAN_AUTO is set to RFMXNR_VAL_OBW_SPAN_AUTO_FALSE, the configured span value is used by the measurement. This value is expressed in Hz. Use 'subblock(n)' as the Selector Strings to configure or read this attribute. The default value is 20 MHz. Get Function: RFmxNR_OBWGetSpan Set Function: RFmxNR_OBWSetSpan

RBW Filter

RFMXNR_ATTR_OBW_RBW_FILTER_AUTO_BANDWIDTH

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies whether the measurement computes the RBW. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_TRUE. Get Function: RFmxNR_OBWGetRBWFilterAutoBandwidth Set Function: RFmxNR_OBWSetRBWFilterAutoBandwidth
Values:

RFMXNR_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_FALSE (0)	The measurement uses the RBW that you specify in the RFMXNR_ATTR_OBW_RBW_FILTER_BANDWIDTH attribute.
RFMXNR_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_TRUE (1)	The measurement computes the RBW.

RFMXNR_ATTR_OBW_RBW_FILTER_BANDWIDTH

Data Type:	float64
Access:	read/write
Functions:	RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64
Description:	Specifies the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RFMXNR_ATTR_OBW_RBW_FILTER_AUTO_BANDWIDTH attribute to RFMXNR_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_FALSE. This value is expressed in Hz. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 10 kHz. Get Function: RFmxNR_OBWGetRBWFilterBandwidth Set Function: RFmxNR_OBWSetRBWFilterBandwidth

RFMXNR_ATTR_OBW_RBW_FILTER_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies the shape of the digital RBW filter. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_OBW_RBW_FILTER_TYPE_GAUSSIAN. Get Function: RFmxNR_OBWGetRBWFilterType Set Function: RFmxNR_OBWSetRBWFilterType
Values:

RFMXNR_VAL_OBW_RBW_FILTER_TYPE_FFT_BASED (0)	No RBW filtering is performed.
RFMXNR_VAL_OBW_RBW_FILTER_TYPE_GAUSSIAN (1)	An RBW filter with a Gaussian response is applied.
RFMXNR_VAL_OBW_RBW_FILTER_TYPE_FLAT (2)	An RBW filter with a flat response is applied.

Sweep Time

RFMXNR_ATTR_OBW_SWEEP_TIME_AUTO

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies whether the measurement sets the sweep time. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_OBW_SWEEP_TIME_AUTO_TRUE. Get Function: RFmxNR_OBWGetSweepTimeAuto Set Function: RFmxNR_OBWSetSweepTimeAuto
Values:

RFMXNR_VAL_OBW_SWEEP_TIME_AUTO_FALSE (0)	The measurement uses the sweep time that you specify in the RFMXNR_ATTR_OBW_SWEEP_TIME_INTERVAL attribute.
RFMXNR_VAL_OBW_SWEEP_TIME_AUTO_TRUE (1)	The measurement calculates the sweep time internally. For DL, the sweep time is calculated based on the value of the RFMXNR_ATTR_OBW_RBW_FILTER_BANDWIDTH attribute, and for UL, it uses a sweep time of 1 ms.

RFMXNR_ATTR_OBW_SWEEP_TIME_INTERVAL

Data Type:	float64
Access:	read/write
Functions:	RFmxNR_SetAttributeF64 RFmxNR_GetAttributeF64
Description:	Specifies the sweep time when you set the RFMXNR_ATTR_OBW_SWEEP_TIME_AUTO attribute to RFMXNR_VAL_OBW_SWEEP_TIME_AUTO_FALSE. This value is expressed in seconds. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 1 ms. Get Function: RFmxNR_OBWGetSweepTimeInterval Set Function: RFmxNR_OBWSetSweepTimeInterval

OBW Averaging

RFMXNR_ATTR_OBW_AVERAGING_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies whether to enable averaging for the OBW measurement. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_OBW_AVERAGING_ENABLED_FALSE. Get Function: RFmxNR_OBWGetAveragingEnabled Set Function: RFmxNR_OBWSetAveragingEnabled
Values:

RFMXNR_VAL_OBW_AVERAGING_ENABLED_FALSE (0)	The measurement is performed on a single acquisition.
RFMXNR_VAL_OBW_AVERAGING_ENABLED_TRUE (1)	The OBW measurement uses the value of the RFMXNR_ATTR_OBW_AVERAGING_COUNT attribute as the number of acquisitions over which the OBW measurement is averaged.

RFMXNR_ATTR_OBW_AVERAGING_COUNT

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies the number of acquisitions used for averaging when you set the RFMXNR_ATTR_OBW_AVERAGING_ENABLED attribute to RFMXNR_VAL_OBW_AVERAGING_ENABLED_TRUE. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 10. Get Function: RFmxNR_OBWGetAveragingCount Set Function: RFmxNR_OBWSetAveragingCount

RFMXNR_ATTR_OBW_AVERAGING_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the OBW measurement. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_OBW_AVERAGING_TYPE_RMS. Get Function: RFmxNR_OBWGetAveragingType Set Function: RFmxNR_OBWSetAveragingType
Values:

RFMXNR_VAL_OBW_AVERAGING_TYPE_RMS (0)	The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXNR_VAL_OBW_AVERAGING_TYPE_LOG (1)	The power spectrum is averaged in a logarithmic scale.
RFMXNR_VAL_OBW_AVERAGING_TYPE_SCALAR (2)	The square root of the power spectrum is averaged.
RFMXNR_VAL_OBW_AVERAGING_TYPE_MAXIMUM (3)	The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXNR_VAL_OBW_AVERAGING_TYPE_MINIMUM (4)	The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next.

FFT

RFMXNR_ATTR_OBW_FFT_WINDOW

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies the FFT window type to be used to reduce spectral leakage. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_OBW_FFT_WINDOW_FLAT_TOP. Get Function: RFmxNR_OBWGetFFTWindow Set Function: RFmxNR_OBWSetFFTWindow
Values:

RFMXNR_VAL_OBW_FFT_WINDOW_NONE (0)	No spectral leakage.
RFMXNR_VAL_OBW_FFT_WINDOW_FLAT_TOP (1)	Spectral leakage is reduced using flat top window type.
RFMXNR_VAL_OBW_FFT_WINDOW_HANNING (2)	Spectral leakage is reduced using Hanning window type.
RFMXNR_VAL_OBW_FFT_WINDOW_HAMMING (3)	Spectral leakage is reduced using Hamming window type.
RFMXNR_VAL_OBW_FFT_WINDOW_GAUSSIAN (4)	Spectral leakage is reduced using Gaussian window type.
RFMXNR_VAL_OBW_FFT_WINDOW_BLACKMAN (5)	Spectral leakage is reduced using Blackman window type.
RFMXNR_VAL_OBW_FFT_WINDOW_BLACKMAN_HARRIS (6)	Spectral leakage is reduced using Blackman-Harris window type.
RFMXNR_VAL_OBW_FFT_WINDOW_KAISER_BESSEL (7)	Spectral leakage is reduced using Kaiser-Bessel window type.

RFMXNR_ATTR_OBW_AMPLITUDE_CORRECTION_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies whether the amplitude of frequency bins in the spectrum used by the measurement is corrected for external attenuation at RF center frequency or corrected for external attenuation at individual frequency bins. Use the RFmxInstr_CfgExternalAttenuationTable function to configure the external attenuation table. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_OBW_AMPLITUDE_CORRECTION_TYPE_RF_CENTER_FREQUENCY. Get Function: RFmxNR_OBWGetAmplitudeCorrectionType Set Function: RFmxNR_OBWSetAmplitudeCorrectionType
Values:

RFMXNR_VAL_OBW_AMPLITUDE_CORRECTION_TYPE_RF_CENTER_FREQUENCY (0)	All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.
RFMXNR_VAL_OBW_AMPLITUDE_CORRECTION_TYPE_SPECTRUM_FREQUENCY_BIN (1)	An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

RFMXNR_ATTR_OBW_ALL_TRACES_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies whether to enable the traces to be stored and retrieved after performing the OBW measurement. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXNR_VAL_FALSE. Get Function: RFmxNR_OBWGetAllTracesEnabled Set Function: RFmxNR_OBWSetAllTracesEnabled

RFMXNR_ATTR_OBW_NUMBER_OF_ANALYSIS_THREADS

Data Type:	int32
Access:	read/write
Functions:	RFmxNR_SetAttributeI32 RFmxNR_GetAttributeI32
Description:	Specifies the maximum number of threads used for parallelism for the OBW measurement. The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 1. Get Function: RFmxNR_OBWGetNumberOfAnalysisThreads Set Function: RFmxNR_OBWSetNumberOfAnalysisThreads

Results

Subblock

RFMXNR_ATTR_OBW_RESULTS_OCCUPIED_BANDWIDTH

Data Type:	float64
Access:	read only
Functions:	RFmxNR_GetAttributeF64
Description:	Returns the bandwidth that occupies the specified percentage of the total power of the signal. This value is expressed in Hz. The occupied bandwidth is calculated using the following equation: Occupied bandwidth = Stop frequency - Start frequency Use 'subblock(n)' as the Selector Strings to read this result. Get Function: RFmxNR_OBWGetResultsOccupiedBandwidth

RFMXNR_ATTR_OBW_RESULTS_ABSOLUTE_POWER

Data Type:	float64
Access:	read only
Functions:	RFmxNR_GetAttributeF64
Description:	Returns the total power measured in the spectrum acquired by the measurement. This value is expressed in dBm. Use 'subblock(n)' as the Selector Strings to read this result. Get Function: RFmxNR_OBWGetResultsAbsolutePower

RFMXNR_ATTR_OBW_RESULTS_START_FREQUENCY

Data Type:	float64
Access:	read only
Functions:	RFmxNR_GetAttributeF64
Description:	Returns the start frequency of the occupied bandwidth of carrier/subblock. This value is expressed in Hz. The occupied bandwidth is calculated using the following equation: Occupied bandwidth = Stop frequency - Start frequency Use 'subblock(n)' as the Selector Strings to read this result. Get Function: RFmxNR_OBWGetResultsStartFrequency

RFMXNR_ATTR_OBW_RESULTS_STOP_FREQUENCY

Data Type:	float64
Access:	read only
Functions:	RFmxNR_GetAttributeF64
Description:	Returns the stop frequency of the occupied bandwidth of carrier/subblock. This value is expressed in Hz. Occupied bandwidth is calculated using the following equation: Occupied bandwidth = Stop frequency - Start frequency Use 'subblock(n)' as the Selector Strings to read this result. Get Function: RFmxNR_OBWGetResultsStopFrequency