Enums

enums.py - Contains enum classes.

class nirfmxspecan.enums.AcpAmplitudeCorrectionType(value)

Bases: Enum

AcpAmplitudeCorrectionType.

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.

SPECTRUM_FREQUENCY_BIN = 1

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

class nirfmxspecan.enums.AcpAveragingEnabled(value)

Bases: Enum

AcpAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The ACP measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the ACP measurement is averaged.

class nirfmxspecan.enums.AcpAveragingType(value)

Bases: Enum

AcpAveragingType.

LOG = 1

The power spectrum is averaged in a logarithmic scale.

MAXIMUM = 3

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

MINIMUM = 4

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

RMS = 0

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

SCALAR = 2

The square root of the power spectrum is averaged.

class nirfmxspecan.enums.AcpCarrierMode(value)

Bases: Enum

AcpCarrierMode.

ACTIVE = 1

The carrier power is considered as part of the total carrier power.

PASSIVE = 0

The carrier power is not considered as part of the total carrier power.

class nirfmxspecan.enums.AcpCarrierRrcFilterEnabled(value)

Bases: Enum

AcpCarrierRrcFilterEnabled.

FALSE = 0

The channel power of the acquired carrier channel is measured directly.

TRUE = 1

The measurement applies the RRC filter on the acquired carrier channel before measuring the carrier channel power.

class nirfmxspecan.enums.AcpDetectorType(value)

Bases: Enum

AcpDetectorType.

AVERAGE_LOG = 7

The average log of all the samples in the bucket is detected.

AVERAGE_RMS = 5

The average RMS of all the samples in the bucket is detected.

AVERAGE_VOLTAGE = 6

The average voltage of all the samples in the bucket is detected.

NEGATIVE_PEAK = 4

The minimum value of the samples in the bucket is detected.

NONE = 0

The detector is disabled.

NORMAL = 2

The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.

PEAK = 3

The maximum value of the samples in the bucket is detected.

SAMPLE = 1

The middle sample in the bucket is detected.

class nirfmxspecan.enums.AcpFftOverlapMode(value)

Bases: Enum

AcpFftOverlapMode.

AUTOMATIC = 1

Measurement sets the overlap based on the value you have set for the FFT_WINDOW attribute. When you set the ACP FFT Window attribute to any value other than None, the number of overlapped samples between consecutive chunks is set to 50% of the value of the SEQUENTIAL_FFT_SIZE attribute. When you set the ACP FFT Window attribute to None, the chunks are not overlapped and the overlap is set to 0%.

DISABLED = 0

Disables the overlap between the chunks.

USER_DEFINED = 2

Measurement uses the overlap that you specify in the FFT_OVERLAP attribute.

class nirfmxspecan.enums.AcpFftWindow(value)

Bases: Enum

AcpFftWindow.

BLACKMAN = 5

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

BLACKMAN_HARRIS = 6

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

FLAT_TOP = 1

Measures single-tone amplitudes accurately.

GAUSSIAN = 4

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.

HAMMING = 3

Analyzes closely-spaced sine waves.

HANNING = 2

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

KAISER_BESSEL = 7

Separates two tones with frequencies close to each other but with widely-differing amplitudes.

NONE = 0

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

class nirfmxspecan.enums.AcpIFOutputPowerOffsetAuto(value)

Bases: Enum

AcpIFOutputPowerOffsetAuto.

FALSE = 0

The measurement sets the IF output power level offset using the values of the NEAR_IF_OUTPUT_POWER_OFFSET and FAR_IF_OUTPUT_POWER_OFFSET attributes.

TRUE = 1

The measurement automatically computes an IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement.

class nirfmxspecan.enums.AcpMeasurementMethod(value)

Bases: Enum

AcpMeasurementMethod.

DYNAMIC_RANGE = 1

The ACP measurement acquires the spectrum using the hardware-specific optimizations for different frequency bands. Use this method to get the best dynamic range.

Supported devices: PXIe-5665/5668

NORMAL = 0

The ACP measurement acquires the spectrum using the same signal analyzer setting across frequency bands. Use this method when measurement speed is desirable over higher dynamic range.

SEQUENTIAL_FFT = 2

The ACP measurement acquires I/Q samples for a duration specified by the SWEEP_TIME_INTERVAL attribute. These samples are divided into smaller chunks. The size of each chunk is defined by the SEQUENTIAL_FFT_SIZE attribute. The overlap between the chunks is defined by the FFT_OVERLAP_MODE attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged to get the spectrum and is used to compute ACP.

Sequential FFT method should be used for the following scenarios.

1. While performing fast ACP measurements by utilizing smaller FFT sizes. However, accuracy of the results may be reduced.

2. When measuring signals with time-varying spectral characteristics, sequential FFT with overlap mode set to Automatic should be used.

3. For accurate power measurements when the power characteristics of the signal vary over time, averaging is allowed.

The following attributes have limited support when you set the ACP Measurement Method attribute to Sequential FFT.

Property	Supported Value
RBW_FILTER_AUTO_BANDWIDTH	True
RBW_FILTER_TYPE	FFT Based
SWEEP_TIME_AUTO	False
AVERAGING_COUNT	>=1
NUMBER_OF_ANALYSIS_THREADS	1
AMPLITUDE_CORRECTION_TYPE	RF Center Frequency
OFFSET_RELATIVE_ATTENUATION	0

Note

For multi-span FFT, the averaging count should be 1.

class nirfmxspecan.enums.AcpMeasurementMode(value)

Bases: Enum

AcpMeasurementMode.

CALIBRATE_NOISE_FLOOR = 1

Manual noise calibration of the signal analyzer is performed for the ACP measurement.

MEASURE = 0

ACP measurement is performed on the acquired signal.

class nirfmxspecan.enums.AcpNoiseCalibrationAveragingAuto(value)

Bases: Enum

AcpNoiseCalibrationAveragingAuto.

FALSE = 0

RFmx uses the averages that you set for the NOISE_CALIBRATION_AVERAGING_COUNT attribute.

TRUE = 1

When you set the MEASUREMENT_METHOD attribute to Normal or Sequential FFT, RFmx uses a noise calibration averaging count of 32. When you set the ACP Meas Method attribute to Dynamic Range and the sweep time is less than 5 ms, RFmx uses a noise calibration averaging count of 15. When you set the ACP Meas Method attribute to Dynamic Range and the sweep time is greater than or equal to 5 ms, RFmx uses a noise calibration averaging count of 5.

class nirfmxspecan.enums.AcpNoiseCalibrationDataValid(value)

Bases: Enum

AcpNoiseCalibrationDataValid.

FALSE = 0

Returns false if the calibration data is not present for the specified configuration or if the difference between the current device temperature and the calibration temperature exceeds the [-5 °C, 5 °C] range.

TRUE = 1

Returns true if the calibration data is present for the configuration specified by the signal name in the Selector string parameter.

class nirfmxspecan.enums.AcpNoiseCalibrationMode(value)

Bases: Enum

AcpNoiseCalibrationMode.

AUTO = 1

When you set the NOISE_COMPENSATION_ENABLED to True, RFmx sets the INPUT_ISOLATION_ENABLED attribute to Enabled and calibrates the instrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the ACP measurement, including compensation for noise of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the NOISE_COMPENSATION_ENABLED attribute to False, RFmx does not calibrate instrument noise and only performs the ACP measurement without compensating for noise of the instrument.

MANUAL = 0

When you set the MEASUREMENT_MODE attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the ACP measurement manually. When you set the ACP Meas Mode attribute to Measure, you can initiate the ACP measurement manually.

class nirfmxspecan.enums.AcpNoiseCompensationEnabled(value)

Bases: Enum

AcpNoiseCompensationEnabled.

FALSE = 0

Disables noise compensation.

TRUE = 1

Enables noise compensation.

class nirfmxspecan.enums.AcpNoiseCompensationType(value)

Bases: Enum

AcpNoiseCompensationType.

ANALYZER_AND_TERMINATION = 0

Compensates for noise from the analyzer and the 50-ohm termination. The measured power values are in excess of the thermal noise floor.

ANALYZER_ONLY = 1

Compensates for the analyzer noise only.

class nirfmxspecan.enums.AcpOffsetEnabled(value)

Bases: Enum

AcpOffsetEnabled.

FALSE = 0

Disables the offset channel for ACP measurement.

TRUE = 1

Enables the offset channel for ACP measurement.

class nirfmxspecan.enums.AcpOffsetFrequencyDefinition(value)

Bases: Enum

AcpOffsetFrequencyDefinition.

CENTER = 0

The offset frequency is defined from the center of the closest carrier to the center of the offset channel.

EDGE = 1

The offset frequency is defined from the center of the closest carrier to the nearest edge of the offset channel.

class nirfmxspecan.enums.AcpOffsetPowerReferenceCarrier(value)

Bases: Enum

AcpOffsetPowerReferenceCarrier.

CLOSEST = 0

The measurement uses the power measured in the carrier closest to the offset channel center frequency, as the power reference.

COMPOSITE = 2

The measurement uses the sum of powers measured in all the active carriers as the power reference.

HIGHEST = 1

The measurement uses the highest power measured among all the active carriers as the power reference.

SPECIFIC = 3

The measurement uses the power measured in the carrier that has an index specified by the OFFSET_POWER_REFERENCE_SPECIFIC attribute, as the power reference.

class nirfmxspecan.enums.AcpOffsetRrcFilterEnabled(value)

Bases: Enum

AcpOffsetRrcFilterEnabled.

FALSE = 0

The channel power of the acquired offset channel is measured directly.

TRUE = 1

The measurement applies the RRC filter on the acquired offset channel before measuring the offset channel power.

class nirfmxspecan.enums.AcpOffsetSideband(value)

Bases: Enum

AcpOffsetSideband.

BOTH = 2

Configures both negative and positive offset segments.

NEGATIVE = 0

Configures a lower offset segment to the left of the leftmost carrier.

POSITIVE = 1

Configures an upper offset segment to the right of the rightmost carrier.

class nirfmxspecan.enums.AcpPowerUnits(value)

Bases: Enum

AcpPowerUnits.

DBM = 0

The absolute powers are reported in dBm.

DBM_PER_HZ = 1

The absolute powers are reported in dBm/Hz.

class nirfmxspecan.enums.AcpRbwAutoBandwidth(value)

Bases: Enum

AcpRbwAutoBandwidth.

FALSE = 0

The measurement uses the RBW that you specify in the RBW_FILTER_BANDWIDTH attribute.

TRUE = 1

The measurement computes the RBW.

class nirfmxspecan.enums.AcpRbwFilterBandwidthDefinition(value)

Bases: Enum

AcpRbwFilterBandwidthDefinition.

BANDWIDTH_DEFINITION_3DB = 0

Defines the RBW in terms of the 3dB bandwidth of the RBW filter. When you set the RBW_FILTER_TYPE attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the FFT_WINDOW attribute.

BIN_WIDTH = 2

Defines the RBW in terms of the bin width of the spectrum computed using FFT when you set the ACP RBW Filter Type attribute to FFT Based.

class nirfmxspecan.enums.AcpRbwFilterType(value)

Bases: Enum

AcpRbwFilterType.

FFT_BASED = 0

No RBW filtering is performed.

FLAT = 2

An RBW filter with a flat response is applied.

GAUSSIAN = 1

An RBW filter with a Gaussian response is applied.

class nirfmxspecan.enums.AcpSweepTimeAuto(value)

Bases: Enum

AcpSweepTimeAuto.

FALSE = 0

The measurement uses the sweep time that you specify in the SWEEP_TIME_INTERVAL attribute.

TRUE = 1

The measurement calculates the sweep time based on the value of the RBW_FILTER_BANDWIDTH attribute.

class nirfmxspecan.enums.AmpmAMToAMCurveFitType(value)

Bases: Enum

AmpmAMToAMCurveFitType.

BISQUARE = 2

The measurement excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

LEAST_ABSOLUTE_RESIDUAL = 1

The measurement minimizes the magnitude of the polynomial approximation error.

LEAST_SQUARE = 0

The measurement minimizes the energy of the polynomial approximation error.

class nirfmxspecan.enums.AmpmAMToAMEnabled(value)

Bases: Enum

AmpmAMToAMEnabled.

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:

MEAN_LINEAR_GAIN

1_DB_COMPRESSION_POINT

INPUT_COMPRESSION_POINT

OUTPUT_COMPRESSION_POINT

GAIN_ERROR_RANGE

AM_TO_AM_CURVE_FIT_RESIDUAL

AM_TO_AM_CURVE_FIT_COEFFICIENTS

The following traces are disabled:

Measured AM to AM

Curve Fit AM to AM

Relative Power Trace

TRUE = 1

Enables the computation of AM to AM results and traces.

class nirfmxspecan.enums.AmpmAMToPMCurveFitType(value)

Bases: Enum

AmpmAMToPMCurveFitType.

BISQUARE = 2

The measurement excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

LEAST_ABSOLUTE_RESIDUAL = 1

The measurement minimizes the magnitude of the polynomial approximation error.

LEAST_SQUARE = 0

