NI RFmx SpecAn TXP Attributes

TXP Attributes

• RFMXSPECAN_ATTR_TXP_MEASUREMENT_ENABLED
• RFMXSPECAN_ATTR_TXP_MEASUREMENT_INTERVAL
• RBW Filter
  • RFMXSPECAN_ATTR_TXP_RBW_FILTER_BANDWIDTH
  • RFMXSPECAN_ATTR_TXP_RBW_FILTER_TYPE
  • RFMXSPECAN_ATTR_TXP_RBW_FILTER_ALPHA
• VBW Filter
  • RFMXSPECAN_ATTR_TXP_VBW_FILTER_AUTO_BANDWIDTH
  • RFMXSPECAN_ATTR_TXP_VBW_FILTER_BANDWIDTH
• RFMXSPECAN_ATTR_TXP_VBW_FILTER_VBW_TO_RBW_RATIO
• Threshold
  • RFMXSPECAN_ATTR_TXP_THRESHOLD_ENABLED
  • RFMXSPECAN_ATTR_TXP_THRESHOLD_TYPE
  • RFMXSPECAN_ATTR_TXP_THRESHOLD_LEVEL
• Averaging
  • RFMXSPECAN_ATTR_TXP_AVERAGING_ENABLED
  • RFMXSPECAN_ATTR_TXP_AVERAGING_COUNT
  • RFMXSPECAN_ATTR_TXP_AVERAGING_TYPE
• RFMXSPECAN_ATTR_TXP_ALL_TRACES_ENABLED
• RFMXSPECAN_ATTR_TXP_NUMBER_OF_ANALYSIS_THREADS
• Results
  • RFMXSPECAN_ATTR_TXP_RESULTS_AVERAGE_MEAN_POWER
  • RFMXSPECAN_ATTR_TXP_RESULTS_PEAK_TO_AVERAGE_RATIO
  • RFMXSPECAN_ATTR_TXP_RESULTS_MAXIMUM_POWER
  • RFMXSPECAN_ATTR_TXP_RESULTS_MINIMUM_POWER

RFMXSPECAN_ATTR_TXP_MEASUREMENT_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable the TXP 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 RFMXSPECAN_VAL_FALSE. Get Function: RFmxSpecAn_TXPGetMeasurementEnabled Set Function: RFmxSpecAn_TXPSetMeasurementEnabled

RFMXSPECAN_ATTR_TXP_MEASUREMENT_INTERVAL

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies the acquisition time for the TXP measurement. 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 0.001. Get Function: RFmxSpecAn_TXPGetMeasurementInterval Set Function: RFmxSpecAn_TXPSetMeasurementInterval

TXP RBW Filter

RFMXSPECAN_ATTR_TXP_RBW_FILTER_BANDWIDTH

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. 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 100 kHz. Get Function: RFmxSpecAn_TXPGetRBWFilterBandwidth Set Function: RFmxSpecAn_TXPSetRBWFilterBandwidth

