Skip to content

NI RFmx SpecAn AMPM Attributes

Jump to bottom
Alex Starche edited this page Feb 28, 2022 · 4 revisions

AMPM Attributes

RFMXSPECAN_ATTR_AMPM_MEASUREMENT_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable the AMPM 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_AMPMGetMeasurementEnabled
Set Function: RFmxSpecAn_AMPMSetMeasurementEnabled

AMPM Measurement Sample Rate

RFMXSPECAN_ATTR_AMPM_MEASUREMENT_SAMPLE_RATE_MODE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether the acquisition sample rate is based on the reference waveform.

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

Get Function: RFmxSpecAn_AMPMGetMeasurementSampleRateMode
Set Function: RFmxSpecAn_AMPMSetMeasurementSampleRateMode
Values:
RFMXSPECAN_VAL_AMPM_MEASUREMENT_SAMPLE_RATE_MODE_USER (0) The acquisition sample rate is defined by the value of the RFMXSPECAN_ATTR_AMPM_MEASUREMENT_SAMPLE_RATE attribute.
RFMXSPECAN_VAL_AMPM_MEASUREMENT_SAMPLE_RATE_MODE_REFERENCE_WAVEFORM (1) The acquisition sample rate is set to match the sample rate of the reference waveform.

RFMXSPECAN_ATTR_AMPM_MEASUREMENT_SAMPLE_RATE

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the acquisition sample rate when you set the RFMXSPECAN_ATTR_AMPM_MEASUREMENT_SAMPLE_RATE_MODE attribute to RFMXSPECAN_VAL_AMPM_MEASUREMENT_SAMPLE_RATE_MODE_USER. This value is expressed in samples per second (S/s).

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 120,000,000.

Get Function: RFmxSpecAn_AMPMGetMeasurementSampleRate
Set Function: RFmxSpecAn_AMPMSetMeasurementSampleRate

RFMXSPECAN_ATTR_AMPM_MEASUREMENT_INTERVAL

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the duration of the reference waveform considered for the AMPM measurement. When the reference waveform contains an idle duration, the AMPM measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform. 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 100E-6.

Get Function: RFmxSpecAn_AMPMGetMeasurementInterval
Set Function: RFmxSpecAn_AMPMSetMeasurementInterval

RFMXSPECAN_ATTR_AMPM_SIGNAL_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether the reference waveform is a modulated signal or a combination of one or more sinusoidal signals. To time-align the sinusoidal reference waveform to the acquired signal, set the RFMXSPECAN_ATTR_AMPM_SIGNAL_TYPE attribute to Tones, which switches the AMPM measurement alignment algorithm.

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

Get Function: RFmxSpecAn_AMPMGetSignalType
Set Function: RFmxSpecAn_AMPMSetSignalType
Values:
RFMXSPECAN_VAL_AMPM_SIGNAL_TYPE_MODULATED (0) The reference waveform is a cellular or connectivity standard signal.
RFMXSPECAN_VAL_AMPM_SIGNAL_TYPE_TONES (1) The reference waveform is a continuous signal comprising of one or more tones.

RFMXSPECAN_ATTR_AMPM_SYNCHRONIZATION_METHOD

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the method used for synchronization of acquired waveform with reference waveform.

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

Get Function: RFmxSpecAn_AMPMGetSynchronizationMethod
Set Function: RFmxSpecAn_AMPMSetSynchronizationMethod
Values:
RFMXSPECAN_VAL_AMPM_SYNCHRONIZATION_METHOD_DIRECT (1) Synchronizes the acquired and reference waveforms assuming that sample rate is sufficient to prevent aliasing in intermediate operations. This method is recommended when the measurement sampling rate is high.
RFMXSPECAN_VAL_AMPM_SYNCHRONIZATION_METHOD_ALIAS_PROTECTED (2) Synchronizes the acquired and reference waveforms while ascertaining that intermediate operations are not impacted by aliasing. This method is recommended for non-contiguous carriers separated by a large gap, and/or when the measurement sampling rate is low. Refer to AMPM concept help for more information.

AMPM Carrier

RFMXSPECAN_ATTR_AMPM_AUTO_CARRIER_DETECTION_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies if auto detection of carrier offset and carrier bandwidth is enabled.

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