The measurement minimizes the energy of the polynomial approximation error.

class nirfmxspecan.enums.AmpmAMToPMEnabled(value)

Bases: Enum

AmpmAMToPMEnabled.

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:

MEAN_PHASE_ERROR

PHASE_ERROR_RANGE

AM_TO_PM_CURVE_FIT_RESIDUAL

AM_TO_PM_CURVE_FIT_COEFFICIENTS

The following traces are disabled:

Measured AM to PM

Curve Fit AM to PM

Relative Phase Trace

TRUE = 1

Enables the computation of AM to PM results and traces.

class nirfmxspecan.enums.AmpmAutoCarrierDetectionEnabled(value)

Bases: Enum

AmpmAutoCarrierDetectionEnabled.

FALSE = 0

Disables auto detection of carrier offset and carrier bandwidth.

TRUE = 1

Enables auto detection of carrier offset and carrier bandwidth.

class nirfmxspecan.enums.AmpmAveragingEnabled(value)

Bases: Enum

AmpmAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The AMPM measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the signal for the AMPM measurement is averaged.

class nirfmxspecan.enums.AmpmCompressionPointEnabled(value)

Bases: Enum

AmpmCompressionPointEnabled.

FALSE = 0

Disables computation of compression points.

TRUE = 1

Enables computation of compression points.

class nirfmxspecan.enums.AmpmCompressionPointGainReference(value)

Bases: Enum

AmpmCompressionPointGainReference.

AUTO = 0

Measurement computes the gain reference to be used for compression point calculation. The computed gain reference is also returned as MEAN_LINEAR_GAIN result.

MAX_GAIN = 2

Measurement uses the maximum gain as gain reference for compression point calculation.

REFERENCE_POWER = 1

Measurement uses the gain corresponding to the reference power that you specify for the COMPRESSION_POINT_GAIN_REFERENCE_POWER attribute as gain reference. The reference power can be configured as either input or output power based on the value of the REFERENCE_POWER_TYPE attribute.

USER_DEFINED = 3

Measurement uses the gain that you specify for the COMPRESSION_POINT_USER_GAIN attribute as gain reference for compression point calculation.

class nirfmxspecan.enums.AmpmEqualizerMode(value)

Bases: Enum

AmpmEqualizerMode.

OFF = 0

Equalization is not performed.

TRAIN = 1

The equalizer is turned on to compensate for the effect of the channel.

class nirfmxspecan.enums.AmpmEvmEnabled(value)

Bases: Enum

AmpmEvmEnabled.

FALSE = 0

Disables EVM computation. NaN is returned as Mean RMS EVM.

TRUE = 1

Enables EVM computation.

class nirfmxspecan.enums.AmpmFrequencyOffsetCorrectionEnabled(value)

Bases: Enum

AmpmFrequencyOffsetCorrectionEnabled.

FALSE = 0

The measurement does not perform frequency offset correction.

TRUE = 1

The measurement computes and corrects any frequency offset between the reference and the acquired waveforms.

class nirfmxspecan.enums.AmpmIQOriginOffsetCorrectionEnabled(value)

Bases: Enum

AmpmIQOriginOffsetCorrectionEnabled.

FALSE = 0

Disables IQ origin offset correction.

TRUE = 1

Enables IQ origin offset correction.

class nirfmxspecan.enums.AmpmMeasurementSampleRateMode(value)

Bases: Enum

AmpmMeasurementSampleRateMode.

REFERENCE_WAVEFORM = 1

The acquisition sample rate is set to match the sample rate of the reference waveform.

USER = 0

The acquisition sample rate is defined by the value of the MEASUREMENT_SAMPLE_RATE attribute.

class nirfmxspecan.enums.AmpmReferencePowerType(value)

Bases: Enum

AmpmReferencePowerType.

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.

OUTPUT = 1

The instantaneous powers at the output port of DUT forms the x-axis of AM to AM and AM to PM traces.

class nirfmxspecan.enums.AmpmReferenceWaveformIdleDurationPresent(value)

Bases: Enum

AmpmReferenceWaveformIdleDurationPresent.

FALSE = 0

The reference waveform does not contain an idle duration.

TRUE = 1

The reference waveform contains an idle duration.

class nirfmxspecan.enums.AmpmSignalType(value)

Bases: Enum

AmpmSignalType.

MODULATED = 0

The reference waveform is a cellular or connectivity standard signal.

TONES = 1

The reference waveform is a continuous signal comprising of one or more tones.

class nirfmxspecan.enums.AmpmSynchronizationMethod(value)

Bases: Enum

AmpmSynchronizationMethod.

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.

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.

class nirfmxspecan.enums.AmpmThresholdDefinition(value)

Bases: Enum

AmpmThresholdDefinition.

INPUT_AND_OUTPUT = 0

Corresponding acquired and reference waveform samples are used for AMPM measurement when both samples are greater or equal to the threshold level.

REFERENCE_POWER_TYPE = 1

Corresponding acquired and reference waveform samples are used for AMPM measurement when reference waveform sample is greater than or equal to the threshold level and REFERENCE_POWER_TYPE attribute is set to Input. Corresponding acquired and reference waveform samples are used for AMPM measurement when acquired waveform sample is greater than or equal to the threshold level and REFERENCE_POWER_TYPE attribute is set to Output.

class nirfmxspecan.enums.AmpmThresholdEnabled(value)

Bases: Enum

AmpmThresholdEnabled.

FALSE = 0

All samples are considered for the AMPM measurement.

TRUE = 1

Samples above the threshold level specified in the THRESHOLD_LEVEL attribute are considered for the AMPM measurement.

class nirfmxspecan.enums.AmpmThresholdType(value)

Bases: Enum

AmpmThresholdType.

ABSOLUTE = 1

The threshold is the absolute power, in dBm.

RELATIVE = 0

The threshold is relative to the peak power of the acquired samples.

class nirfmxspecan.enums.CcdfRbwFilterType(value)

Bases: Enum

CcdfRbwFilterType.

FLAT = 2

The RBW filter has a flat response.

GAUSSIAN = 1

The RBW filter has a Gaussian response.

NONE = 5

The measurement does not use any RBW filtering.

RRC = 6

The RRC filter with the roll-off specified by the RBW_FILTER_RRC_ALPHA attribute is used as the RBW filter.

class nirfmxspecan.enums.CcdfThresholdEnabled(value)

Bases: Enum

CcdfThresholdEnabled.

FALSE = 0

All samples are considered for the CCDF measurement.

TRUE = 1

The samples above the threshold level specified in the THRESHOLD_LEVEL attribute are considered for the CCDF measurement.

class nirfmxspecan.enums.CcdfThresholdType(value)

Bases: Enum

CcdfThresholdType.

ABSOLUTE = 1

The threshold is the absolute power, in dBm.

RELATIVE = 0

The threshold is relative to the peak power of the acquired samples.

class nirfmxspecan.enums.ChpAmplitudeCorrectionType(value)

Bases: Enum

ChpAmplitudeCorrectionType.

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.

SPECTRUM_FREQUENCY_BIN = 1

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

class nirfmxspecan.enums.ChpAveragingEnabled(value)

Bases: Enum

ChpAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The CHP measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the CHP measurement is averaged.

class nirfmxspecan.enums.ChpAveragingType(value)

Bases: Enum

ChpAveragingType.

LOG = 1

The power spectrum is averaged in a logarithmic scale.

MAXIMUM = 3

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

MINIMUM = 4

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

RMS = 0

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

SCALAR = 2

The square root of the power spectrum is averaged.

class nirfmxspecan.enums.ChpCarrierRrcFilterEnabled(value)

Bases: Enum

ChpCarrierRrcFilterEnabled.

FALSE = 0

The channel power of the acquired channel is measured directly.

TRUE = 1

The measurement applies the RRC filter on the acquired channel before measuring the channel power.

class nirfmxspecan.enums.ChpDetectorType(value)

Bases: Enum

ChpDetectorType.

AVERAGE_LOG = 7

The average log of all the samples in the bucket is detected.

AVERAGE_RMS = 5

The average RMS of all the samples in the bucket is detected.

AVERAGE_VOLTAGE = 6

The average voltage of all the samples in the bucket is detected.

NEGATIVE_PEAK = 4

The minimum value of the samples in the bucket is detected.

NONE = 0

The detector is disabled.

NORMAL = 2

The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.

PEAK = 3

The maximum value of the samples in the bucket is detected.

SAMPLE = 1

The middle sample in the bucket is detected.

class nirfmxspecan.enums.ChpFftWindow(value)

Bases: Enum

ChpFftWindow.

BLACKMAN = 5

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

BLACKMAN_HARRIS = 6

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

FLAT_TOP = 1

Measures single-tone amplitudes accurately.

GAUSSIAN = 4

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.

HAMMING = 3

Analyzes closely-spaced sine waves.

HANNING = 2

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

KAISER_BESSEL = 7

Separates two tones with frequencies close to each other but with widely-differing amplitudes.

NONE = 0

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

class nirfmxspecan.enums.ChpMeasurementMode(value)

Bases: Enum

ChpMeasurementMode.

CALIBRATE_NOISE_FLOOR = 1

Manual noise calibration of the signal analyzer is performed for the CHP measurement.

MEASURE = 0

CHP measurement is performed on the acquired signal.

class nirfmxspecan.enums.ChpNoiseCalibrationAveragingAuto(value)

Bases: Enum

ChpNoiseCalibrationAveragingAuto.

FALSE = 0

RFmx uses the averages that you set for the NOISE_CALIBRATION_AVERAGING_COUNT attribute.

TRUE = 1

RFmx uses a noise calibration averaging count of 32.

class nirfmxspecan.enums.ChpNoiseCalibrationDataValid(value)

Bases: Enum

ChpNoiseCalibrationDataValid.

FALSE = 0

Returns false if the calibration data is not present for the specified configuration or if the difference between the current device temperature and the calibration temperature exceeds the [-5 °C, 5 °C] range.

TRUE = 1

Returns true if the calibration data is present for the configuration specified by the signal name in the Selector string parameter.

class nirfmxspecan.enums.ChpNoiseCalibrationMode(value)

Bases: Enum

ChpNoiseCalibrationMode.

AUTO = 1

When you set the NOISE_COMPENSATION_ENABLED attribute to True, RFmx sets INPUT_ISOLATION_ENABLED to Enabled and calibrates the intrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the CHP measurement, including compensation for noise of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the CHP Noise Comp Enabled attribute to False, RFmx does not calibrate instrument noise and performs only the CHP measurement without compensating for the noise contribution of the instrument.

MANUAL = 0

When you set the MEASUREMENT_MODE attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the CHP measurement manually. When you set the CHP Meas Mode attribute to Measure, you can initiate the CHP measurement manually.

class nirfmxspecan.enums.ChpNoiseCompensationEnabled(value)

Bases: Enum

ChpNoiseCompensationEnabled.

FALSE = 0

Disables noise compensation.

TRUE = 1

Enables noise compensation.

class nirfmxspecan.enums.ChpNoiseCompensationType(value)

Bases: Enum

ChpNoiseCompensationType.

ANALYZER_AND_TERMINATION = 0

Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.

ANALYZER_ONLY = 1

Compensates for the analyzer noise only.

class nirfmxspecan.enums.ChpRbwAutoBandwidth(value)

Bases: Enum

ChpRbwAutoBandwidth.

FALSE = 0

The measurement uses the RBW that you specify in the RBW_FILTER_BANDWIDTH attribute.

TRUE = 1

The measurement computes the RBW.

class nirfmxspecan.enums.ChpRbwFilterBandwidthDefinition(value)

Bases: Enum

ChpRbwFilterBandwidthDefinition.

BANDWIDTH_DEFINITION_3DB = 0

Defines the RBW in terms of the 3 dB bandwidth of the RBW filter. When you set the RBW_FILTER_TYPE attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the FFT_WINDOW attribute.

BIN_WIDTH = 2

Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the CHP RBW Filter Type attribute to FFT Based.

class nirfmxspecan.enums.ChpRbwFilterType(value)

Bases: Enum

ChpRbwFilterType.

FFT_BASED = 0

No RBW filtering is performed.

FLAT = 2

An RBW filter with a flat response is applied.

GAUSSIAN = 1

An RBW filter with a Gaussian response is applied.

class nirfmxspecan.enums.ChpSweepTimeAuto(value)

Bases: Enum

ChpSweepTimeAuto.

FALSE = 0

The measurement uses the sweep time that you specify in the SWEEP_TIME_INTERVAL attribute.

TRUE = 1

The measurement calculates the sweep time based on the value of the RBW_FILTER_BANDWIDTH attribute.

class nirfmxspecan.enums.DigitalEdgeTriggerEdge(value)

Bases: Enum

DigitalEdgeTriggerEdge.

FALLING_EDGE = 1

The trigger asserts on the falling edge of the signal.

RISING_EDGE = 0

The trigger asserts on the rising edge of the signal.

class nirfmxspecan.enums.DpdApplyDpdCfrEnabled(value)

Bases: Enum

DpdApplyDpdCfrEnabled.

FALSE = 0

