NI RFmx LTE OBW Attributes

OBW Attributes

• RFMXLTE_ATTR_OBW_MEASUREMENT_ENABLED
• RFMXLTE_ATTR_OBW_SPAN
• RBW Filter
  • RFMXLTE_ATTR_OBW_RBW_FILTER_AUTO_BANDWIDTH
  • RFMXLTE_ATTR_OBW_RBW_FILTER_BANDWIDTH
  • RFMXLTE_ATTR_OBW_RBW_FILTER_TYPE
• Sweep Time
  • RFMXLTE_ATTR_OBW_SWEEP_TIME_AUTO
  • RFMXLTE_ATTR_OBW_SWEEP_TIME_INTERVAL
• Averaging
  • RFMXLTE_ATTR_OBW_AVERAGING_ENABLED
  • RFMXLTE_ATTR_OBW_AVERAGING_COUNT
  • RFMXLTE_ATTR_OBW_AVERAGING_TYPE
• RFMXLTE_ATTR_OBW_AMPLITUDE_CORRECTION_TYPE
• RFMXLTE_ATTR_OBW_ALL_TRACES_ENABLED
• RFMXLTE_ATTR_OBW_NUMBER_OF_ANALYSIS_THREADS
• Results
  • RFMXLTE_ATTR_OBW_RESULTS_OCCUPIED_BANDWIDTH
  • RFMXLTE_ATTR_OBW_RESULTS_ABSOLUTE_POWER
  • RFMXLTE_ATTR_OBW_RESULTS_START_FREQUENCY
  • RFMXLTE_ATTR_OBW_RESULTS_STOP_FREQUENCY

RFMXLTE_ATTR_OBW_MEASUREMENT_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_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 RFMXLTE_VAL_FALSE. Get Function: RFmxLTE_OBWGetMeasurementEnabled Set Function: RFmxLTE_OBWSetMeasurementEnabled

RFMXLTE_ATTR_OBW_SPAN

Data Type:	float64
Access:	read only
Functions:	RFmxLTE_GetAttributeF64
Description:	Returns the frequency search space to find the OBW. This value is expressed in Hz. Use 'subblock(n)' as the selector string to read this result. The default value is 10 MHz. Get Function: RFmxLTE_OBWGetSpan

OBW RBW Filter

RFMXLTE_ATTR_OBW_RBW_FILTER_AUTO_BANDWIDTH

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_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 RFMXLTE_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_TRUE. Get Function: RFmxLTE_OBWGetRBWFilterAutoBandwidth Set Function: RFmxLTE_OBWSetRBWFilterAutoBandwidth
Values:

RFMXLTE_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_FALSE (0)	The measurement uses the RBW that you specify in the RFMXLTE_ATTR_OBW_RBW_FILTER_BANDWIDTH attribute.
RFMXLTE_VAL_OBW_RBW_FILTER_AUTO_BANDWIDTH_TRUE (1)	The measurement computes the RBW.

RFMXLTE_ATTR_OBW_RBW_FILTER_BANDWIDTH

Data Type:	float64
Access:	read/write
Functions:	RFmxLTE_SetAttributeF64 RFmxLTE_GetAttributeF64
Description:	Specifies the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RFMXLTE_ATTR_OBW_RBW_FILTER_AUTO_BANDWIDTH attribute to RFMXLTE_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 10000. Get Function: RFmxLTE_OBWGetRBWFilterBandwidth Set Function: RFmxLTE_OBWSetRBWFilterBandwidth

RFMXLTE_ATTR_OBW_RBW_FILTER_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_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 RFMXLTE_VAL_OBW_RBW_FILTER_TYPE_GAUSSIAN. Get Function: RFmxLTE_OBWGetRBWFilterType Set Function: RFmxLTE_OBWSetRBWFilterType
Values:

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.

OBW Sweep Time

RFMXLTE_ATTR_OBW_SWEEP_TIME_AUTO

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32
Description:	Specifies whether the measurement computes 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 RFMXLTE_VAL_OBW_SWEEP_TIME_AUTO_TRUE. Get Function: RFmxLTE_OBWGetSweepTimeAuto Set Function: RFmxLTE_OBWSetSweepTimeAuto
Values:

RFMXLTE_VAL_OBW_SWEEP_TIME_AUTO_FALSE (0)	The measurement uses the sweep time that you specify in the RFMXLTE_ATTR_OBW_SWEEP_TIME_INTERVAL attribute.
RFMXLTE_VAL_OBW_SWEEP_TIME_AUTO_TRUE (1)	The measurement uses a sweep time of 1 ms.

RFMXLTE_ATTR_OBW_SWEEP_TIME_INTERVAL

Data Type:	float64
Access:	read/write
Functions:	RFmxLTE_SetAttributeF64 RFmxLTE_GetAttributeF64
Description:	Specifies the sweep time when you set the RFMXLTE_ATTR_OBW_SWEEP_TIME_AUTO attribute to RFMXLTE_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: RFmxLTE_OBWGetSweepTimeInterval Set Function: RFmxLTE_OBWSetSweepTimeInterval

OBW Averaging

RFMXLTE_ATTR_OBW_AVERAGING_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_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 RFMXLTE_VAL_OBW_AVERAGING_ENABLED_FALSE. Get Function: RFmxLTE_OBWGetAveragingEnabled Set Function: RFmxLTE_OBWSetAveragingEnabled
Values:

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

RFMXLTE_ATTR_OBW_AVERAGING_COUNT

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32
Description:	Specifies the number of acquisitions used for averaging when you set the RFMXLTE_ATTR_OBW_AVERAGING_ENABLED attribute to RFMXLTE_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: RFmxLTE_OBWGetAveragingCount Set Function: RFmxLTE_OBWSetAveragingCount

RFMXLTE_ATTR_OBW_AVERAGING_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_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 RFMXLTE_VAL_OBW_AVERAGING_TYPE_RMS. Get Function: RFmxLTE_OBWGetAveragingType Set Function: RFmxLTE_OBWSetAveragingType
Values:

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.

RFMXLTE_ATTR_OBW_AMPLITUDE_CORRECTION_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_GetAttributeI32
Description:	Specifies whether the amplitude of the frequency bins, used in measurements, is corrected for external attenuation at the RF center frequency, or at the 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 RFMXLTE_VAL_OBW_AMPLITUDE_CORRECTION_TYPE_RF_CENTER_FREQUENCY. Get Function: RFmxLTE_OBWGetAmplitudeCorrectionType Set Function: RFmxLTE_OBWSetAmplitudeCorrectionType
Values:

RFMXLTE_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.
RFMXLTE_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.

RFMXLTE_ATTR_OBW_ALL_TRACES_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_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 RFMXLTE_VAL_FALSE. Get Function: RFmxLTE_OBWGetAllTracesEnabled Set Function: RFmxLTE_OBWSetAllTracesEnabled

RFMXLTE_ATTR_OBW_NUMBER_OF_ANALYSIS_THREADS

Data Type:	int32
Access:	read/write
Functions:	RFmxLTE_SetAttributeI32 RFmxLTE_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: RFmxLTE_OBWGetNumberOfAnalysisThreads Set Function: RFmxLTE_OBWSetNumberOfAnalysisThreads

OBW Results

RFMXLTE_ATTR_OBW_RESULTS_OCCUPIED_BANDWIDTH

Data Type:	float64
Access:	read only
Functions:	RFmxLTE_GetAttributeF64
Description:	Returns the bandwidth that occupies 99 percentage of the total power of the signal within a carrier/subblock. This value is expressed in Hz. Use 'subblock(n)' as the selector string to read this result. Refer to the LTE Occupied Bandwidth topic for more information. Get Function: RFmxLTE_OBWGetResultsOccupiedBandwidth

RFMXLTE_ATTR_OBW_RESULTS_ABSOLUTE_POWER

Data Type:	float64
Access:	read only
Functions:	RFmxLTE_GetAttributeF64
Description:	Returns the total power measured in the carrier/subblock. This value is expressed in dBm. Use 'subblock(n)' as the selector string to read this result. Get Function: RFmxLTE_OBWGetResultsAbsolutePower

RFMXLTE_ATTR_OBW_RESULTS_START_FREQUENCY

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

RFMXLTE_ATTR_OBW_RESULTS_STOP_FREQUENCY

Data Type:	float64
Access:	read only
Functions:	RFmxLTE_GetAttributeF64
Description:	Returns the stop frequency of the 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 string to read this result. Get Function: RFmxLTE_OBWGetResultsStopFrequency