Get Function: RFmxSpecAn_AMPMGetAutoCarrierDetectionEnabled
Set Function: RFmxSpecAn_AMPMSetAutoCarrierDetectionEnabled
Values:
RFMXSPECAN_VAL_AMPM_AUTO_CARRIER_DETECTION_ENABLED_FALSE (0) Disables auto detection of carrier offset and carrier bandwidth.
RFMXSPECAN_VAL_AMPM_AUTO_CARRIER_DETECTION_ENABLED_TRUE (1) Enables auto detection of carrier offset and carrier bandwidth.

RFMXSPECAN_ATTR_AMPM_NUMBER_OF_CARRIERS

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the number of carriers in the reference waveform when you set the RFMXSPECAN_ATTR_AMPM_AUTO_CARRIER_DETECTION_ENABLED attribute to RFMXSPECAN_VAL_AMPM_AUTO_CARRIER_DETECTION_ENABLED_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 1.

Get Function: RFmxSpecAn_AMPMGetNumberOfCarriers
Set Function: RFmxSpecAn_AMPMSetNumberOfCarriers

RFMXSPECAN_ATTR_AMPM_CARRIER_OFFSET

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the carrier offset when you set the RFMXSPECAN_ATTR_AMPM_AUTO_CARRIER_DETECTION_ENABLED attribute to RFMXSPECAN_VAL_AMPM_AUTO_CARRIER_DETECTION_ENABLED_FALSE. This value is expressed in Hz.

Use 'carrier(n)' as the selector string to configure or read this attribute.

The default value is 0.

Get Function: RFmxSpecAn_AMPMGetCarrierOffset
Set Function: RFmxSpecAn_AMPMSetCarrierOffset

RFMXSPECAN_ATTR_AMPM_CARRIER_BANDWIDTH

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the carrier bandwidth when you set the RFMXSPECAN_ATTR_AMPM_AUTO_CARRIER_DETECTION_ENABLED attribute to RFMXSPECAN_VAL_AMPM_AUTO_CARRIER_DETECTION_ENABLED_FALSE. This value is expressed in Hz.

Use 'carrier(n)' as the selector string to configure or read this attribute.

The default value is 20 MHz.

Get Function: RFmxSpecAn_AMPMGetCarrierBandwidth
Set Function: RFmxSpecAn_AMPMSetCarrierBandwidth

RFMXSPECAN_ATTR_AMPM_DUT_AVERAGE_INPUT_POWER

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the average power of the signal at the input port of the device under test. This value is expressed in dBm.

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 -20 dBm.

Get Function: RFmxSpecAn_AMPMGetDUTAverageInputPower
Set Function: RFmxSpecAn_AMPMSetDUTAverageInputPower

AMPM Amam Curve Fit

RFMXSPECAN_ATTR_AMPM_AM_TO_AM_CURVE_FIT_ORDER

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the degree of the polynomial used to approximate the AM-to-AM characteristic of the device under test (DUT).

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

Get Function: RFmxSpecAn_AMPMGetAMToAMCurveFitOrder
Set Function: RFmxSpecAn_AMPMSetAMToAMCurveFitOrder

RFMXSPECAN_ATTR_AMPM_AM_TO_AM_CURVE_FIT_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the polynomial approximation cost-function of the device under test AM-to-AM characteristic.

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

Get Function: RFmxSpecAn_AMPMGetAMToAMCurveFitType
Set Function: RFmxSpecAn_AMPMSetAMToAMCurveFitType
Values:
RFMXSPECAN_VAL_AMPM_AM_TO_AM_CURVE_FIT_TYPE_LEAST_SQUARE (0) The measurement minimizes the energy of the polynomial approximation error.
RFMXSPECAN_VAL_AMPM_AM_TO_AM_CURVE_FIT_TYPE_LEAST_ABSOLUTE_RESIDUAL (1) The measurement minimizes the magnitude of the polynomial approximation error.
RFMXSPECAN_VAL_AMPM_AM_TO_AM_CURVE_FIT_TYPE_BISQUARE (2) The measurement excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

AMPM AMPM Curve Fit