RFMXSPECAN_ATTR_TXP_RBW_FILTER_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the shape of the digital resolution bandwidth (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 RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_GAUSSIAN. Get Function: RFmxSpecAn_TXPGetRBWFilterType Set Function: RFmxSpecAn_TXPSetRBWFilterType
Values:

RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_NONE (1)	The RBW filter has a Gaussian response.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_GAUSSIAN (2)	The RBW filter has a flat response.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_FLAT (5)	The measurement does not use any RBW filtering.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_RRC (6)	The RRC filter with the roll-off specified by the RFMXSPECAN_ATTR_TXP_RBW_FILTER_ALPHA attribute is used as the RBW filter.

RFMXSPECAN_ATTR_TXP_RBW_FILTER_ALPHA

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies the roll-off factor for the root-raised-cosine (RRC) 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 0.1. Get Function: RFmxSpecAn_TXPGetRBWFilterAlpha Set Function: RFmxSpecAn_TXPSetRBWFilterAlpha

TXP VBW Filter

RFMXSPECAN_ATTR_TXP_VBW_FILTER_AUTO_BANDWIDTH

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio. 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 RFMXSPECAN_VAL_TXP_VBW_FILTER_AUTO_BANDWIDTH_TRUE. Get Function: RFmxSpecAn_TXPGetVBWFilterAutoBandwidth Set Function: RFmxSpecAn_TXPSetVBWFilterAutoBandwidth
Values:

RFMXSPECAN_VAL_TXP_VBW_FILTER_AUTO_BANDWIDTH_FALSE (0)	Specify the video bandwidth in the RFMXSPECAN_ATTR_TXP_VBW_FILTER_BANDWIDTH attribute. The RFMXSPECAN_ATTR_TXP_VBW_FILTER_VBW_TO_RBW_RATIO attribute is disregarded in this mode.
RFMXSPECAN_VAL_TXP_VBW_FILTER_AUTO_BANDWIDTH_TRUE (1)	Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the RFMXSPECAN_ATTR_TXP_VBW_FILTER_VBW_TO_RBW_RATIO attribute and the RFMXSPECAN_ATTR_TXP_RBW_FILTER_BANDWIDTH attribute. The value of the RFMXSPECAN_ATTR_TXP_VBW_FILTER_BANDWIDTH attribute is disregarded in this mode.

RFMXSPECAN_ATTR_TXP_VBW_FILTER_BANDWIDTH

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies the video bandwidth when you set the RFMXSPECAN_ATTR_TXP_VBW_FILTER_AUTO_BANDWIDTH attribute to RFMXSPECAN_VAL_TXP_VBW_FILTER_AUTO_BANDWIDTH_FALSE. 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 30000. Get Function: RFmxSpecAn_TXPGetVBWFilterBandwidth Set Function: RFmxSpecAn_TXPSetVBWFilterBandwidth

RFMXSPECAN_ATTR_TXP_VBW_FILTER_VBW_TO_RBW_RATIO

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies the VBW to RBW Ratio when you set the RFMXSPECAN_ATTR_TXP_VBW_FILTER_AUTO_BANDWIDTH attribute to RFMXSPECAN_VAL_TXP_VBW_FILTER_AUTO_BANDWIDTH_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 3. Get Function: RFmxSpecAn_TXPGetVBWFilterVBWToRBWRatio Set Function: RFmxSpecAn_TXPSetVBWFilterVBWToRBWRatio

TXP Threshold

RFMXSPECAN_ATTR_TXP_THRESHOLD_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable thresholding of the acquired samples to be used for the TXP 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 RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_FALSE. Get Function: RFmxSpecAn_TXPGetThresholdEnabled Set Function: RFmxSpecAn_TXPSetThresholdEnabled
Values:

RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_FALSE (0)	All the acquired samples are considered for the TXP measurement.
RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_TRUE (1)	The samples above the threshold level specified in the RFMXSPECAN_ATTR_TXP_THRESHOLD_LEVEL attribute are considered for the TXP measurement.

RFMXSPECAN_ATTR_TXP_THRESHOLD_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the reference for the power level used for thresholding. 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 RFMXSPECAN_VAL_TXP_THRESHOLD_TYPE_RELATIVE. Get Function: RFmxSpecAn_TXPGetThresholdType Set Function: RFmxSpecAn_TXPSetThresholdType
Values:

RFMXSPECAN_VAL_TXP_THRESHOLD_TYPE_RELATIVE (0)	The threshold is relative to the peak power of the acquired samples.
RFMXSPECAN_VAL_TXP_THRESHOLD_TYPE_ABSOLUTE (1)	The threshold is the absolute power, in dBm.

RFMXSPECAN_ATTR_TXP_THRESHOLD_LEVEL

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies either the relative or absolute threshold power level based on the value of the RFMXSPECAN_ATTR_TXP_THRESHOLD_TYPE attribute. The default value is -20. Get Function: RFmxSpecAn_TXPGetThresholdLevel Set Function: RFmxSpecAn_TXPSetThresholdLevel

TXP Averaging

RFMXSPECAN_ATTR_TXP_AVERAGING_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable averaging for the TXP 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 RFMXSPECAN_VAL_TXP_AVERAGING_ENABLED_FALSE. Get Function: RFmxSpecAn_TXPGetAveragingEnabled Set Function: RFmxSpecAn_TXPSetAveragingEnabled
Values:

RFMXSPECAN_VAL_TXP_AVERAGING_ENABLED_FALSE (0)	The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_TXP_AVERAGING_ENABLED_TRUE (1)	The TXP measurement uses the RFMXSPECAN_ATTR_TXP_AVERAGING_COUNT attribute as the number of acquisitions over which the TXP measurement is averaged.

RFMXSPECAN_ATTR_TXP_AVERAGING_COUNT

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the number of acquisitions used for averaging when you set the RFMXSPECAN_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXSPECAN_VAL_TXP_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: RFmxSpecAn_TXPGetAveragingCount Set Function: RFmxSpecAn_TXPSetAveragingCount

RFMXSPECAN_ATTR_TXP_AVERAGING_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the averaging type for the TXP measurement. The averaged power trace is used for the 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 RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_RMS. Get Function: RFmxSpecAn_TXPGetAveragingType Set Function: RFmxSpecAn_TXPSetAveragingType
Values:

RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_RMS (0)	The power trace is linearly averaged.
RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_LOG (1)	The power trace is averaged in a logarithmic scale.
RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_SCALAR (2)	The square root of the power trace is averaged.
RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_MAXIMUM (3)	The maximum instantaneous power in the power trace is retained from one acquisition to the next.
RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_MINIMUM (4)	The minimum instantaneous power in the power trace is retained from one acquisition to the next.

RFMXSPECAN_ATTR_TXP_ALL_TRACES_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable the traces to be stored and retrieved after performing the TXP 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 RFMXSPECAN_VAL_FALSE. Get Function: RFmxSpecAn_TXPGetAllTracesEnabled Set Function: RFmxSpecAn_TXPSetAllTracesEnabled

RFMXSPECAN_ATTR_TXP_NUMBER_OF_ANALYSIS_THREADS

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the maximum number of threads used for parallelism for TXP 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: RFmxSpecAn_TXPGetNumberOfAnalysisThreads Set Function: RFmxSpecAn_TXPSetNumberOfAnalysisThreads

TXP Results

RFMXSPECAN_ATTR_TXP_RESULTS_AVERAGE_MEAN_POWER

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the mean power of the signal. This value is expressed in dBm. Only the samples above the threshold are used by the measurement when you set the RFMXSPECAN_ATTR_TXP_THRESHOLD_ENABLED attribute to RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_TRUE. When you set the RFMXSPECAN_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_TRUE, the mean power is measured using the power trace averaged over multiple acquisitions. You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector Strings topic for information about the string syntax for named signals and results. Get Function: RFmxSpecAn_TXPGetResultsAverageMeanPower

RFMXSPECAN_ATTR_TXP_RESULTS_PEAK_TO_AVERAGE_RATIO

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the ratio of the peak power of the signal to the mean power. Only the samples above the threshold are used by the measurement when you set the RFMXSPECAN_ATTR_TXP_THRESHOLD_ENABLED attribute to RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_TRUE. When you set the RFMXSPECAN_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_TRUE, the peak and mean powers are measured using the power trace averaged over multiple acquisitions. You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector Strings topic for information about the string syntax for named signals and results. Get Function: RFmxSpecAn_TXPGetResultsPeaktoAverageRatio

RFMXSPECAN_ATTR_TXP_RESULTS_MAXIMUM_POWER

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the maximum power of the averaged power trace. This value is expressed in dBm. You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector Strings topic for information about the string syntax for named signals and results. Get Function: RFmxSpecAn_TXPGetResultsMaximumPower

RFMXSPECAN_ATTR_TXP_RESULTS_MINIMUM_POWER

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the minimum power of the averaged power trace. This value is expressed in dBm. You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector Strings topic for information about the string syntax for named signals and results. Get Function: RFmxSpecAn_TXPGetResultsMinimumPower