Disables CFR. The maximum increase in PAPR, after pre-distortion, is limited to 6 dB.

TRUE = 1

Enables CFR.

class nirfmxspecan.enums.DpdApplyDpdCfrMethod(value)

Bases: Enum

DpdApplyDpdCfrMethod.

CLIPPING = 0

Hard clips the signal such that the target PAPR is achieved.

PEAK_WINDOWING = 1

Scales the peaks in the signal using weighted window function to get smooth peaks and achieve the target PAPR.

SIGMOID = 2

Scales the peaks using modified sigmoid transfer function to get smooth peaks and achieve the target PAPR. This method does not support the filter operation.

class nirfmxspecan.enums.DpdApplyDpdCfrTargetPaprType(value)

Bases: Enum

DpdApplyDpdCfrTargetPaprType.

CUSTOM = 1

Sets the target PAPR equal to the value that you set for the CFR_TARGET_PAPR attribute.

INPUT_PAPR = 0

Sets the target PAPR for pre-distorted waveform equal to the PAPR of input waveform.

class nirfmxspecan.enums.DpdApplyDpdCfrWindowType(value)

Bases: Enum

DpdApplyDpdCfrWindowType.

BLACKMAN = 5

Uses the Blackman window function to scale peaks.

BLACKMAN_HARRIS = 6

Uses the Blackman-Harris window function to scale peaks.

FLAT_TOP = 1

Uses the flat top window function to scale peaks.

GAUSSIAN = 4

Uses the Gaussian window function to scale peaks.

HAMMING = 3

Uses the Hamming window function to scale peaks.

HANNING = 2

Uses the Hanning window function to scale peaks.

KAISER_BESSEL = 7

Uses the Kaiser-Bessel window function to scale peaks.

class nirfmxspecan.enums.DpdApplyDpdConfigurationInput(value)

Bases: Enum

DpdApplyDpdConfigurationInput.

MEASUREMENT = 0

Uses the computed DPD polynomial or lookup table for applying DPD on an input waveform using the same RFmx session handle. The configuration parameters for applying DPD such as the DUT_AVERAGE_INPUT_POWER, MODEL, MEASUREMENT_SAMPLE_RATE, DPD polynomial, and lookup table are obtained from the DPD measurement configuration.

USER = 1

Applies DPD by using a computed DPD polynomial or lookup table on an input waveform. You must set the configuration parameters for applying DPD such as the USER_DUT_AVERAGE_INPUT_POWER, USER_DPD_MODEL, USER_MEASUREMENT_SAMPLE_RATE, DPD polynomial, and lookup table. You do not need to call the initiate() method when you set the DPD Apply DPD Config Input attribute User.

class nirfmxspecan.enums.DpdApplyDpdIdleDurationPresent(value)

Bases: Enum

DpdApplyDpdIdleDurationPresent.

FALSE = 0

The reference waveform does not contain an idle duration.

TRUE = 1

The reference waveform contains an idle duration.

class nirfmxspecan.enums.DpdApplyDpdLookupTableCorrectionType(value)

Bases: Enum

DpdApplyDpdLookupTableCorrectionType.

MAGNITUDE_AND_PHASE = 0

The measurement predistorts the magnitude and phase of the input waveform.

MAGNITUDE_ONLY = 1

The measurement predistorts only the magnitude of the input waveform.

PHASE_ONLY = 2

The measurement predistorts only the phase of the input waveform.

class nirfmxspecan.enums.DpdApplyDpdMemoryModelCorrectionType(value)

Bases: Enum

DpdApplyDpdMemoryModelCorrectionType.

MAGNITUDE_AND_PHASE = 0

The measurement predistorts the magnitude and phase of the input waveform.

MAGNITUDE_ONLY = 1

The measurement predistorts only the magnitude of the input waveform.

PHASE_ONLY = 2

The measurement predistorts only the phase of the input waveform.

class nirfmxspecan.enums.DpdApplyDpdUserDpdModel(value)

Bases: Enum

DpdApplyDpdUserDpdModel.

GENERALIZED_MEMORY_POLYNOMIAL = 2

This model computes the generalized memory polynomial predistortion coefficients used to linearize systems with significant memory effects.

LOOKUP_TABLE = 0

This model computes the complex gain coefficients applied to linearize systems with negligible memory effects.

MEMORY_POLYNOMIAL = 1

This model computes the memory polynomial predistortion coefficients used to linearize systems with moderate memory effects.

class nirfmxspecan.enums.DpdApplyDpdUserLookupTableType(value)

Bases: Enum

DpdApplyDpdUserLookupTableType.

LINEAR = 1

Input powers in the LUT are specified in watts.

LOG = 0

Input powers in the LUT are specified in dBm.

class nirfmxspecan.enums.DpdAutoCarrierDetectionEnabled(value)

Bases: Enum

DpdAutoCarrierDetectionEnabled.

FALSE = 0

Disables auto detection of carrier offset and carrier bandwidth.

TRUE = 1

Enables auto detection of carrier offset and carrier bandwidth.

class nirfmxspecan.enums.DpdAveragingEnabled(value)

Bases: Enum

DpdAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The DPD measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the signal for the DPD measurement is averaged.

class nirfmxspecan.enums.DpdDvrDdrEnabled(value)

Bases: Enum

DpdDvrDdrEnabled.

FALSE = 0

The Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation model are disabled.

TRUE = 1

The Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation model are enabled.

class nirfmxspecan.enums.DpdFrequencyOffsetCorrectionEnabled(value)

Bases: Enum

DpdFrequencyOffsetCorrectionEnabled.

FALSE = 0

The measurement computes and corrects any frequency offset between the reference and the acquired waveforms.

TRUE = 1

The measurement does not perform frequency offset correction.

class nirfmxspecan.enums.DpdIQOriginOffsetCorrectionEnabled(value)

Bases: Enum

DpdIQOriginOffsetCorrectionEnabled.

FALSE = 0

Disables IQ origin offset correction.

TRUE = 1

Enables IQ origin offset correction.

class nirfmxspecan.enums.DpdIterativeDpdEnabled(value)

Bases: Enum

DpdIterativeDpdEnabled.

FALSE = 0

RFmx computes the DPD Results DPD Polynomial without considering the value of the DPD Previous DPD Polynomial.

TRUE = 1

RFmx computes the DPD Results DPD Polynomial based on the value of the DPD Previous DPD Polynomial.

class nirfmxspecan.enums.DpdLookupTableAMToAMCurveFitType(value)

Bases: Enum

DpdLookupTableAMToAMCurveFitType.

BISQUARE = 2

Excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

LEAST_ABSOLUTE_RESIDUAL = 1

Minimizes the magnitude of the polynomial approximation error.

LEAST_SQUARE = 0

Minimizes the energy of the polynomial approximation error.

class nirfmxspecan.enums.DpdLookupTableAMToPMCurveFitType(value)

Bases: Enum

DpdLookupTableAMToPMCurveFitType.

BISQUARE = 2

Excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

LEAST_ABSOLUTE_RESIDUAL = 1

Minimizes the magnitude of the polynomial approximation error.

LEAST_SQUARE = 0

Minimizes the energy of the polynomial approximation error.

class nirfmxspecan.enums.DpdLookupTableThresholdDefinition(value)

Bases: Enum

DpdLookupTableThresholdDefinition.

INPUT = 1

Corresponding acquired and reference waveform samples are used for AMPM measurement when reference waveform sample is greater than or equal to the threshold level.

INPUT_AND_OUTPUT = 0

Corresponding acquired and reference waveform samples are used for AMPM measurement when both samples are greater or equal to the threshold level.

class nirfmxspecan.enums.DpdLookupTableThresholdEnabled(value)

Bases: Enum

DpdLookupTableThresholdEnabled.

FALSE = 0

All samples are considered for the DPD measurement.

TRUE = 1

Only samples above the threshold level which you specify in the LOOKUP_TABLE_THRESHOLD_LEVEL attribute are considered for the DPD measurement.

class nirfmxspecan.enums.DpdLookupTableThresholdType(value)

Bases: Enum

DpdLookupTableThresholdType.

ABSOLUTE = 1

The threshold is the absolute power, in dBm.

RELATIVE = 0

The threshold is relative to the peak power of the acquired samples.

class nirfmxspecan.enums.DpdLookupTableType(value)

Bases: Enum

DpdLookupTableType.

LINEAR = 1

Input powers in the LUT are specified in watts.

LOG = 0

Input powers in the LUT are specified in dBm.

class nirfmxspecan.enums.DpdMeasurementMode(value)

Bases: Enum

DpdMeasurementMode.

ACQUIRE_AND_EXTRACT = 0

The measurement acquires the training waveform required for the extraction of the DPD model coefficients from the hardware and then computes the model coefficients.

In this mode, the supported MODEL are Lookup Table, Memory Polynomial **, and **Generalized Memory Polynomial.

EXTRACT_ONLY = 1

The measurement uses the user configured training waveform required for the extraction of the DPD model coefficients.

In this mode, the only supported MODEL is Decomposed Vector Rotation.

class nirfmxspecan.enums.DpdMeasurementSampleRateMode(value)

Bases: Enum

DpdMeasurementSampleRateMode.

REFERENCE_WAVEFORM = 1

The acquisition sample rate is set to match the sample rate of the reference waveform.

USER = 0

The acquisition sample rate is defined by the value of the MEASUREMENT_SAMPLE_RATE attribute.

class nirfmxspecan.enums.DpdMemoryPolynomialLagOrderType(value)

Bases: Enum

DpdMemoryPolynomialLagOrderType.

ALL_ORDERS = 0

The memory polynomial will compute all the terms for the given order.

EVEN_ORDERS_ONLY = 2

The memory polynomial will compute the non-zero coefficents only for the even terms.

ODD_ORDERS_ONLY = 1

The memory polynomial will compute the non-zero coefficients only for the odd terms.

class nirfmxspecan.enums.DpdMemoryPolynomialLeadOrderType(value)

Bases: Enum

DpdMemoryPolynomialLeadOrderType.

ALL_ORDERS = 0

The memory polynomial will compute all the terms for the given order.

EVEN_ORDERS_ONLY = 2

The memory polynomial will compute the non-zero coefficents only for the even terms.

ODD_ORDERS_ONLY = 1

The memory polynomial will compute the non-zero coefficients only for the odd terms.

class nirfmxspecan.enums.DpdMemoryPolynomialOrderType(value)

Bases: Enum

DpdMemoryPolynomialOrderType.

ALL_ORDERS = 0

The memory polynomial will compute all the terms for the given order.

EVEN_ORDERS_ONLY = 2

The memory polynomial will compute the non-zero coefficents only for the first linear term and all even terms.

ODD_ORDERS_ONLY = 1

The memory polynomial will compute the non-zero coefficients only for the odd terms.

class nirfmxspecan.enums.DpdModel(value)

Bases: Enum

DpdModel.

DECOMPOSED_VECTOR_ROTATION = 3

This model computes the Decomposed Vector Rotation model predistortion coefficients used to linearize wideband systems with significant memory effects.

GENERALIZED_MEMORY_POLYNOMIAL = 2

This model computes the generalized memory polynomial predistortion coefficients used to linearize systems with significant memory effects.

LOOKUP_TABLE = 0

This model computes the complex gain coefficients applied when performing digital predistortion to linearize systems with negligible memory effects.

MEMORY_POLYNOMIAL = 1

This model computes the memory polynomial predistortion coefficients used to linearize systems with moderate memory effects.

class nirfmxspecan.enums.DpdNmseEnabled(value)

Bases: Enum

DpdNmseEnabled.

FALSE = 0

Disables NMSE computation. NaN is returned as NMSE.

TRUE = 1

Enables NMSE computation.

class nirfmxspecan.enums.DpdPreDpdCfrEnabled(value)

Bases: Enum

DpdPreDpdCfrEnabled.

FALSE = 0

Disables the CFR. The apply_pre_dpd_signal_conditioning() method returns an error when the CFR is disabled.

TRUE = 1

Enables the CFR.

class nirfmxspecan.enums.DpdPreDpdCfrFilterEnabled(value)

Bases: Enum

DpdPreDpdCfrFilterEnabled.

FALSE = 0

Disables the filter operation when performing CFR.

TRUE = 1

Enables filter operation when performing CFR. Filter operation is not supported when you set the CFR_METHOD attribute to Sigmoid.

class nirfmxspecan.enums.DpdPreDpdCfrMethod(value)

Bases: Enum

DpdPreDpdCfrMethod.

CLIPPING = 0

Hard clips the signal such that the target PAPR is achieved.

PEAK_WINDOWING = 1

Scales the peaks in the signal using weighted window function to get smooth peaks and achieve the target PAPR.

SIGMOID = 2

Scales the peaks using modified sigmoid transfer function to get smooth peaks and achieve the target PAPR. This method does not support the filter operation.

class nirfmxspecan.enums.DpdPreDpdCfrWindowType(value)

Bases: Enum

DpdPreDpdCfrWindowType.

BLACKMAN = 5

Uses the Blackman window function to scale peaks.

BLACKMAN_HARRIS = 6