RFMXSPECAN_ATTR_AMPM_AM_TO_PM_CURVE_FIT_ORDER

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the degree of the polynomial used to approximate the AM-to-PM characteristic of the device under test.

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

Get Function: RFmxSpecAn_AMPMGetAMToPMCurveFitOrder
Set Function: RFmxSpecAn_AMPMSetAMToPMCurveFitOrder

RFMXSPECAN_ATTR_AMPM_AM_TO_PM_CURVE_FIT_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the polynomial approximation cost-function of the device under test AM-to-PM characteristic.

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

Get Function: RFmxSpecAn_AMPMGetAMToPMCurveFitType
Set Function: RFmxSpecAn_AMPMSetAMToPMCurveFitType
Values:
RFMXSPECAN_VAL_AMPM_AM_TO_PM_CURVE_FIT_TYPE_LEAST_SQUARE (0) The measurement minimizes the energy of the polynomial approximation error.
RFMXSPECAN_VAL_AMPM_AM_TO_PM_CURVE_FIT_TYPE_LEAST_ABSOLUTE_RESIDUAL (1) The measurement minimizes the magnitude of the polynomial approximation error.
RFMXSPECAN_VAL_AMPM_AM_TO_PM_CURVE_FIT_TYPE_BISQUARE (2) The measurement excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

AMPM Threshold

RFMXSPECAN_ATTR_AMPM_THRESHOLD_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable thresholding of the acquired samples used for the AMPM 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_AMPM_THRESHOLD_ENABLED_TRUE.

Get Function: RFmxSpecAn_AMPMGetThresholdEnabled
Set Function: RFmxSpecAn_AMPMSetThresholdEnabled
Values:
RFMXSPECAN_VAL_AMPM_THRESHOLD_ENABLED_FALSE (0) All samples are considered for the AMPM measurement.
RFMXSPECAN_VAL_AMPM_THRESHOLD_ENABLED_TRUE (1) Samples above the threshold level specified in the RFMXSPECAN_ATTR_AMPM_THRESHOLD_LEVEL attribute are considered for the AMPM measurement.

RFMXSPECAN_ATTR_AMPM_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_AMPM_THRESHOLD_TYPE_RELATIVE.

Get Function: RFmxSpecAn_AMPMGetThresholdType
Set Function: RFmxSpecAn_AMPMSetThresholdType
Values:
RFMXSPECAN_VAL_AMPM_THRESHOLD_TYPE_RELATIVE (0) The threshold is relative to the peak power of the acquired samples.
RFMXSPECAN_VAL_AMPM_THRESHOLD_TYPE_ABSOLUTE (1) The threshold is the absolute power, in dBm.

RFMXSPECAN_ATTR_AMPM_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_AMPM_THRESHOLD_TYPE attribute.

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 -20 dB.

Get Function: RFmxSpecAn_AMPMGetThresholdLevel
Set Function: RFmxSpecAn_AMPMSetThresholdLevel

RFMXSPECAN_ATTR_AMPM_FREQUENCY_OFFSET_CORRECTION_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Enables frequency offset correction 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_AMPM_FREQUENCY_OFFSET_CORRECTION_ENABLED_TRUE.

Get Function: RFmxSpecAn_AMPMGetFrequencyOffsetCorrectionEnabled
Set Function: RFmxSpecAn_AMPMSetFrequencyOffsetCorrectionEnabled
Values:
RFMXSPECAN_VAL_AMPM_FREQUENCY_OFFSET_CORRECTION_ENABLED_FALSE (0) The measurement does not perform frequency offset correction.
RFMXSPECAN_VAL_AMPM_FREQUENCY_OFFSET_CORRECTION_ENABLED_TRUE (1) The measurement computes and corrects any frequency offset between the reference and the acquired waveforms.

RFMXSPECAN_ATTR_AMPM_IQ_ORIGIN_OFFSET_CORRECTION_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Enables IQ origin offset correction for the measurement.

When you set this attribute is set to True, the measurement computes and corrects any origin offset between the reference and the acquired waveforms. When you set this attribute to False, origin offset correction is not performed.

The default value is RFMXSPECAN_VAL_AMPM_IQ_ORIGIN_OFFSET_CORRECTION_ENABLED_TRUE.

