NI RFmx SpecAn Harm Attributes

Harm Attributes

• RFMXSPECAN_ATTR_HARM_MEASUREMENT_ENABLED
• Fundamental
  • RBW Filter
    • RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_RBW_FILTER_BANDWIDTH
    • RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_RBW_FILTER_TYPE
    • RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_RBW_FILTER_ALPHA
  • RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_MEASUREMENT_INTERVAL
• RFMXSPECAN_ATTR_HARM_NUMBER_OF_HARMONICS
• RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED
• Harmonic
  • RFMXSPECAN_ATTR_HARM_HARMONIC_ENABLED
  • RFMXSPECAN_ATTR_HARM_HARMONIC_ORDER
  • RFMXSPECAN_ATTR_HARM_HARMONIC_BANDWIDTH
  • RFMXSPECAN_ATTR_HARM_HARMONIC_MEASUREMENT_INTERVAL
• RFMXSPECAN_ATTR_HARM_MEASUREMENT_METHOD
• RFMXSPECAN_ATTR_HARM_NOISE_COMPENSATION_ENABLED
• Averaging
  • RFMXSPECAN_ATTR_HARM_AVERAGING_ENABLED
  • RFMXSPECAN_ATTR_HARM_AVERAGING_COUNT
  • RFMXSPECAN_ATTR_HARM_AVERAGING_TYPE
• RFMXSPECAN_ATTR_HARM_ALL_TRACES_ENABLED
• RFMXSPECAN_ATTR_HARM_NUMBER_OF_ANALYSIS_THREADS
• Results
  • RFMXSPECAN_ATTR_HARM_RESULTS_TOTAL_HARMONIC_DISTORTION
  • RFMXSPECAN_ATTR_HARM_RESULTS_AVERAGE_FUNDAMENTAL_POWER
  • RFMXSPECAN_ATTR_HARM_RESULTS_FUNDAMENTAL_FREQUENCY
  • Harmonics
    • RFMXSPECAN_ATTR_HARM_RESULTS_HARMONIC_AVERAGE_ABSOLUTE_POWER
    • RFMXSPECAN_ATTR_HARM_RESULTS_HARMONIC_AVERAGE_RELATIVE_POWER
    • RFMXSPECAN_ATTR_HARM_RESULTS_HARMONIC_FREQUENCY
    • RFMXSPECAN_ATTR_HARM_RESULTS_HARMONIC_RBW

RFMXSPECAN_ATTR_HARM_MEASUREMENT_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable the Harmonics 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. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetMeasurementEnabled Set Function: RFmxSpecAn_HarmSetMeasurementEnabled

Harm Fundamental

Harm RBW Filter

RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_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 fundamental 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. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetFundamentalRBWFilterBandwidth Set Function: RFmxSpecAn_HarmSetFundamentalRBWFilterBandwidth

RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_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_HARM_RBW_FILTER_TYPE_GAUSSIAN. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetFundamentalRBWFilterType Set Function: RFmxSpecAn_HarmSetFundamentalRBWFilterType
Values:

RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_NONE (5)	The measurement does not use any RBW filtering.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_GAUSSIAN (1)	The RBW filter has a Gaussian response.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_FLAT (2)	The RBW filter has a flat response.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_RRC (6)	The RRC filter with the roll-off specified by the RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_RBW_FILTER_ALPHA attribute is used as the RBW filter.

RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_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. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetFundamentalRBWFilterAlpha Set Function: RFmxSpecAn_HarmSetFundamentalRBWFilterAlpha

RFMXSPECAN_ATTR_HARM_FUNDAMENTAL_MEASUREMENT_INTERVAL

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies the acquisition time for the Harmonics measurement of the fundamental signal. 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. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetFundamentalMeasurementInterval Set Function: RFmxSpecAn_HarmSetFundamentalMeasurementInterval

RFMXSPECAN_ATTR_HARM_NUMBER_OF_HARMONICS

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the number of harmonics, including fundamental, to measure. 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. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetNumberOfHarmonics Set Function: RFmxSpecAn_HarmSetNumberOfHarmonics

RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable auto configuration of successive harmonics. 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_HARM_AUTO_HARMONICS_SETUP_ENABLED_TRUE. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetAutoSetupEnabled Set Function: RFmxSpecAn_HarmSetAutoSetupEnabled
Values:

RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_FALSE (0)	The measurement uses manual configuration for the harmonic order, harmonic bandwidth, and harmonic measurement interval.
RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_TRUE (1)	The measurement uses the RFMXSPECAN_ATTR_HARM_NUMBER_OF_HARMONICS attribute and configuration of the fundamental to configure successive harmonics. Bandwidth of Nth order harmonic = N * (Bandwidth of fundamental). Measurement interval of Nth order harmonics = (Measurement interval of fundamental)/N

Harm Harmonic

RFMXSPECAN_ATTR_HARM_HARMONIC_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD). This attribute is not used if you set the RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED to RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_TRUE. Use 'harmonic(n)' as the selector string to configure or read this attribute. The default value is RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_TRUE. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetHarmonicEnabled Set Function: RFmxSpecAn_HarmSetHarmonicEnabled
Values:

RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_FALSE (0)	Disables the harmonic for measurement.
RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_TRUE (1)	Enables the harmonic for measurement.

RFMXSPECAN_ATTR_HARM_HARMONIC_ORDER

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the order of the harmonic. This attribute is not used if you set the RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED to RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_TRUE. Frequency of Nth order harmonic = N * (Frequency of fundamental) Use 'harmonic(n)' as the selector string to configure or read this attribute. The default value is 1. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetHarmonicOrder Set Function: RFmxSpecAn_HarmSetHarmonicOrder

RFMXSPECAN_ATTR_HARM_HARMONIC_BANDWIDTH

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies the resolution bandwidth for the harmonic. This attribute is not used if you set the RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED to RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_TRUE. This value is expressed in Hz. Use 'harmonic(n)' as the selector string to configure or read this attribute. The default value is 100 kHz. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetHarmonicBandwidth Set Function: RFmxSpecAn_HarmSetHarmonicBandwidth

RFMXSPECAN_ATTR_HARM_HARMONIC_MEASUREMENT_INTERVAL

Data Type:	float64
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeF64 RFmxSpecAn_GetAttributeF64
Description:	Specifies the acquisition time for the harmonic. This value is expressed in seconds. This attribute is not used if you set the RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED to RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_TRUE. Use 'harmonic(n)' as the selector string to configure or read this attribute. The default value is 1 ms. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetHarmonicMeasurementInterval Set Function: RFmxSpecAn_HarmSetHarmonicMeasurementInterval

RFMXSPECAN_ATTR_HARM_MEASUREMENT_METHOD

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the method used to perform the harmonics 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_HARM_MEASUREMENT_METHOD_TIME_DOMAIN. Get Function: RFmxSpecAn_HarmGetMeasurementMethod Set Function: RFmxSpecAn_HarmSetMeasurementMethod
Values:

RFMXSPECAN_VAL_HARM_MEASUREMENT_METHOD_TIME_DOMAIN (0)	The harmonics measurement acquires the signal using the same signal analyzer setting across frequency bands. Use this method when the measurement speed is desirable over higher dynamic range. Supported devices: PXIe-5644/5645/5646, PXIe-5663/5665/5668
RFMXSPECAN_VAL_HARM_MEASUREMENT_METHOD_DYNAMIC_RANGE (2)	The harmonics measurement acquires the signal using the hardware-specific features, such as the IF filter and IF gain, for different frequency bands. Use this method to get the best dynamic range. Supported devices: PXIe-5665/5668

RFMXSPECAN_ATTR_HARM_NOISE_COMPENSATION_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable compensation of the average harmonic powers for inherent noise floor of the signal analyzer. 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_HARM_NOISE_COMPENSATION_ENABLED_FALSE. Get Function: RFmxSpecAn_HarmGetNoiseCompensationEnabled Set Function: RFmxSpecAn_HarmSetNoiseCompensationEnabled
Values:

RFMXSPECAN_VAL_HARM_NOISE_COMPENSATION_ENABLED_FALSE (0)	Disables compensation of the average harmonic powers for the noise floor of the signal analyzer.
RFMXSPECAN_VAL_HARM_NOISE_COMPENSATION_ENABLED_TRUE (1)	Enables compensation of the average harmonic powers for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the harmonics measurement and cached for future use. If the signal analyzer or measurement parameters change, noise floors are measured again. Supported devices: PXIe-5663/5665/5668

Harm Averaging

RFMXSPECAN_ATTR_HARM_AVERAGING_ENABLED

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies whether to enable averaging for the Harmonics 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_HARM_AVERAGING_ENABLED_FALSE. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetAveragingEnabled Set Function: RFmxSpecAn_HarmSetAveragingEnabled
Values:

RFMXSPECAN_VAL_HARM_AVERAGING_ENABLED_FALSE (0)	The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_HARM_AVERAGING_ENABLED_TRUE (1)	The Harmonics measurement uses the RFMXSPECAN_ATTR_HARM_AVERAGING_COUNT attribute as the number of acquisitions over which the Harmonics measurement is averaged.

RFMXSPECAN_ATTR_HARM_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_HARM_AVERAGING_ENABLED attribute to RFMXSPECAN_VAL_HARM_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. Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668 Get Function: RFmxSpecAn_HarmGetAveragingCount Set Function: RFmxSpecAn_HarmSetAveragingCount

RFMXSPECAN_ATTR_HARM_AVERAGING_TYPE

Data Type:	int32
Access:	read/write
Functions:	RFmxSpecAn_SetAttributeI32 RFmxSpecAn_GetAttributeI32
Description:	Specifies the averaging type for the Harmonics 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_HARM_AVERAGING_TYPE_RMS. Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668 Get Function: RFmxSpecAn_HarmGetAveragingType Set Function: RFmxSpecAn_HarmSetAveragingType
Values:

RFMXSPECAN_VAL_HARM_AVERAGING_TYPE_RMS (0)	The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_HARM_AVERAGING_TYPE_LOG (1)	The power trace is averaged in a logarithmic scale.
RFMXSPECAN_VAL_HARM_AVERAGING_TYPE_SCALAR (2)	The square root of the power trace is averaged.
RFMXSPECAN_VAL_HARM_AVERAGING_TYPE_MAXIMUM (3)	The maximum instantaneous power in the power trace is retained from one acquisition to the next.
RFMXSPECAN_VAL_HARM_AVERAGING_TYPE_MINIMUM (4)	The minimum instantaneous power in the power trace is retained from one acquisition to the next.

RFMXSPECAN_ATTR_HARM_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 Harmonics 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. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetAllTracesEnabled Set Function: RFmxSpecAn_HarmSetAllTracesEnabled

RFMXSPECAN_ATTR_HARM_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 Harmonics 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. Supported devices: PXIe-5665/5668 Get Function: RFmxSpecAn_HarmGetNumberOfAnalysisThreads Set Function: RFmxSpecAn_HarmSetNumberOfAnalysisThreads

Harm Results

RFMXSPECAN_ATTR_HARM_RESULTS_TOTAL_HARMONIC_DISTORTION

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the total harmonics distortion (THD), measured as a percentage of the power in the fundamental signal. THD (%) = SQRT (Total power of all enabled harmonics - Power in fundamental) * 100 / Power in fundamental 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_HarmGetResultsTotalHarmonicDistortion

RFMXSPECAN_ATTR_HARM_RESULTS_AVERAGE_FUNDAMENTAL_POWER

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the average power measured at the fundamental frequency. 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_HarmGetResultsAverageFundamentalPower

RFMXSPECAN_ATTR_HARM_RESULTS_FUNDAMENTAL_FREQUENCY

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the frequency used as the fundamental frequency. 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. Get Function: RFmxSpecAn_HarmGetResultsFundamentalFrequency

Harm Results Harmonics

RFMXSPECAN_ATTR_HARM_RESULTS_HARMONIC_AVERAGE_ABSOLUTE_POWER

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the average absolute power measured at the harmonic specified by the selector string. This value is expressed in dBm. Use 'harmonic(n)' as the selector string to read this result. Get Function: RFmxSpecAn_HarmGetResultsHarmonicAverageAbsolutePower

RFMXSPECAN_ATTR_HARM_RESULTS_HARMONIC_AVERAGE_RELATIVE_POWER

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the average power relative to the fundamental power measured at the harmonic specified by the selector string. This value is expressed in dB. Use 'harmonic(n)' as the selector string to read this result. Get Function: RFmxSpecAn_HarmGetResultsHarmonicAverageRelativePower

RFMXSPECAN_ATTR_HARM_RESULTS_HARMONIC_FREQUENCY

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the RF frequency of the harmonic. This value is expressed in Hz. Use 'harmonic(n)' as the selector string to read this result. Get Function: RFmxSpecAn_HarmGetResultsHarmonicFrequency

RFMXSPECAN_ATTR_HARM_RESULTS_HARMONIC_RBW

Data Type:	float64
Access:	read only
Functions:	RFmxSpecAn_GetAttributeF64
Description:	Returns the resolution bandwidth (RBW) which is used by the harmonic measurement, for the harmonic specified by the selector string. This value is expressed in Hz. Use 'harmonic(n)' as the selector string to read this result. Get Function: RFmxSpecAn_HarmGetResultsHarmonicRBW