Uses the Blackman-Harris window function to scale peaks.

FLAT_TOP = 1

Uses the flat top window function to scale peaks.

GAUSSIAN = 4

Uses the Gaussian window function to scale peaks.

HAMMING = 3

Uses the Hamming window function to scale peaks.

HANNING = 2

Uses the Hanning window function to scale peaks.

KAISER_BESSEL = 7

Uses the Kaiser-Bessel window function to scale peaks.

class nirfmxspecan.enums.DpdReferenceWaveformIdleDurationPresent(value)

Bases: Enum

DpdReferenceWaveformIdleDurationPresent.

FALSE = 0

The reference waveform does not contain an idle duration.

TRUE = 1

The reference waveform contains an idle duration.

class nirfmxspecan.enums.DpdSignalType(value)

Bases: Enum

DpdSignalType.

MODULATED = 0

The reference waveform is a cellular or connectivity standard signal.

TONES = 1

The reference waveform is a continuous signal comprising one or more tones.

class nirfmxspecan.enums.DpdSynchronizationMethod(value)

Bases: Enum

DpdSynchronizationMethod.

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 measurement sampling rate is low. Refer to DPD concept help for more information.

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 measurement sampling rate is high.

class nirfmxspecan.enums.DpdTargetGainType(value)

Bases: Enum

DpdTargetGainType.

AVERAGE_GAIN = 0

The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the average power gain provided by the DUT without DPD.

LINEAR_REGION_GAIN = 1

The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the gain provided by the DUT, without DPD, to the parts of the reference waveform that do not drive the DUT into non-linear gain-expansion or compression regions of its input-output characteristics.

The measurement computes the linear region gain as the average gain experienced by the parts of the reference waveform that are below a threshold which is computed as shown in the following equation:

Linear region threshold (dBm) = Max {-25, Min {reference waveform power} + 6, DUT Average Input Power -15}

PEAK_INPUT_POWER_GAIN = 2

The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the average power gain provided by the DUT, without DPD, to all the samples of the reference waveform for which the magnitude is greater than the peak power in the reference waveform (dBm) - 0.5dB.

class nirfmxspecan.enums.FcntAveragingEnabled(value)

Bases: Enum

FcntAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The FCnt measurement uses the AVERAGING_ENABLED attribute as the number of acquisitions over which the FCnt measurement is averaged.

class nirfmxspecan.enums.FcntAveragingType(value)

Bases: Enum

FcntAveragingType.

MAXIMUM = 3

The maximum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.

MEAN = 6

The mean of the instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.

MINIMUM = 4

The minimum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.

MINMAX = 7

The maximum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement. The sign of the phase difference is ignored to find the maximum instantaneous value.

class nirfmxspecan.enums.FcntRbwFilterType(value)

Bases: Enum

FcntRbwFilterType.

FLAT = 2

The RBW filter has a flat response.

GAUSSIAN = 1

The RBW filter has a Gaussian response.

NONE = 5

The measurement does not use any RBW filtering.

RRC = 6

The RRC filter with the roll-off specified by RBW_FILTER_RRC_ALPHA attribute is used as the RBW filter.

class nirfmxspecan.enums.FcntThresholdEnabled(value)

Bases: Enum

FcntThresholdEnabled.

FALSE = 0

All samples are considered for the FCnt measurement.

TRUE = 1

The samples above the threshold level specified in the THRESHOLD_LEVEL attribute are considered for the FCnt measurement.

class nirfmxspecan.enums.FcntThresholdType(value)

Bases: Enum

FcntThresholdType.

ABSOLUTE = 1

The threshold is the absolute power, in dBm.

RELATIVE = 0

The threshold is relative to the peak power of the acquired samples.

class nirfmxspecan.enums.HarmAutoHarmonicsSetupEnabled(value)

Bases: Enum

HarmAutoHarmonicsSetupEnabled.

FALSE = 0

The measurement uses manual configuration for the harmonic order, harmonic bandwidth, and harmonic measurement interval.

TRUE = 1

The measurement uses the 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

class nirfmxspecan.enums.HarmAveragingEnabled(value)

Bases: Enum

HarmAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The Harmonics measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the Harmonics measurement is averaged.

class nirfmxspecan.enums.HarmAveragingType(value)

Bases: Enum

HarmAveragingType.

LOG = 1

The power trace is averaged in a logarithmic scale.

MAXIMUM = 3

The maximum instantaneous power in the power trace is retained from one acquisition to the next.

MINIMUM = 4

The minimum instantaneous power in the power trace is retained from one acquisition to the next.

RMS = 0

The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

SCALAR = 2

The square root of the power trace is averaged.

class nirfmxspecan.enums.HarmHarmonicEnabled(value)

Bases: Enum

HarmHarmonicEnabled.

FALSE = 0

Disables the harmonic for measurement.

TRUE = 1

Enables the harmonic for measurement.

class nirfmxspecan.enums.HarmMeasurementMethod(value)

Bases: Enum

HarmMeasurementMethod.

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

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

class nirfmxspecan.enums.HarmNoiseCompensationEnabled(value)

Bases: Enum

HarmNoiseCompensationEnabled.

FALSE = 0

Disables compensation of the average harmonic powers for the noise floor of the signal analyzer.

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

class nirfmxspecan.enums.HarmRbwFilterType(value)

Bases: Enum

HarmRbwFilterType.

FLAT = 2

The RBW filter has a flat response.

GAUSSIAN = 1

The RBW filter has a Gaussian response.

NONE = 5

The measurement does not use any RBW filtering.

RRC = 6

The RRC filter with the roll-off specified by the FUNDAMENTAL_RBW_FILTER_ALPHA attribute is used as the RBW filter.

class nirfmxspecan.enums.IMAmplitudeCorrectionType(value)

Bases: Enum

IMAmplitudeCorrectionType.

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.

SPECTRUM_FREQUENCY_BIN = 1

An Individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

class nirfmxspecan.enums.IMAutoIntermodsSetupEnabled(value)

Bases: Enum

IMAutoIntermodsSetupEnabled.

FALSE = 0

The measurement uses the values that you specify for the LOWER_INTERMOD_FREQUENCY and UPPER_INTERMOD_FREQUENCY attributes.

TRUE = 1

The measurement computes the intermod frequencies. The maximum number of intermods that you can measure is based on the value of the MAXIMUM_INTERMOD_ORDER attribute.

class nirfmxspecan.enums.IMAveragingEnabled(value)

Bases: Enum

IMAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The IM measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the IM measurement is averaged.

class nirfmxspecan.enums.IMAveragingType(value)

Bases: Enum

IMAveragingType.

LOG = 1

The power spectrum is averaged in a logarithmic scale.

MAXIMUM = 3

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

MINIMUM = 4

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

RMS = 0

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

SCALAR = 2

The square root of the power spectrum is averaged.

class nirfmxspecan.enums.IMFftWindow(value)

Bases: Enum

IMFftWindow.

BLACKMAN = 5

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

BLACKMAN_HARRIS = 6

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

FLAT_TOP = 1

Measures single-tone amplitudes accurately.

GAUSSIAN = 4

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. This windowing is useful for time-frequency analysis.

HAMMING = 3

Analyzes closely-spaced sine waves.

HANNING = 2

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

KAISER_BESSEL = 7

Separates two tones with frequencies close to each other but with widely-differing amplitudes.

NONE = 0

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

class nirfmxspecan.enums.IMFrequencyDefinition(value)

Bases: Enum

IMFrequencyDefinition.

ABSOLUTE = 1

The tone and intermod frequencies are absolute frequencies. The measurement ignores the RF center frequency.

RELATIVE = 0

The tone and intermod frequencies are relative to the RF center frequency.

class nirfmxspecan.enums.IMIFOutputPowerOffsetAuto(value)

Bases: Enum

IMIFOutputPowerOffsetAuto.

FALSE = 0

The measurement sets the IF output power level offset using the values of the NEAR_IF_OUTPUT_POWER_OFFSET and FAR_IF_OUTPUT_POWER_OFFSET attributes.

TRUE = 1

The measurement computes an IF output power level offset for the intermods to improve the dynamic range of the IM measurement.

class nirfmxspecan.enums.IMIntermodEnabled(value)

Bases: Enum

IMIntermodEnabled.

FALSE = 0

Disables an intermod for the IM measurement. The results for the disabled intermods are displayed as NaN.

TRUE = 1

Enables an intermod for the IM measurement.

class nirfmxspecan.enums.IMIntermodSide(value)

Bases: Enum

IMIntermodSide.

BOTH = 2

Measures the intermodulation product corresponding to both IM Lower Intermod Freq and IM Upper Intermod Freq attributes.

LOWER = 0

Measures the intermodulation product corresponding to the LOWER_INTERMOD_FREQUENCY attribute.

UPPER = 1

Measures the intermodulation product corresponding to the UPPER_INTERMOD_FREQUENCY attribute.

class nirfmxspecan.enums.IMLocalPeakSearchEnabled(value)

Bases: Enum

IMLocalPeakSearchEnabled.

FALSE = 0

The measurement returns the power at the tone and intermod frequencies.

TRUE = 1

The measurement performs a local peak search around the tone and intermod frequencies to return the peak power.

class nirfmxspecan.enums.IMMeasurementMethod(value)

Bases: Enum

IMMeasurementMethod.

DYNAMIC_RANGE = 1

The IM measurement acquires a segmented spectrum using the signal analyzer specific optimizations for different frequency bands. The spectrum is acquired in segments, one per tone or intermod frequency to be measured. The span of each acquired spectral segment is equal to the frequency separation between the two input tones, or 1 MHz, whichever is smaller.

Use this method to configure the IM measurement and the signal analyzer for maximum dynamic range instead of measurement speed.

Supported devices: PXIe-5665/5668.

NORMAL = 0

The IM measurement acquires the spectrum using the same signal analyzer settings across frequency bands. Use this method when the fundamental tone separation is not large.

Supported devices: PXIe-5644/5645/5646/5840/5841/5842/5860/5830/5831/5832, PXIe-5663/5665/5668.

SEGMENTED = 2

Similar to the Dynamic Range method, this method also acquires a segmented spectrum, except that signal analyzer is not explicitly configured to provide maximum dynamic range. Use this method when the frequency separation of the two input tones is large and the measurement accuracy can be traded off for measurement speed.

Supported devices: PXIe-5644/5645/5646/5840/5841/5842/5860/5830/5831/5832, PXIe-5663/5665/5668.

class nirfmxspecan.enums.IMRbwFilterAutoBandwidth(value)

Bases: Enum

IMRbwFilterAutoBandwidth.

FALSE = 0

The measurement uses the RBW that you specify in the RBW_FILTER_BANDWIDTH attribute.

TRUE = 1

The measurement computes the RBW.

class nirfmxspecan.enums.IMRbwFilterType(value)

Bases: Enum

IMRbwFilterType.

FFT_BASED = 0

No RBW filtering is performed.

FLAT = 2

An RBW filter with a flat response is applied.

GAUSSIAN = 1

An RBW filter with a Gaussian response is applied.

class nirfmxspecan.enums.IMSweepTimeAuto(value)

Bases: Enum

IMSweepTimeAuto.

FALSE = 0

The measurement uses the sweep time that you specify in the SWEEP_TIME_INTERVAL attribute.

TRUE = 1

The measurement computes the sweep time based on the value of the RBW_FILTER_BANDWIDTH attribute.

class nirfmxspecan.enums.IQBandwidthAuto(value)

Bases: Enum

IQBandwidthAuto.

FALSE = 0

The measurement uses the value of the BANDWIDTH attribute as the minimum acquisition bandwidth.

TRUE = 1

The measurement uses 0.8 * sample rate as the minimum signal bandwidth.

class nirfmxspecan.enums.IQDeleteRecordOnFetch(value)

Bases: Enum

IQDeleteRecordOnFetch.

FALSE = 0

The measurement does not delete the fetched record.

TRUE = 1

The measurement deletes the fetched record.

class nirfmxspecan.enums.IQMeasurementMode(value)

Bases: Enum

IQMeasurementMode.

NORMAL = 0

Performs the measurement in the normal RFmx execution mode and supports all the RFmx features such as overlapped measurements.

RAWIQ = 1

Reduces the overhead introduced by this measurement by not copying and storing the data in RFmx. In this mode IQ data needs to be retrieved using nirfmxinstr.session.Session.fetch_raw_iq_data() method instead of fetch_data() method. nirfmxinstr.session.Session.fetch_raw_iq_data() directly fetches the data from the hardware.

The following list describes the limitations of using this mode,

• No other measurements can be enabled along with this IQ measurement.

• You must fetch the IQ data before initiating another RFmx measurement because the data is not stored in RFmx.

class nirfmxspecan.enums.IQPowerEdgeTriggerLevelType(value)

Bases: Enum

IQPowerEdgeTriggerLevelType.

ABSOLUTE = 1

The IQ Power Edge Level attribute specifies the absolute power.

RELATIVE = 0

The IQ Power Edge Level attribute is relative to the value of the REFERENCE_LEVEL attribute.