Get Function: RFmxSpecAn_AMPMGetIQOriginOffsetCorrectionEnabled
Set Function: RFmxSpecAn_AMPMSetIQOriginOffsetCorrectionEnabled
Values:
RFMXSPECAN_VAL_AMPM_IQ_ORIGIN_OFFSET_CORRECTION_ENABLED_FALSE (0) Disables IQ origin offset correction.
RFMXSPECAN_VAL_AMPM_IQ_ORIGIN_OFFSET_CORRECTION_ENABLED_TRUE (1) Enables IQ origin offset correction.

RFMXSPECAN_ATTR_AMPM_AM_TO_AM_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable the results that rely on the AM to AM characteristics.

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

Get Function: RFmxSpecAn_AMPMGetAMToAMEnabled
Set Function: RFmxSpecAn_AMPMSetAMToAMEnabled
Values:
RFMXSPECAN_VAL_AMPM_AM_TO_AM_ENABLED_FALSE (0) Disables the computation of following scalar results and traces. Empty array is returned if the disabled result is an array. NaN is returned otherwise. The following scalar results are disabled: RFMXSPECAN_ATTR_AMPM_RESULTS_MEAN_LINEAR_GAIN RFMXSPECAN_ATTR_AMPM_RESULTS_1_DB_COMPRESSION_POINT RFMXSPECAN_ATTR_AMPM_RESULTS_INPUT_COMPRESSION_POINT RFMXSPECAN_ATTR_AMPM_RESULTS_OUTPUT_COMPRESSION_POINT RFMXSPECAN_ATTR_AMPM_RESULTS_GAIN_ERROR_RANGE RFMXSPECAN_ATTR_AMPM_RESULTS_AM_TO_AM_CURVE_FIT_RESIDUAL RFMXSPECAN_ATTR_AMPM_RESULTS_AM_TO_AM_CURVE_FIT_COEFFICIENTS The following traces are disabled: Measured AM to AM Curve Fit AM to AM Relative Power Trace
RFMXSPECAN_VAL_AMPM_AM_TO_AM_ENABLED_TRUE (1) Enables the computation of AM to AM results and traces.

RFMXSPECAN_ATTR_AMPM_AM_TO_PM_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable the results that rely on AM to PM characteristics.

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

Get Function: RFmxSpecAn_AMPMGetAMToPMEnabled
Set Function: RFmxSpecAn_AMPMSetAMToPMEnabled
Values:
RFMXSPECAN_VAL_AMPM_AM_TO_PM_ENABLED_FALSE (0) Disables the computation of following scalar results and traces. Empty array is returned if the disabled result is an array. NaN is returned otherwise. The following scalar results are disabled: RFMXSPECAN_ATTR_AMPM_RESULTS_MEAN_PHASE_ERROR RFMXSPECAN_ATTR_AMPM_RESULTS_PHASE_ERROR_RANGE RFMXSPECAN_ATTR_AMPM_RESULTS_AM_TO_PM_CURVE_FIT_RESIDUAL AMPM Results AM to PM Curve Fit Coefficients The following traces are disabled: Measured AM to PM Curve Fit AM to PM Relative Phase Trace
RFMXSPECAN_VAL_AMPM_AM_TO_PM_ENABLED_TRUE (1) Enables the computation of AM to PM results and traces.

RFMXSPECAN_ATTR_AMPM_EVM_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable the RFMXSPECAN_ATTR_AMPM_RESULTS_MEAN_RMS_EVM attribute.

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

Get Function: RFmxSpecAn_AMPMGetEVMEnabled
Set Function: RFmxSpecAn_AMPMSetEVMEnabled
Values:
RFMXSPECAN_VAL_AMPM_EVM_ENABLED_FALSE (0) Disables EVM computation. NaN is returned as Mean RMS EVM.
RFMXSPECAN_VAL_AMPM_EVM_ENABLED_TRUE (1) Enables EVM computation.

AMPM Equalizer

RFMXSPECAN_ATTR_AMPM_EQUALIZER_MODE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether the measurement equalizes the channel.

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