class nirfmxspecan.enums.IQPowerEdgeTriggerSlope(value)

Bases: Enum

IQPowerEdgeTriggerSlope.

FALLING_SLOPE = 1

The trigger asserts when the signal power is falling.

RISING_SLOPE = 0

The trigger asserts when the signal power is rising.

class nirfmxspecan.enums.IdpdAveragingEnabled(value)

Bases: Enum

IdpdAveragingEnabled.

FALSE = 0

The number of acquisitions is 1.

TRUE = 1

The measurement uses AVERAGING_COUNT for the number of acquisitions over which the measurement is averaged.

class nirfmxspecan.enums.IdpdEqualizerMode(value)

Bases: Enum

IdpdEqualizerMode.

HOLD = 2

The configure_equalizer_coefficients() method specifies the filter that acts as the equalization filter. This filter is applied prior to calculating the predistorted waveform.

OFF = 0

Equalization filter is not applied.

TRAIN = 1

Train Equalization filter. The filter length is obtained from the EQUALIZER_FILTER_LENGTH.

class nirfmxspecan.enums.IdpdEvmEnabled(value)

Bases: Enum

IdpdEvmEnabled.

FALSE = 0

Disables EVM computation. NaN is returned for Mean RMS EVM.

TRUE = 1

Enables EVM computation.

class nirfmxspecan.enums.IdpdEvmUnit(value)

Bases: Enum

IdpdEvmUnit.

DB = 1

EVM is expressed in dB.

PERCENTAGE = 0

EVM is expressed as a percentage.

class nirfmxspecan.enums.IdpdMeasurementSampleRateMode(value)

Bases: Enum

IdpdMeasurementSampleRateMode.

REFERENCE_WAVEFORM = 1

Acquisition sample rate is set to match the sample rate of the reference waveform.

USER = 0

Acquisition sample rate is defined by the MEASUREMENT_SAMPLE_RATE.

class nirfmxspecan.enums.IdpdReferenceWaveformIdleDurationPresent(value)

Bases: Enum

IdpdReferenceWaveformIdleDurationPresent.

FALSE = 0

Reference waveform has no idle duration.

TRUE = 1

Reference waveform contains idle duration.

class nirfmxspecan.enums.IdpdSignalType(value)

Bases: Enum

IdpdSignalType.

MODULATED = 0

Specifies the reference waveform is a banded signal like cellular or connectivity standard signals.

TONES = 1

Specifies the reference waveform is a continuous signal comprising of one or more tones.

IDPD measurement chooses alignment algorithms based on the IDPD Signal Type attribute.

class nirfmxspecan.enums.LimitedConfigurationChange(value)

Bases: Enum

LimitedConfigurationChange.

DISABLED = 0

This is the normal mode of RFmx operation. All configuration changes in RFmxInstr attributes or in personality attributes will be applied during RFmx Commit.

FREQUENCY = 2

Signal configuration, other than center frequency, external attenuation, and RFInstr configuration, is locked after first Commit or Initiate of the named signal configuration. Thereafter, only the CENTER_FREQUENCY and EXTERNAL_ATTENUATION attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

FREQUENCY_AND_REFERENCE_LEVEL = 4

Signal configuration, other than center frequency, reference level, external attenuation, and RFInstr configuration, is locked after first Commit or Initiate of the named signal configuration. Thereafter only Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

NO_CHANGE = 1

Signal configuration and RFmxInstr configuration are locked after the first Commit or Initiate of the named signal configuration. Any configuration change thereafter either in RFmxInstr attributes or personality attributes will not be considered by subsequent RFmx Commits or Initiates of this signal. Use No Change if you have created named signal configurations for all measurement configurations but are setting some RFmxInstr attributes. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

REFERENCE_LEVEL = 3

Signal configuration, other than the reference level and RFInstr configuration, is locked after first Commit or Initiate of the named signal configuration. Thereafter only the REFERENCE_LEVEL attribute value change will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends that you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

SELECTED_PORTS_FREQUENCY_AND_REFERENCE_LEVEL = 5

Signal configuration, other than Selected Ports, Center frequency, Reference level, External attenuation, and RFInstr configuration, is locked after first Commit or Initiate of the named signal configuration. Thereafter only Selected Ports, Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

class nirfmxspecan.enums.MarkerFunctionType(value)

Bases: Enum

MarkerFunctionType.

BAND_POWER = 1

Band Power is computed within the specified span.

OFF = 0

The marker function is disabled.

class nirfmxspecan.enums.MarkerNextPeak(value)

Bases: Enum

MarkerNextPeak.

NEXT_HIGHEST = 0

Moves the marker to the next highest peak above the threshold on the configured trace.

NEXT_LEFT = 1

Moves the marker to the next peak to the left of the configured trace.

NEXT_RIGHT = 2

Moves the marker to the next peak to the right of the configured trace.

class nirfmxspecan.enums.MarkerPeakExcursionEnabled(value)

Bases: Enum

MarkerPeakExcursionEnabled.

FALSE = 0

Disables the peak excursion check while finding the peaks on trace.

TRUE = 1

Enables the peak excursion check while finding the peaks on trace.

class nirfmxspecan.enums.MarkerThresholdEnabled(value)

Bases: Enum

MarkerThresholdEnabled.

FALSE = 0

Disables the threshold for the trace while finding the peaks.

TRUE = 1

Enables the threshold for the trace while finding the peaks.

class nirfmxspecan.enums.MarkerTrace(value)

Bases: Enum

MarkerTrace.

ACP_SPECTRUM = 0

The marker uses the ACP spectrum trace.

CCDF_GAUSSIAN_PROBABILITIES_TRACE = 1

The marker uses the CCDF Gaussian probabilities trace.

CCDF_PROBABILITIES_TRACE = 2

The marker uses the CCDF probabilities trace.

CHP_SPECTRUM = 3

The marker uses the CHP spectrum trace.

FCNT_POWER_TRACE = 4

The marker uses the frequency count (Fcnt) power trace.

OBW_SPECTRUM = 5

The marker uses the OBW spectrum trace.

SEM_SPECTRUM = 6

The marker uses the SEM spectrum trace.

SPECTRUM = 7

The marker uses the Spectrum trace.

TXP_POWER_TRACE = 8

The marker uses the TXP power trace.

class nirfmxspecan.enums.MarkerType(value)

Bases: Enum

MarkerType.

DELTA = 3

The marker is enabled as a delta marker.

FIXED = 4

The marker is enabled as a fixed marker.

NORMAL = 1

The marker is enabled as a normal marker.

OFF = 0

The marker is disabled.

class nirfmxspecan.enums.MeasurementTypes(value)

Bases: IntFlag

MeasurementTypes.

ACP = 1

Selects ACP measurement.

AMPM = 1024

Selects AMPM measurement.

CCDF = 2

Selects CCDF measurement.

CHP = 4

Selects CHP measurement.

DPD = 2048

Selects DPD measurement.

FCNT = 8

Selects frequency count (Fcnt) measurement.

HARMONICS = 16

Selects Harmonics measurement.

IDPD = 131072

Selects IDPD measurement.

IM = 8192

Selects IM measurement.

IQ = 4096

Selects I/Q measurement.

NF = 16384

Selects NF measurement.

OBW = 32

Selects OBW measurement.

PAVT = 65536

Selects PAVT measurement.

PHASENOISE = 32768

Selects PhaseNoise measurement.

POWERLIST = 262144

SEM = 64

Selects SEM measurement.

SPECTRUM = 128

Selects Spectrum measurement.

SPUR = 256

Selects Spur measurement.

TXP = 512

Selects TXP measurement.

class nirfmxspecan.enums.NFAveragingEnabled(value)

Bases: Enum

NFAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The NF measurement uses the value of the AVERAGING_COUNT attribute as the number of acquisitions for each frequency which you specify in the FREQUENCY_LIST attribute, over which the NF measurement is averaged.

class nirfmxspecan.enums.NFCalibrationDataValid(value)

Bases: Enum

NFCalibrationDataValid.

FALSE = 0

Calibration data is not present for one or more frequency points in the list or the difference between the current device temperature and the temperature at which calibration was performed exceeds the tolerance specified by the NFDeviceTemperatureTolerance method.

TRUE = 1

Calibration data is present for all of the frequencies in the list.

class nirfmxspecan.enums.NFCalibrationLossCompensationEnabled(value)

Bases: Enum

NFCalibrationLossCompensationEnabled.

FALSE = 0

The NF measurement ignores the ohmic losses.

TRUE = 1

The NF measurement accounts for the ohmic losses.

class nirfmxspecan.enums.NFCalibrationLossS2pSParameterOrientation(value)

Bases: Enum

NFCalibrationLossS2pSParameterOrientation.

PORT1_TOWARDS_DUT = 0

PORT2_TOWARDS_DUT = 1

class nirfmxspecan.enums.NFColdSourceDutS2pSParameterOrientation(value)

Bases: Enum

NFColdSourceDutS2pSParameterOrientation.

PORT1_TOWARDS_DUT = 0

PORT2_TOWARDS_DUT = 1

class nirfmxspecan.enums.NFColdSourceMode(value)

Bases: Enum

NFColdSourceMode.

CALIBRATE = 1

The NF measurement computes the noise characteristics of the analyzer.

MEASURE = 0

The noise figure (NF) measurement computes the noise characteristics of the DUT and compensates for the noise figure of the analyzer.

class nirfmxspecan.enums.NFDutInputLossCompensationEnabled(value)

Bases: Enum

NFDutInputLossCompensationEnabled.

FALSE = 0

The NF measurement ignores the ohmic losses.

TRUE = 1

The NF measurement accounts for the ohmic losses.

class nirfmxspecan.enums.NFDutInputLossS2pSParameterOrientation(value)

Bases: Enum

NFDutInputLossS2pSParameterOrientation.

PORT1_TOWARDS_DUT = 0

PORT2_TOWARDS_DUT = 1

class nirfmxspecan.enums.NFDutOutputLossCompensationEnabled(value)

Bases: Enum

NFDutOutputLossCompensationEnabled.

FALSE = 0

The NF measurement ignores ohmic losses.

TRUE = 1

The NF measurement accounts for the ohmic losses.

class nirfmxspecan.enums.NFDutOutputLossS2pSParameterOrientation(value)

Bases: Enum

NFDutOutputLossS2pSParameterOrientation.

PORT1_TOWARDS_DUT = 0

PORT2_TOWARDS_DUT = 1

class nirfmxspecan.enums.NFDutType(value)

Bases: Enum

NFDutType.

AMPLIFIER = 0

Specifies that the DUT only amplifies or attenuates the signal, and does not change the frequency.

DOWNCONVERTER = 1

Specifies that the DUT is a downconverter, that is, the IF frequency is the difference between the LO and RF frequencies.

UPCONVERTER = 2

Specifies that the DUT is an upconverter, that is, the IF frequency is the sum of LO and RF frequencies.

class nirfmxspecan.enums.NFExternalPreampGainS2pSParameterOrientation(value)

Bases: Enum

NFExternalPreampGainS2pSParameterOrientation.

Port1_Towards_DUT = 0

Port2_Towards_DUT = 1

class nirfmxspecan.enums.NFExternalPreampPresent(value)

Bases: Enum

NFExternalPreampPresent.

FALSE = 0

No external preamplifier present in the signal path.

TRUE = 1

An external preamplifier present in the signal path.

class nirfmxspecan.enums.NFFrequencyConverterFrequencyContext(value)

Bases: Enum

NFFrequencyConverterFrequencyContext.

IF = 1

Specifies that the frequency context is IF.

RF = 0

Specifies that the frequency context is RF.

class nirfmxspecan.enums.NFFrequencyConverterSideband(value)

Bases: Enum

NFFrequencyConverterSideband.

LSB = 0

When the frequency context is IF, out of the two possible input frequencies that gets translated to IF, the lower is treated as the RF (signal) frequency while the higher is treated as the image frequency.

USB = 1

When the frequency context is IF, out of the two possible input frequencies that gets translated to IF, the lower is treated as the image frequency while the higher is treated as the RF (signal) frequency.

class nirfmxspecan.enums.NFMeasurementMethod(value)

Bases: Enum

NFMeasurementMethod.

COLD_SOURCE = 1

The NF measurement computes the noise figure of the DUT using a 50 ohm microwave termination as the noise source.

Supported Devices: PXIe-5644/5645/5646/5840/5841/5842/5860, PXIe-5830/5831/5832

Y_FACTOR = 0

The NF measurement computes the noise figure of the DUT using a noise source with a calibrated excess-noise ratio (ENR).

Refer to the Y_FACTOR_NOISE_SOURCE_TYPE attribute for information about supported devices and their corresponding noise source type.

class nirfmxspecan.enums.NFYFactorMode(value)

Bases: Enum

NFYFactorMode.

CALIBRATE = 1

The NF measurement computes the noise characteristics of the analyzer.

MEASURE = 0

The noise figure (NF) measurement computes the noise characteristics of the DUT, compensating for the noise figure of the analyzer.

class nirfmxspecan.enums.NFYFactorNoiseSourceLossCompensationEnabled(value)

Bases: Enum

NFYFactorNoiseSourceLossCompensationEnabled.

FALSE = 0

Ohmic losses are ignored.

TRUE = 1

Ohmic losses are accounted for in the NF measurement.

class nirfmxspecan.enums.NFYFactorNoiseSourceLossS2pSParameterOrientation(value)

Bases: Enum

NFYFactorNoiseSourceLossS2pSParameterOrientation.

Port1_Towards_DUT = 0

Port2_Towards_DUT = 1

class nirfmxspecan.enums.NFYFactorNoiseSourceType(value)

Bases: Enum

NFYFactorNoiseSourceType.

EXTERNAL_NOISE_SOURCE = 0

The NF measurement generates noise using an external noise source, that is controlled either by an internal noise source power supply or an NI Source Measure Unit (SMU).

Supported Devices: PXIe-5665 (3.6 GHz), PXIe-5668, PXIe-5644/5645/5646*, PXIe-5840*/5841*/5842*/5860*, PXIe 5830/5831*/5832*

*Use an external NI Source Measure Unit (SMU) as the noise source power supply for the Noise Figure measurement.

During initialization, specify the SMU resource name using <span class=”Monospace”>”NoiseSourcePowerSupply”</span> as the specifier within the RFmxSetup string. For example, <span class=”Monospace”>”RFmxSetup= NoiseSourcePowerSupply:myDCPower[0]”</span> configures RFmx to use channel 0 on myDCPower SMU device for powering the noise source. You should allocate a dedicated SMU channel for RFmx.

RFmx supports PXIe-4138, PXIe-4139, and PXIe-4139 (40 W) SMUs.

RF_SIGNAL_GENERATOR = 1

When you measure Y-Factor based NF using a supported NI vector signal transceiver (VST) instrument, RFmx generates noise using the vector signal generator (VSG) integrated into the same VST.

RFmx automatically configures the vector signal generator (VSG) to generate noise at the specified bandwidth and ENR levels that you set using the Y_FACTOR_NOISE_SOURCE_ENR_FREQUENCY and Y_FACTOR_NOISE_SOURCE_ENR attributes.

Supported Devices: PXIe-5842/5860

class nirfmxspecan.enums.ObwAmplitudeCorrectionType(value)

Bases: Enum

ObwAmplitudeCorrectionType.

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.

SPECTRUM_FREQUENCY_BIN = 1

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

class nirfmxspecan.enums.ObwAveragingEnabled(value)

Bases: Enum

ObwAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The OBW measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the OBW measurement is averaged.

class nirfmxspecan.enums.ObwAveragingType(value)

Bases: Enum

ObwAveragingType.

LOG = 1

The power spectrum is averaged in a logarithmic scale.

MAXIMUM = 3

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

MINIMUM = 4

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

RMS = 0

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

SCALAR = 2

The square root of the power spectrum is averaged.

class nirfmxspecan.enums.ObwFftWindow(value)

Bases: Enum

ObwFftWindow.

BLACKMAN = 5

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

BLACKMAN_HARRIS = 6

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

FLAT_TOP = 1

Measures single-tone amplitudes accurately.

GAUSSIAN = 4

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.

HAMMING = 3

Analyzes closely-spaced sine waves.

HANNING = 2

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

KAISER_BESSEL = 7

Separates two tones with frequencies close to each other but with widely-differing amplitudes.

NONE = 0

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

class nirfmxspecan.enums.ObwPowerUnits(value)

Bases: Enum

ObwPowerUnits.

DBM = 0

The absolute powers are reported in dBm.

DBM_PER_HZ = 1

The absolute powers are reported in dBm/Hz.

class nirfmxspecan.enums.ObwRbwAutoBandwidth(value)

Bases: Enum

ObwRbwAutoBandwidth.

FALSE = 0

The measurement uses the RBW that you specify in the RBW_FILTER_BANDWIDTH attribute.

TRUE = 1

The measurement computes the RBW.

class nirfmxspecan.enums.ObwRbwFilterBandwidthDefinition(value)

Bases: Enum

ObwRbwFilterBandwidthDefinition.

BANDWIDTH_DEFINITION_3DB = 0

Defines the RBW in terms of the 3 dB bandwidth of the RBW filter. When you set the RBW_FILTER_TYPE attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the FFT_WINDOW attribute.

BIN_WIDTH = 2

Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the OBW RBW Filter Type attribute to FFT Based.

class nirfmxspecan.enums.ObwRbwFilterType(value)

Bases: Enum

ObwRbwFilterType.

FFT_BASED = 0

No RBW filtering is performed.

FLAT = 2

The RBW filter has a flat response.

GAUSSIAN = 1

The RBW filter has a Gaussian response.

class nirfmxspecan.enums.ObwSweepTimeAuto(value)

Bases: Enum

ObwSweepTimeAuto.

FALSE = 0

The measurement uses the sweep time that you specify in the SWEEP_TIME_INTERVAL attribute.

TRUE = 1

The measurement calculates the sweep time based on the value of the RBW_FILTER_BANDWIDTH attribute.

class nirfmxspecan.enums.PavtFrequencyOffsetCorrectionEnabled(value)

Bases: Enum

PavtFrequencyOffsetCorrectionEnabled.

FALSE = 0

Disables the frequency offset correction.

TRUE = 1

Enables the frequency offset correction. The measurement computes and corrects any frequency offset between the reference and the acquired waveforms.

class nirfmxspecan.enums.PavtFrequencyTrackingEnabled(value)

Bases: Enum

PavtFrequencyTrackingEnabled.

FALSE = 0

Disables the drift correction for the measurement.

TRUE = 1

Enables the drift correction. The measurement corrects and reports the frequency offset per segment.

class nirfmxspecan.enums.PavtMeasurementIntervalMode(value)

Bases: Enum

PavtMeasurementIntervalMode.

UNIFORM = 0

The time offset from the start of segment and the duration over which the measurement is performed is uniform for all segments and is given by the MEASUREMENT_OFFSET attribute and the MEASUREMENT_LENGTH attribute respectively.

VARIABLE = 1

The time offset from the start of segment and the duration over which the measurement is performed is configured separately for each segment and is given by the SEGMENT_MEASUREMENT_OFFSET attribute and the SEGMENT_MEASUREMENT_LENGTH attribute respectively.

class nirfmxspecan.enums.PavtMeasurementLocationType(value)

Bases: Enum

PavtMeasurementLocationType.

TIME = 0

The measurement is performed over a single record across multiple segments separated in time. The measurement locations of the segments are specified by the SEGMENT_START_TIME attribute. The number of segments is equal to the number of segment start times.

TRIGGER = 1

The measurement is performed across segments obtained in multiple records, where each record is obtained when a trigger is received. The number of segments is equal to the number of triggers (records).

class nirfmxspecan.enums.PavtPhaseUnwrapEnabled(value)

Bases: Enum

PavtPhaseUnwrapEnabled.

FALSE = 0

Phase measurement results are wrapped within +/-180 degrees.

TRUE = 1

Phase measurement results are unwrapped.

class nirfmxspecan.enums.PavtSegmentType(value)

Bases: Enum

PavtSegmentType.

AMPLITUDE = 1

Amplitude is measured in this segment.

FREQUENCY_ERROR_MEASUREMENT = 2

Frequency error is measured in this segment.

PHASE_AND_AMPLITUDE = 0

Phase and amplitude is measured in this segment.

class nirfmxspecan.enums.PhaseNoiseCancellationEnabled(value)

Bases: Enum

PhaseNoiseCancellationEnabled.

FALSE = 0

Disables phase noise cancellation.

TRUE = 1

Enables phase noise cancellation.

class nirfmxspecan.enums.PhaseNoiseFftWindow(value)

Bases: Enum

PhaseNoiseFftWindow.

BLACKMAN = 5

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

BLACKMAN_HARRIS = 6

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

FLAT_TOP = 1

Measures single-tone amplitudes accurately.

GAUSSIAN = 4

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.

HAMMING = 3

Analyzes closely-spaced sine waves.

HANNING = 2

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

KAISER_BESSEL = 7

Separates two tones with frequencies close to each other but with widely-differing amplitudes.

NONE = 0

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

class nirfmxspecan.enums.PhaseNoiseIntegratedNoiseRangeDefinition(value)

Bases: Enum

PhaseNoiseIntegratedNoiseRangeDefinition.

CUSTOM = 2

The measurement range(s) specified by INTEGRATED_NOISE_START_FREQUENCY attribute and the INTEGRATED_NOISE_STOP_FREQUENCY attribute is used for computing integrated measurements.

MEASUREMENT = 1

The complete log plot frequency range, considered as a single range, is used for computing integrated measurements.

NONE = 0

Integrated noise measurement is not computed.

class nirfmxspecan.enums.PhaseNoiseRangeDefinition(value)

Bases: Enum

PhaseNoiseRangeDefinition.

AUTO = 1

Measurement computes offset sub-ranges by dividing the user configured offset range into multiple decade sub-ranges. The range is specified by the START_FREQUENCY and the RANGE_STOP_FREQUENCY attributes.

MANUAL = 0

Specify the offset sub-ranges used for the measurement. Use the RANGE_START_FREQUENCY attribute and the RANGE_STOP_FREQUENCY attribute to configure single or multiple range start and range stop frequencies.

class nirfmxspecan.enums.PhaseNoiseSmoothingType(value)

Bases: Enum

PhaseNoiseSmoothingType.

LINEAR = 1

Performs linear moving average filtering on the measured phase noise log plot trace.

LOGARITHMIC = 2

Performs logarithmic moving average filtering on the measured phase noise log plot trace.

MEDIAN = 3

Performs moving median filtering on the measured phase noise log plot trace.

NONE = 0

Smoothing is disabled.

class nirfmxspecan.enums.PhaseNoiseSpurRemovalEnabled(value)

Bases: Enum

PhaseNoiseSpurRemovalEnabled.

FALSE = 0

Disables spur removal on the log plot trace.

TRUE = 1

Enables spur removal on the log plot trace.

class nirfmxspecan.enums.SemAmplitudeCorrectionType(value)

Bases: Enum

SemAmplitudeCorrectionType.

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.

SPECTRUM_FREQUENCY_BIN = 1

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

class nirfmxspecan.enums.SemAveragingEnabled(value)

Bases: Enum

SemAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The SEM measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the SEM measurement is averaged.

class nirfmxspecan.enums.SemAveragingType(value)

Bases: Enum

SemAveragingType.

LOG = 1

The power spectrum is averaged in a logarithmic scale.

MAXIMUM = 3

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

MINIMUM = 4

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

RMS = 0

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

SCALAR = 2

The square root of the power spectrum is averaged.

class nirfmxspecan.enums.SemCarrierEnabled(value)

Bases: Enum

SemCarrierEnabled.

FALSE = 0

The carrier power is not considered as part of the total carrier power.

TRUE = 1

The carrier power is considered as part of the total carrier power.

class nirfmxspecan.enums.SemCarrierRbwAutoBandwidth(value)

Bases: Enum

SemCarrierRbwAutoBandwidth.

FALSE = 0

The measurement uses the RBW that you specify in the CARRIER_RBW_FILTER_BANDWIDTH attribute.

TRUE = 1

The measurement computes the RBW.

class nirfmxspecan.enums.SemCarrierRbwFilterBandwidthDefinition(value)

Bases: Enum

SemCarrierRbwFilterBandwidthDefinition.

BANDWIDTH_DEFINITION_3DB = 0

Defines the RBW in terms of the 3 dB bandwidth of the RBW filter. When you set the CARRIER_RBW_FILTER_TYPE attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the FFT_WINDOW attribute.

BIN_WIDTH = 2

Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the SEM Carrier RBW Filter Type attribute to FFT Based.

class nirfmxspecan.enums.SemCarrierRbwFilterType(value)

Bases: Enum

SemCarrierRbwFilterType.

FFT_BASED = 0

No RBW filtering is performed.

FLAT = 2

The RBW filter has a flat response.

GAUSSIAN = 1

The RBW filter has a Gaussian response.

class nirfmxspecan.enums.SemCarrierRrcFilterEnabled(value)

Bases: Enum

SemCarrierRrcFilterEnabled.

FALSE = 0

The channel power of the acquired carrier channel is measured directly.

TRUE = 1

The measurement applies the RRC filter on the acquired carrier channel before measuring the carrier channel power.

class nirfmxspecan.enums.SemCompositeMeasurementStatus(value)

Bases: Enum

SemCompositeMeasurementStatus.

FAIL = 0

Indicates that the measurement has failed.

PASS = 1

Indicates that the measurement has passed.

class nirfmxspecan.enums.SemFftWindow(value)

Bases: Enum

SemFftWindow.

BLACKMAN = 5

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

BLACKMAN_HARRIS = 6

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

FLAT_TOP = 1

Measures single-tone amplitudes accurately.

GAUSSIAN = 4

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.

HAMMING = 3

Analyzes closely-spaced sine waves.

HANNING = 2

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

KAISER_BESSEL = 7

Separates two tones with frequencies close to each other but with widely-differing amplitudes.

NONE = 0

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