Get Function: RFmxSpecAn_AMPMGetEqualizerMode
Set Function: RFmxSpecAn_AMPMSetEqualizerMode
Values:
RFMXSPECAN_VAL_AMPM_EQUALIZER_MODE_OFF (0) Equalization is not performed.
RFMXSPECAN_VAL_AMPM_EQUALIZER_MODE_TRAIN (1) The equalizer is turned on to compensate for the effect of the channel.

RFMXSPECAN_ATTR_AMPM_EQUALIZER_FILTER_LENGTH

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the length of the equalizer filter. The measurement maintains the filter length as an odd number by incrementing any even numbered value by one.

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

Get Function: RFmxSpecAn_AMPMGetEqualizerFilterLength
Set Function: RFmxSpecAn_AMPMSetEqualizerFilterLength

AMPM Averaging

RFMXSPECAN_ATTR_AMPM_AVERAGING_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies whether to enable averaging for the AMPM 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_AMPM_AVERAGING_ENABLED_FALSE.

Get Function: RFmxSpecAn_AMPMGetAveragingEnabled
Set Function: RFmxSpecAn_AMPMSetAveragingEnabled
Values:
RFMXSPECAN_VAL_AMPM_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_AMPM_AVERAGING_ENABLED_TRUE (1) The AMPM measurement uses the RFMXSPECAN_ATTR_AMPM_AVERAGING_COUNT attribute as the number of acquisitions over which the signal for the AMPM measurement is averaged.

RFMXSPECAN_ATTR_AMPM_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_AMPM_AVERAGING_ENABLED attribute to RFMXSPECAN_VAL_AMPM_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_AMPMGetAveragingCount
Set Function: RFmxSpecAn_AMPMSetAveragingCount

Compression Point

RFMXSPECAN_ATTR_AMPM_COMPRESSION_POINT_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Enables computation of compression points corresponding to the respective compression levels specified by the RFMXSPECAN_ATTR_AMPM_COMPRESSION_POINT_LEVEL attribute.

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

Get Function: RFmxSpecAn_AMPMGetCompressionPointEnabled
Set Function: RFmxSpecAn_AMPMSetCompressionPointEnabled
Values:
RFMXSPECAN_VAL_AMPM_COMPRESSION_POINT_ENABLED_FALSE (0) Disables computation of compression points.
RFMXSPECAN_VAL_AMPM_COMPRESSION_POINT_ENABLED_TRUE (1) Enables computation of compression points.

RFMXSPECAN_ATTR_AMPM_COMPRESSION_POINT_LEVEL

Data Type: float64 []
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64Array
RFmxSpecAn_GetAttributeF64Array
Description: Specifies the compression levels for which the compression points are computed when you set the RFMXSPECAN_ATTR_AMPM_COMPRESSION_POINT_ENABLED attribute to RFMXSPECAN_VAL_AMPM_COMPRESSION_POINT_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.

Get Function: RFmxSpecAn_AMPMGetCompressionPointLevel
Set Function: RFmxSpecAn_AMPMSetCompressionPointLevel

RFMXSPECAN_ATTR_AMPM_MAXIMUM_TIMING_ERROR

Data Type: float64
Access: read/write
Functions: RFmxSpecAn_SetAttributeF64
RFmxSpecAn_GetAttributeF64
Description: Specifies the maximum time alignment error expected between the acquired and the reference waveforms. 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.00002.

Get Function: RFmxSpecAn_AMPMGetMaximumTimingError
Set Function: RFmxSpecAn_AMPMSetMaximumTimingError

RFMXSPECAN_ATTR_AMPM_REFERENCE_POWER_TYPE

Data Type: int32
Access: read/write
Functions: RFmxSpecAn_SetAttributeI32
RFmxSpecAn_GetAttributeI32
Description: Specifies the reference power used for AM to AM and AM to PM traces.

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

Get Function: RFmxSpecAn_AMPMGetReferencePowerType
Set Function: RFmxSpecAn_AMPMSetReferencePowerType
Values:
RFMXSPECAN_VAL_AMPM_REFERENCE_POWER_TYPE_INPUT (0) The instantaneous powers at the input port of device under test (DUT) forms the x-axis of AM to AM and AM to PM traces.
RFMXSPECAN_VAL_AMPM_REFERENCE_POWER_TYPE_OUTPUT (1) The instantaneous powers at the output port of DUT forms the x-axis of AM to AM and AM to PM traces.