class nirfmxspecan.enums.SemLowerOffsetMeasurementStatus(value)

Bases: Enum

SemLowerOffsetMeasurementStatus.

FAIL = 0

Indicates that the measurement has failed.

PASS = 1

Indicates that the measurement has passed.

class nirfmxspecan.enums.SemOffsetAbsoluteLimitMode(value)

Bases: Enum

SemOffsetAbsoluteLimitMode.

COUPLE = 1

The two ends of the line are coupled to the value of the SEM Offset Abs Limit Start attribute.

MANUAL = 0

The line specified by the OFFSET_ABSOLUTE_LIMIT_START and OFFSET_ABSOLUTE_LIMIT_STOP attribute values as the two ends is considered as the mask.

class nirfmxspecan.enums.SemOffsetEnabled(value)

Bases: Enum

SemOffsetEnabled.

FALSE = 0

Disables the offset segment for the SEM measurement.

TRUE = 1

Enables the offset segment for the SEM measurement.

class nirfmxspecan.enums.SemOffsetFrequencyDefinition(value)

Bases: Enum

SemOffsetFrequencyDefinition.

CENTER_TO_MEASUREMENT_BANDWIDTH_CENTER = 0

The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the center of the offset segment measurement bandwidth.

Measurement Bandwidth = Resolution Bandwidth * Bandwidth Integral.

CENTER_TO_MEASUREMENT_BANDWIDTH_EDGE = 1

The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the nearest edge of the offset segment measurement bandwidth.

EDGE_TO_MEASUREMENT_BANDWIDTH_CENTER = 2

The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the center of the nearest offset segment measurement bandwidth.

EDGE_TO_MEASUREMENT_BANDWIDTH_EDGE = 3

The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the edge of the nearest offset segment measurement bandwidth.

class nirfmxspecan.enums.SemOffsetLimitFailMask(value)

Bases: Enum

SemOffsetLimitFailMask.

ABSOLUTE = 2

The measurement fails if the power in the segment exceeds the absolute mask.

ABSOLUTE_AND_RELATIVE = 0

The measurement fails if the power in the segment exceeds both the absolute and relative masks.

ABSOLUTE_OR_RELATIVE = 1

The measurement fails if the power in the segment exceeds either the absolute or relative mask.

RELATIVE = 3

The measurement fails if the power in the segment exceeds the relative mask.

class nirfmxspecan.enums.SemOffsetRbwAutoBandwidth(value)

Bases: Enum

SemOffsetRbwAutoBandwidth.

FALSE = 0

The measurement uses the RBW that you specify in the OFFSET_RBW_FILTER_BANDWIDTH attribute.

TRUE = 1

The measurement computes the RBW.

class nirfmxspecan.enums.SemOffsetRbwFilterBandwidthDefinition(value)

Bases: Enum

SemOffsetRbwFilterBandwidthDefinition.

BANDWIDTH_DEFINITION_3DB = 0

Defines the RBW in terms of the 3dB bandwidth of the RBW filter. When you set the OFFSET_RBW_FILTER_TYPE attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the FFT_WINDOW attribute.

BIN_WIDTH = 2

Defines the RBW in terms of the spectrum bin width computed using FFT when you set the SEM Offset RBW Filter Type attribute to FFT Based.

class nirfmxspecan.enums.SemOffsetRbwFilterType(value)

Bases: Enum

SemOffsetRbwFilterType.

FFT_BASED = 0

No RBW filtering is performed.

FLAT = 2

The RBW filter has a flat response.

GAUSSIAN = 1

The RBW filter has a Gaussian response.

class nirfmxspecan.enums.SemOffsetRelativeLimitMode(value)

Bases: Enum

SemOffsetRelativeLimitMode.

COUPLE = 1

The two ends of the line are coupled to the value of the SEM Offset Rel Limit Start attribute.

MANUAL = 0

The line specified by the OFFSET_RELATIVE_LIMIT_START and OFFSET_RELATIVE_LIMIT_STOP attribute values as the two ends is considered as the mask.

class nirfmxspecan.enums.SemOffsetSideband(value)

Bases: Enum

SemOffsetSideband.

BOTH = 2

Configures both negative and positive offset segments.

NEGATIVE = 0

Configures a lower offset segment to the left of the leftmost carrier.

POSITIVE = 1

Configures an upper offset segment to the right of the rightmost carrier.

class nirfmxspecan.enums.SemPowerUnits(value)

Bases: Enum

SemPowerUnits.

DBM = 0

The absolute powers are reported in dBm.

DBM_PER_HZ = 1

The absolute powers are reported in dBm/Hz.

class nirfmxspecan.enums.SemReferenceType(value)

Bases: Enum

SemReferenceType.

INTEGRATION = 0

The power reference is the integrated power of the closest carrier.

PEAK = 1

The power reference is the peak power of the closest carrier.

class nirfmxspecan.enums.SemSweepTimeAuto(value)

Bases: Enum

SemSweepTimeAuto.

FALSE = 0

The measurement uses the sweep time that you specify in the SWEEP_TIME_INTERVAL attribute.

TRUE = 1

The measurement calculates the sweep time based on the value of the OFFSET_RBW_FILTER_BANDWIDTH and CARRIER_RBW_FILTER_BANDWIDTH attributes.

class nirfmxspecan.enums.SemUpperOffsetMeasurementStatus(value)

Bases: Enum

SemUpperOffsetMeasurementStatus.

FAIL = 0

Indicates that the measurement has failed.

PASS = 1

Indicates that the measurement has passed.

class nirfmxspecan.enums.SpectrumAmplitudeCorrectionType(value)

Bases: Enum

SpectrumAmplitudeCorrectionType.

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.

SPECTRUM_FREQUENCY_BIN = 1

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

class nirfmxspecan.enums.SpectrumAnalysisInput(value)

Bases: Enum

SpectrumAnalysisInput.

IQ = 0

Measurement analyzes the acquired I+jQ data, resulting generally in a spectrum that is not symmetric around 0 Hz. Spectrum trace result contains both positive and negative frequencies. Since the RMS power of the complex envelope is 3.01 dB higher than that of its equivalent real RF signal, the spectrum trace result of the acquired I+jQ data is scaled by -3.01 dB.

I_ONLY = 1

Measurement ignores the Q data from the acquired I+jQ data and analyzes I+j0, resulting in a spectrum that is symmetric around 0 Hz. Spectrum trace result contains positive frequencies only. Spectrum of I+j0 data is scaled by +3.01 dB to account for the power of the negative frequencies that are not returned in the spectrum trace.

Q_ONLY = 2

Measurement ignores the I data from the acquired I+jQ data and analyzes Q+j0, resulting in a spectrum that is symmetric around 0 Hz. Spectrum trace result contains positive frequencies only. Spectrum of Q+j0 data is scaled by +3.01 dB to account for the power of the negative frequencies that are not returned in the spectrum trace.

class nirfmxspecan.enums.SpectrumAveragingEnabled(value)

Bases: Enum

SpectrumAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The spectrum measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the spectrum measurement is averaged.

class nirfmxspecan.enums.SpectrumAveragingType(value)

Bases: Enum

SpectrumAveragingType.

LOG = 1

The power spectrum is averaged in a logarithmic scale.

MAXIMUM = 3

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

MINIMUM = 4

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

RMS = 0

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

SCALAR = 2

The square root of the power spectrum is averaged.

class nirfmxspecan.enums.SpectrumDetectorType(value)

Bases: Enum

SpectrumDetectorType.

AVERAGE_LOG = 7

The average log of all the samples in the bucket is detected.

AVERAGE_RMS = 5

The average RMS of all the samples in the bucket is detected.

AVERAGE_VOLTAGE = 6

The average voltage of all the samples in the bucket is detected.

NEGATIVE_PEAK = 4

The minimum value of the samples in the bucket is detected.

NONE = 0

The detector is disabled.

NORMAL = 2

The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.

PEAK = 3

The maximum value of the samples in the bucket is detected.

SAMPLE = 1

The middle sample in the bucket is detected.

class nirfmxspecan.enums.SpectrumFftOverlapMode(value)

Bases: Enum

SpectrumFftOverlapMode.

AUTOMATIC = 1

Measurement sets the overlap based on the value you have set for the FFT_WINDOW attribute. When you set the Spectrum FFT Window attribute to any value other than None, the number of overlapped samples between consecutive chunks is set to 50% of the value of the SEQUENTIAL_FFT_SIZE attribute. When you set the Spectrum FFT Window attribute to None, the chunks are not overlapped and the overlap is set to 0%.

DISABLED = 0

Disables the overlap between the chunks.

USER_DEFINED = 2

Measurement uses the overlap that you specify in the FFT_OVERLAP attribute.

class nirfmxspecan.enums.SpectrumFftOverlapType(value)

Bases: Enum

SpectrumFftOverlapType.

MAX = 3

The peak power in the spectrum at each frequency bin is retained from one chunk FFT to the next.

RMS = 0

Linear averaging of the FFTs taken over different chunks of data is performed. RMS averaging reduces signal fluctuations but not the noise floor.

class nirfmxspecan.enums.SpectrumFftWindow(value)

Bases: Enum

SpectrumFftWindow.

BLACKMAN = 5

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

BLACKMAN_HARRIS = 6

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

FLAT_TOP = 1

Measures single-tone amplitudes accurately.

GAUSSIAN = 4

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.

HAMMING = 3

Analyzes closely-spaced sine waves.

HANNING = 2

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

KAISER_BESSEL = 7

Separates two tones with frequencies close to each other but with widely-differing amplitudes.

NONE = 0

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

class nirfmxspecan.enums.SpectrumMeasurementMethod(value)

Bases: Enum

SpectrumMeasurementMethod.

NORMAL = 0

The Spectrum measurement acquires the spectrum using the same signal analyzer setting across frequency bands.

SEQUENTIAL_FFT = 2

The Spectrum measurement acquires I/Q samples for a duration specified by the SWEEP_TIME_INTERVAL attribute. These samples are divided into smaller chunks. If the attribute RBW_FILTER_AUTO_BANDWIDTH is True, The size of each chunk is defined by the SEQUENTIAL_FFT_SIZE attribute. If the attribute Spectrum RBW Auto is False, the Spectrum Sequential FFT Size is auto computed based on the configured RBW_FILTER_BANDWIDTH. The overlap between the chunks is defined by the FFT_OVERLAP_MODE attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged as per the configured averaging type in the attribute :py:attr:`~nirfmxspecan.attributes.AttributeID.FFT_OVERLAP_TYPE`to get the spectrum.

Sequential FFT method should be used for the following scenarios.

1. While performing fast Spectrum measurements by utilizing smaller FFT sizes. However, accuracy of the results may be reduced.

2. When measuring signals with time-varying spectral characteristics, sequential FFT with overlap mode set to Automatic should be used.

3. For accurate power measurements when the power characteristics of the signal vary over time, averaging is allowed.

The following attributes have limited support when you set the Spectrum Measurement Method attribute to Sequential FFT.

Property	Supported Value
VBW_FILTER_AUTO_BANDWIDTH	True
RBW_FILTER_TYPE	FFT Based
SWEEP_TIME_AUTO	False
AVERAGING_COUNT	>=1
NUMBER_OF_ANALYSIS_THREADS	1
AMPLITUDE_CORRECTION_TYPE	RF Center Frequency
VBW_FILTER_VBW_TO_RBW_RATIO	>=3

Note

For multi-span FFT, the averaging count should be 1.

class nirfmxspecan.enums.SpectrumMeasurementMode(value)

Bases: Enum

SpectrumMeasurementMode.

CALIBRATE_NOISE_FLOOR = 1

Manual noise calibration of the signal analyzer is performed for the spectrum measurement.

MEASURE = 0

Spectrum measurement is performed on the acquired signal.

class nirfmxspecan.enums.SpectrumNoiseCalibrationAveragingAuto(value)

Bases: Enum

SpectrumNoiseCalibrationAveragingAuto.

FALSE = 0

RFmx uses the averages that you set for the NOISE_CALIBRATION_AVERAGING_COUNT attribute.

TRUE = 1

RFmx uses a noise calibration averaging count of 32.

class nirfmxspecan.enums.SpectrumNoiseCalibrationDataValid(value)

Bases: Enum

SpectrumNoiseCalibrationDataValid.

FALSE = 0

Returns false if the calibration data is not present for the specified configuration or if the difference between the current device temperature and the calibration temperature exceeds the [-5 °C, 5 °C] range.

TRUE = 1

Returns true if the calibration data is present for the configuration specified by the signal name in the Selector string parameter.

class nirfmxspecan.enums.SpectrumNoiseCalibrationMode(value)

Bases: Enum

SpectrumNoiseCalibrationMode.

AUTO = 1

When you set the NOISE_COMPENSATION_ENABLED attribute to True, RFmx sets the INPUT_ISOLATION_ENABLED attribute to Enabled and calibrates the intrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the spectrum measurement, including compensation for noise from the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the Spectrum Noise Comp Enabled attribute to False, RFmx does not calibrate instrument noise and performs only the spectrum measurement without compensating for the noise from the instrument.

MANUAL = 0

When you set the MEASUREMENT_MODE attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the spectrum measurement manually. When you set the Spectrum Meas Mode attribute to Measure, you can initiate the spectrum measurement manually.

class nirfmxspecan.enums.SpectrumNoiseCompensationEnabled(value)

Bases: Enum

SpectrumNoiseCompensationEnabled.

FALSE = 0

Disables compensation of the spectrum for the noise floor of the signal analyzer.

TRUE = 1

Enables compensation of the spectrum for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the Spectrum measurement and cached for future use. If signal analyzer or measurement parameters change, noise floors are measured again.

class nirfmxspecan.enums.SpectrumNoiseCompensationType(value)

Bases: Enum

SpectrumNoiseCompensationType.

ANALYZER_AND_TERMINATION = 0

Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.

ANALYZER_ONLY = 1

Compensates for the analyzer noise only.

class nirfmxspecan.enums.SpectrumPowerUnits(value)

Bases: Enum

SpectrumPowerUnits.

DBM = 0

The absolute powers are reported in dBm.

DBMV = 4

The absolute powers are reported in dBmV.

DBM_PER_HZ = 1

The absolute powers are reported in dBm/Hz.

DBUV = 5

The absolute powers are reported in dBuV.

DBV = 3

The absolute powers are reported in dBV.

DBW = 2

The absolute powers are reported in dBW.

VOLTS = 7

The absolute powers are reported in volts.

VOLTS_SQUARED = 8

The absolute powers are reported in volts².

WATTS = 6

The absolute powers are reported in W.

class nirfmxspecan.enums.SpectrumRbwAutoBandwidth(value)

Bases: Enum

SpectrumRbwAutoBandwidth.

FALSE = 0

The measurement uses the RBW that you specify in the RBW_FILTER_BANDWIDTH attribute.

TRUE = 1

The measurement computes the RBW.

class nirfmxspecan.enums.SpectrumRbwFilterBandwidthDefinition(value)

Bases: Enum

SpectrumRbwFilterBandwidthDefinition.

BANDWIDTH_DEFINITION_3DB = 0

Defines the RBW in terms of the 3dB bandwidth of the RBW filter. When you set the RBW_FILTER_TYPE attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the FFT_WINDOW attribute.

BANDWIDTH_DEFINITION_6DB = 1

Defines the RBW in terms of the 6dB bandwidth of the RBW filter. When you set the Spectrum RBW Filter Type attribute to FFT Based, RBW is the 6dB bandwidth of the window specified by the Spectrum FFT Window attribute.

BIN_WIDTH = 2

Defines the RBW in terms of the spectrum bin width computed using FFT when you set the Spectrum RBW Filter Type attribute to FFT Based.

ENBW = 3

Defines the RBW in terms of the ENBW bandwidth of the RBW filter. When you set the Spectrum RBW Filter Type attribute to FFT Based, RBW is the ENBW bandwidth of the window specified by the Spectrum FFT Window attribute.

class nirfmxspecan.enums.SpectrumRbwFilterType(value)

Bases: Enum

SpectrumRbwFilterType.

FFT_BASED = 0

No RBW filtering is performed.

FLAT = 2

The RBW filter has a flat response.

GAUSSIAN = 1

The RBW filter has a Gaussian response.

class nirfmxspecan.enums.SpectrumSweepTimeAuto(value)

Bases: Enum

SpectrumSweepTimeAuto.

FALSE = 0

The measurement uses the sweep time that you specify in the SWEEP_TIME_INTERVAL attribute.

TRUE = 1

The measurement calculates the sweep time based on the value of the RBW_FILTER_BANDWIDTH attribute.

class nirfmxspecan.enums.SpectrumVbwFilterAutoBandwidth(value)

Bases: Enum

SpectrumVbwFilterAutoBandwidth.

FALSE = 0

Specify the video bandwidth in the VBW_FILTER_BANDWIDTH attribute. The VBW_FILTER_VBW_TO_RBW_RATIO attribute is disregarded in this mode.

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 VBW_FILTER_VBW_TO_RBW_RATIO attribute and the RBW_FILTER_BANDWIDTH attribute. The value of the VBW_FILTER_BANDWIDTH attribute is disregarded in this mode.

class nirfmxspecan.enums.SpurAbsoluteLimitMode(value)

Bases: Enum

SpurAbsoluteLimitMode.

COUPLE = 1

The two ends of the line are coupled to the value of the Spur Range Abs Limit Start attribute.

MANUAL = 0

The line specified by the RANGE_ABSOLUTE_LIMIT_START and RANGE_ABSOLUTE_LIMIT_STOP attribute values as the two ends is considered as the threshold.

class nirfmxspecan.enums.SpurAmplitudeCorrectionType(value)

Bases: Enum

SpurAmplitudeCorrectionType.

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.

SPECTRUM_FREQUENCY_BIN = 1

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.

class nirfmxspecan.enums.SpurAveragingEnabled(value)

Bases: Enum

SpurAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The Spur measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the Spur measurement is averaged.

class nirfmxspecan.enums.SpurAveragingType(value)

Bases: Enum

SpurAveragingType.

LOG = 1

The power spectrum is averaged in a logarithmic scale.

MAXIMUM = 3

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

MINIMUM = 4

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

RMS = 0

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

SCALAR = 2

The square root of the power spectrum is averaged.

class nirfmxspecan.enums.SpurFftWindow(value)

Bases: Enum

SpurFftWindow.

BLACKMAN = 5

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

BLACKMAN_HARRIS = 6

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

FLAT_TOP = 1

Measures single-tone amplitudes accurately.

GAUSSIAN = 4

Provides a balance of spectral leakage, frequency resolution, and amplitude attenuation. This windowing is useful for time-frequency analysis.

HAMMING = 3

Analyzes closely-spaced sine waves.

HANNING = 2

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

KAISER_BESSEL = 7

Separates two tones with frequencies close to each other but with widely-differing amplitudes.

NONE = 0

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

class nirfmxspecan.enums.SpurMeasurementStatus(value)

Bases: Enum

SpurMeasurementStatus.

FAIL = 0

A detected spur in the range is greater than the value of the RANGE_SPUR_ABSOLUTE_LIMIT attribute.

PASS = 1

All detected spurs in the range are lower than the value of the Spur Results Spur Abs Limit attribute.

class nirfmxspecan.enums.SpurRangeDetectorType(value)

Bases: Enum

SpurRangeDetectorType.

AVERAGE_LOG = 7

The average log of all the samples in the bucket is detected.

AVERAGE_RMS = 5

The average RMS of all the samples in the bucket is detected.

AVERAGE_VOLTAGE = 6

The average voltage of all the samples in the bucket is detected.

NEGATIVE_PEAK = 4

The minimum value of the samples in the bucket is detected.

NONE = 0

The detector is disabled.

NORMAL = 2

The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.

PEAK = 3

The maximum value of the samples in the bucket is detected.

SAMPLE = 1

The middle sample in the bucket is detected.

class nirfmxspecan.enums.SpurRangeEnabled(value)

Bases: Enum

SpurRangeEnabled.

FALSE = 0

Disables the acquisition of the frequency range.

TRUE = 1

Enables measurement of Spurs in the frequency range.

class nirfmxspecan.enums.SpurRangeStatus(value)

Bases: Enum

SpurRangeStatus.

FAIL = 0

The amplitude of the detected spurs is greater than the value of the RANGE_SPUR_ABSOLUTE_LIMIT attribute.

PASS = 1

The amplitude of the detected spurs is lower than the value of the Spur Results Spur Abs Limit attribute.

class nirfmxspecan.enums.SpurRangeVbwFilterAutoBandwidth(value)

Bases: Enum

SpurRangeVbwFilterAutoBandwidth.

FALSE = 0

Specify the video bandwidth in the RANGE_VBW_FILTER_BANDWIDTH attribute. The RANGE_VBW_FILTER_VBW_TO_RBW_RATIO attribute is disregarded in this mode.

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 RANGE_RBW_FILTER_BANDWIDTH attribute and the RBW_FILTER_BANDWIDTH attribute. The value of the RANGE_VBW_FILTER_BANDWIDTH attribute is disregarded in this mode.

class nirfmxspecan.enums.SpurRbwAutoBandwidth(value)

Bases: Enum

SpurRbwAutoBandwidth.

FALSE = 0

The measurement uses the RBW that you specify in the RANGE_RBW_FILTER_BANDWIDTH attribute.

TRUE = 1

The measurement computes the RBW.

class nirfmxspecan.enums.SpurRbwFilterBandwidthDefinition(value)

Bases: Enum

SpurRbwFilterBandwidthDefinition.

BANDWIDTH_DEFINITION_3DB = 0

Defines the RBW in terms of the 3dB bandwidth of the RBW filter. When you set the RANGE_RBW_FILTER_TYPE attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the FFT_WINDOW attribute.

BIN_WIDTH = 2

Defines the RBW in terms of the spectrum bin width computed using FFT when you set the Spur Range RBW Filter Type attribute to FFT Based.

ENBW = 3

Defines the RBW in terms of the ENBW bandwidth of the RBW filter. When you set the Spur RBW Filter Type attribute to FFT Based, RBW is the ENBW bandwidth of the window specified by the Spur FFT Window attribute.

class nirfmxspecan.enums.SpurRbwFilterType(value)

Bases: Enum

SpurRbwFilterType.

FFT_BASED = 0

No RBW filtering is performed.

FLAT = 2

An RBW filter with a flat response is applied.

GAUSSIAN = 1

An RBW filter with a Gaussian response is applied.

class nirfmxspecan.enums.SpurSweepTimeAuto(value)

Bases: Enum

SpurSweepTimeAuto.

FALSE = 0

The measurement uses the sweep time that you specify in the RANGE_SWEEP_TIME_INTERVAL attribute.

TRUE = 1

The measurement calculates the sweep time based on the value of the RANGE_RBW_FILTER_BANDWIDTH attribute.

class nirfmxspecan.enums.TriggerMinimumQuietTimeMode(value)

Bases: Enum

TriggerMinimumQuietTimeMode.

AUTO = 1

The measurement computes the minimum quiet time used for triggering.

MANUAL = 0

The minimum quiet time for triggering is the value of the TRIGGER_MINIMUM_QUIET_TIME_DURATION attribute.

class nirfmxspecan.enums.TriggerType(value)

Bases: Enum

TriggerType.

DIGITAL_EDGE = 1

The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified using the DIGITAL_EDGE_TRIGGER_SOURCE attribute.

IQ_POWER_EDGE = 2

The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), which is configured using the IQ_POWER_EDGE_TRIGGER_SLOPE attribute.

NONE = 0

No Reference Trigger is configured.

SOFTWARE = 3

The Reference Trigger is not asserted until a software trigger occurs.

class nirfmxspecan.enums.TxpAveragingEnabled(value)

Bases: Enum

TxpAveragingEnabled.

FALSE = 0

The measurement is performed on a single acquisition.

TRUE = 1

The TXP measurement uses the AVERAGING_COUNT attribute as the number of acquisitions over which the TXP measurement is averaged.

class nirfmxspecan.enums.TxpAveragingType(value)

Bases: Enum

TxpAveragingType.

LOG = 1

The power trace is averaged in a logarithmic scale.

MAXIMUM = 3

The maximum instantaneous power in the power trace is retained from one acquisition to the next.

MINIMUM = 4

The minimum instantaneous power in the power trace is retained from one acquisition to the next.

RMS = 0

The power trace is linearly averaged.

SCALAR = 2

The square root of the power trace is averaged.

class nirfmxspecan.enums.TxpRbwFilterType(value)

Bases: Enum

TxpRbwFilterType.

FLAT = 2

The RBW filter has a flat response.

GAUSSIAN = 1

The RBW filter has a Gaussian response.

NONE = 5

The measurement does not use any RBW filtering.

RRC = 6

The RRC filter with the roll-off specified by the RBW_FILTER_ALPHA attribute is used as the RBW filter.

class nirfmxspecan.enums.TxpThresholdEnabled(value)

Bases: Enum

TxpThresholdEnabled.

FALSE = 0

All the acquired samples are considered for the TXP measurement.

TRUE = 1

The samples above the threshold level specified in the THRESHOLD_LEVEL attribute are considered for the TXP measurement.

class nirfmxspecan.enums.TxpThresholdType(value)

Bases: Enum

TxpThresholdType.

ABSOLUTE = 1

The threshold is the absolute power, in dBm.

RELATIVE = 0

The threshold is relative to the peak power of the acquired samples.

class nirfmxspecan.enums.TxpVbwFilterAutoBandwidth(value)

Bases: Enum

TxpVbwFilterAutoBandwidth.

FALSE = 0

Specify the video bandwidth in the VBW_FILTER_BANDWIDTH attribute. The VBW_FILTER_VBW_TO_RBW_RATIO attribute is disregarded in this mode.

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 VBW_FILTER_VBW_TO_RBW_RATIO attribute and the RBW_FILTER_BANDWIDTH attribute. The value of the VBW_FILTER_BANDWIDTH attribute is disregarded in this mode.