RFMXSPECAN_ATTR_AMPM_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 AMPM 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_AMPMGetAllTracesEnabled
Set Function: RFmxSpecAn_AMPMSetAllTracesEnabled

RFMXSPECAN_ATTR_AMPM_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 the AMPM measurement.

The number of threads can range from 1 to the number of physical cores. However, 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_AMPMGetNumberOfAnalysisThreads
Set Function: RFmxSpecAn_AMPMSetNumberOfAnalysisThreads

AMPM Results

RFMXSPECAN_ATTR_AMPM_RESULTS_MEAN_LINEAR_GAIN

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the average linear gain of the device under test, computed by rejecting signal samples containing gain compression. This value is expressed in dB.



Get Function: RFmxSpecAn_AMPMGetResultsMeanLinearGain

RFMXSPECAN_ATTR_AMPM_RESULTS_1_DB_COMPRESSION_POINT

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the theoretical output power at which the device under test gain drops by 1 dB from its mean linear gain. This value is expressed in dBm. This attribute returns NaN when the AM-to-AM characteristics of the device under test are flat.

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_AMPMGetResults1dBCompressionPoint

RFMXSPECAN_ATTR_AMPM_RESULTS_INPUT_COMPRESSION_POINT

Data Type: float64 []
Access: read only
Functions: RFmxSpecAn_GetAttributeF64Array
Description: Returns the theoretical input power at which the device gain drops by the compression level, specified through RFMXSPECAN_ATTR_AMPM_COMPRESSION_POINT_LEVEL attribute, from its mean linear gain. This value is expressed in dBm.

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_AMPMGetResultsInputCompressionPoint

RFMXSPECAN_ATTR_AMPM_RESULTS_OUTPUT_COMPRESSION_POINT

Data Type: float64 []
Access: read only
Functions: RFmxSpecAn_GetAttributeF64Array
Description: Returns the theoretical output power at which the device gain drops by the compression level, specified through RFMXSPECAN_ATTR_AMPM_COMPRESSION_POINT_LEVEL attribute, from its mean linear gain. This value is expressed in dBm.

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_AMPMGetResultsOutputCompressionPoint

RFMXSPECAN_ATTR_AMPM_RESULTS_MEAN_RMS_EVM

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the ratio, as a percentage, of l2 norm of difference between the normalized reference and acquired waveforms, to the l2 norm of the normalized reference waveform.

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_AMPMGetResultsMeanRMSEVM

RFMXSPECAN_ATTR_AMPM_RESULTS_GAIN_ERROR_RANGE

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the peak-to-peak deviation of the device under test gain. This value is expressed in dB.

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_AMPMGetResultsGainErrorRange

RFMXSPECAN_ATTR_AMPM_RESULTS_PHASE_ERROR_RANGE

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the peak-to-peak deviation of the phase distortion of the acquired signal relative to the reference waveform caused by the device under test. This value is expressed in degrees.

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_AMPMGetResultsPhaseErrorRange

RFMXSPECAN_ATTR_AMPM_RESULTS_MEAN_PHASE_ERROR

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the mean phase error of the acquired signal relative to the reference waveform caused by the device under test. This value is expressed in degrees.

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_AMPMGetResultsMeanPhaseError

RFMXSPECAN_ATTR_AMPM_RESULTS_AM_TO_AM_CURVE_FIT_RESIDUAL

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the approximation error of the polynomial approximation of the measured device under test AM-to-AM characteristic. This value is expressed in dB.

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_AMPMGetResultsAMToAMCurveFitResidual

RFMXSPECAN_ATTR_AMPM_RESULTS_AM_TO_PM_CURVE_FIT_RESIDUAL

Data Type: float64
Access: read only
Functions: RFmxSpecAn_GetAttributeF64
Description: Returns the approximation error of the polynomial approximation of the measured AM-to-PM characteristic of the device under test. This value is expressed in degrees.

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_AMPMGetResultsAMToPMCurveFitResidual

Table of Contents

Home

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-FPGA
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