Enums

enums.py - Contains enum classes.

class nirfmxinstr.enums.AdvanceTriggerType(value)[source]

Bases: Enum

AdvanceTriggerType.

DIGITAL_EDGE = 1: The advance trigger is not asserted until a digital edge is detected. The source of the digital edge is specified with the ADVANCE_TRIGGER_DIGITAL_EDGE_SOURCE attribute.

NONE = 0: No advance trigger is configured.

SOFTWARE = 3: The advance trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the RFmxInstr Send Software Edge Trigger method.

class nirfmxinstr.enums.ChannelCoupling(value)[source]

Bases: Enum

ChannelCoupling.

AC_COUPLED = 0: Specifies that the RF input channel is AC-coupled. For low frequencies (<10 MHz), accuracy decreases because RFmxInstr does not calibrate the configuration.

DC_COUPLED = 1: Specifies that the RF input channel is DC-coupled. The RFmx driver enforces a minimum RF attenuation for device protection.

class nirfmxinstr.enums.CleanerSpectrum(value)[source]

Bases: Enum

CleanerSpectrum.

DISABLED = 0: Disable this attribute to get faster measurement speed.

ENABLED = 1: Enable this attribute to get the lowest noise floor and avoid digitizer spurs.

class nirfmxinstr.enums.DigitizerDitherEnabled(value)[source]

Bases: Enum

DigitizerDitherEnabled.

DISABLED = 0: Disables the attribute.

ENABLED = 1: Enables the attribute.

class nirfmxinstr.enums.DownconverterPreselectorEnabled(value)[source]

Bases: Enum

DownconverterPreselectorEnabled.

DISABLED = 0: Disables the preselector.

ENABLED = 1: The preselector is automatically enabled when it is in the signal path and is automatically disabled when it is not in the signal path. Use the PRESELECTOR_PRESENT attribute to determine if the downconverter has a preselector.

class nirfmxinstr.enums.ExportSignalSource(value)[source]

Bases: Enum

ExportSignalSource.

ADVANCE_TRIGGER = 2: Advance trigger event is sourced.

DONE_EVENT = 7: Done Event is sourced.

END_OF_RECORD_EVENT = 6: End Of Record Event is sourced.

READY_FOR_ADVANCE_EVENT = 5: Ready For Advance Event is sourced.

READY_FOR_REFERENCE_EVENT = 4: Ready For Reference Event is sourced.

READY_FOR_START_EVENT = 3: Ready For Start Event is sourced.

REFERENCE_CLOCK = 8: Reference Clock is sourced.

REFERENCE_TRIGGER = 1: Reference trigger event is sourced.

START_TRIGGER = 0: Start trigger is sourced.

class nirfmxinstr.enums.FrequencySettlingUnits(value)[source]

Bases: Enum

FrequencySettlingUnits.

PPM = 0: Specifies the frequency settling in parts per million (ppm).

SECONDS_AFTER_IO = 2: Specifies the frequency settling in time after I/O (seconds).

SECONDS_AFTER_LOCK = 1: Specifies the frequency settling in time after lock (seconds).

class nirfmxinstr.enums.InputIsolationEnabled(value)[source]

Bases: Enum

InputIsolationEnabled.

DISABLED = 0: Indicates that the attribute is disabled.

ENABLED = 1: Indicates that the attribute is enabled.

class nirfmxinstr.enums.LO2ExportEnabled(value)[source]

Bases: Enum

LO2ExportEnabled.

DISABLED = 0: Disables the LO2 OUT terminals.

ENABLED = 1: Enables the LO2 OUT terminals.

class nirfmxinstr.enums.LOInjectionSide(value)[source]

Bases: Enum

LOInjectionSide.

HIGH_SIDE = 0: Configures the LO signal that the device generates at a frequency higher than the RF signal. This LO frequency is given by the following formula: *f_LO= f_RF+ f_IF*

LOW_SIDE = 1: Configures the LO signal that the device generates at a frequency lower than the RF signal. This LO frequency is given by the following formula: *f_LO= f_RF– f_IF*

class nirfmxinstr.enums.LOLeakageAvoidanceEnabled(value)[source]

Bases: Enum

LOLeakageAvoidanceEnabled.

FALSE = 0: RFmx does not modify the Downconverter Frequency Offset attribute.

TRUE = 1: RFmx calculates the required LO offset based on the measurement configuration and appropriately sets the Downconverter Frequency Offset attribute.

class nirfmxinstr.enums.LOPllFractionalMode(value)[source]

Bases: Enum

LOPllFractionalMode.

DISABLED = 0: Indicates that the attribute is disabled.

ENABLED = 1: Indicates that the attribute is enabled.

class nirfmxinstr.enums.LOSharingMode(value)[source]

Bases: Enum

LOSharingMode.

DISABLED = 0: LO Sharing is disabled.

EXTERNAL_DAISY_CHAIN = 4: The LO connection configuration is configured as External Daisy Chain.

EXTERNAL_STAR = 3: The LO connection configuration is configured as External Star.

SPLITTER_AND_DAISY_CHAIN = 5

The LO connection configuration is configured as Splitter and Daisy Chain.

With this option, the only allowed value for the NUMBER_OF_LO_SHARING_GROUPS attribute is 1.

class nirfmxinstr.enums.LinearInterpolationFormat(value)[source]

Bases: Enum

LinearInterpolationFormat.

MAGNITUDE_AND_PHASE = 1: Results in a linear interpolation.

MAGNITUDE_DB_AND_PHASE = 2: Results in a linear interpolation.

REAL_AND_IMAGINARY = 0: Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion.

class nirfmxinstr.enums.LoadOptions(value)[source]

Bases: Enum

LoadOptions.

SKIP_NONE = 0: RFmx loads all the configurations to the session.

SKIP_RFINSTR = 1: RFmx skips loading the RFmxInstr configurations to the session.

class nirfmxinstr.enums.MechanicalAttenuationAuto(value)[source]

Bases: Enum

MechanicalAttenuationAuto.

FALSE = 0: Specifies that the RFmx driver uses the value configured in the MECHANICAL_ATTENUATION_VALUE attribute.

TRUE = 1: Specifies that the measurement computes the mechanical attenuation.

class nirfmxinstr.enums.OptimizePathForSignalBandwidth(value)[source]

Bases: Enum

OptimizePathForSignalBandwidth.

AUTOMATIC = 2: Automatically enables the optimized path based on other configurations.

DISABLED = 0: Disables the optimized path for signal bandwidth.

ENABLED = 1: Enables the optimized path for signal bandwidth.

class nirfmxinstr.enums.OspDelayEnabled(value)[source]

Bases: Enum

OspDelayEnabled.

DISABLED = 0: Disables the attribute.

ENABLED = 1: Enables the attribute.

class nirfmxinstr.enums.OverflowErrorReporting(value)[source]

Bases: Enum

OverflowErrorReporting.

DISABLED = 1: RFmx does not return an error or a warning when an ADC or OSP overflow occurs.

WARNING = 0: RFmx returns a warning when an ADC or an onboard signal processing (OSP) overflow occurs.

class nirfmxinstr.enums.Personalities(value)[source]

Bases: IntFlag

Personalities.

ALL = 2147483647: Specifies all the personalities.

BT = 1024: Specifies the BT personality.

CDMA2K = 32: Specifies the CDMA2k personality.

DEMOD = 2: Specifies the Demod personality.

EVDO = 128: Specifies the EV-DO personality.

GSM = 8: Specifies the GSM personality.

LTE = 4: Specifies the LTE personality.

NONE = 0: Specifies that a signal does not exist.

NR = 256: Specifies the NR personality.

PULSE = 2048: Specifies the Pulse personality.

SPECAN = 1: Specifies the SpecAn personality.

TDSCDMA = 64: Specifies the TD-SCDMA personality.

UWB = 8192: Specifies the UWB personality.

VNA = 4096: Specifies the VNA personality.

WCDMA = 16: Specifies the WCDMA personality.

WLAN = 512: Specifies the WLAN personality.

class nirfmxinstr.enums.PreampEnabled(value)[source]

Bases: Enum

PreampEnabled.

AUTOMATIC = 3

Automatically enables the RF preamplifier based on the value of the reference level.

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

DISABLED = 0

Disables the RF preamplifier.

Supported Devices: PXIe-5663/5663E/5665/5668

ENABLED = 1

Enables the RF preamplifier when it is in the signal path and disables it when it is not in the signal path. Only devices with an RF preamplifier on the downconverter and an RF preselector support this option. Use the RF_PREAMP_PRESENT attribute to determine whether the downconverter has a preamplifier.

Supported Devices: PXIe-5663/5663E/5665/5668

class nirfmxinstr.enums.RFAttenuationAuto(value)[source]

Bases: Enum

RFAttenuationAuto.

FALSE = 0: Specifies that the RFmx driver uses the value configured using RF_ATTENUATION_VALUE attribute.

TRUE = 1: Specifies that the RFmx driver computes the RF attenuation.

class nirfmxinstr.enums.RecommendedAcquisitionType(value)[source]

Bases: Enum

RecommendedAcquisitionType.

IQ = 0: Indicates that the recommended acquisition type is I/Q. Use the Analyze (IQ) method to perform the measurement.

IQ_OR_SPECTRAL = 2: Indicates that the recommended acquisition type is I/Q or Spectral. Use either Analyze (IQ) or Analyze (Spectrum) method to perform the measurement.

SPECTRAL = 1: Indicates that the recommended acquisition type is Spectral. Use Analyze (Spectrum) method to perform the measurement.

class nirfmxinstr.enums.RecommendedSpectralFftWindow(value)[source]

Bases: Enum

RecommendedSpectralFftWindow.

BLACKMAN = 5: Indicates a Blackman FFT window type.

BLACKMAN_HARRIS = 6: Indicates a Blackman-Harris FFT window type.

FLAT_TOP = 1: Indicates a Flat Top FFT window type.

GAUSSIAN = 4: Indicates a Gaussian FFT window type.

HAMMING = 3: Indicates a Hamming FFT window type.

HANNING = 2: Indicates a Hanning FFT window type.

KAISER_BESSEL = 7: Indicates a Kaiser-Bessel FFT window type.

NONE = 0: Indicates that the measurement does not use FFT windowing to reduce spectral leakage.

class nirfmxinstr.enums.SParameterOrientation(value)[source]

Bases: Enum

SParameterOrientation.

PORT1_TOWARDS_DUT = 0: Port 1 of the S2P is oriented towards the DUT.

PORT2_TOWARDS_DUT = 1: Port 2 of the S2P is oriented towards the DUT.

class nirfmxinstr.enums.SParameterType(value)[source]

Bases: Enum

SParameterType.

SCALAR = 1: De-embeds the measurement using the gain term.

VECTOR = 2: De-embeds the measurement using the gain term and the reflection term.

class nirfmxinstr.enums.SelfCalibrateSteps(value)[source]

Bases: IntFlag

SelfCalibrateSteps.

AMPLITUDE_ACCURACY = 32: Selects/Omits the Amplitude Accuracy self-calibration step.

DC_OFFSET = 512: Selects/Omits the DC Offset self-calibration step.

DIGITIZER_SELF_CAL = 8: Selects/Omits the Digitizer Self Cal self-calibration step.

GAIN_REFERENCE = 2: Selects/Omits the Gain Reference self-calibration step.

IF_FLATNESS = 4: Selects/Omits the IF Flatness self-calibration step.

IMAGE_SUPPRESSION = 128: Selects/Omits the Image Suppression self-calibration step.

LO_SELF_CAL = 16: Selects/Omits the LO Self Cal self-calibration step.

NONE = 0: A value of None specifies that all calibration steps are performed.

PRESELECTOR_ALIGNMENT = 1: Selects/Omits the Preselector Alignment self-calibration step.

RESIDUAL_LO_POWER = 64: Selects/Omits the Residual LO Power self-calibration step.

SYNTHESIZER_ALIGNMENT = 256: Selects/Omits the Synthesizer Alignment self-calibration step.

class nirfmxinstr.enums.SelfCalibrationValidityCheck(value)[source]

Bases: Enum

SelfCalibrationValidityCheck.

ENABLED = 1: Indicates that RFmx checks whether device self-calibration data is valid and reports a warning from the RFmx Commit and RFmx Initiate methods when the data is invalid.

OFF = 0: Indicates that RFmx does not check whether device self-calibration data is valid.

class nirfmxinstr.enums.StartTriggerDigitalEdge(value)[source]

Bases: Enum

StartTriggerDigitalEdge.

FALLING = 1: The trigger asserts on the falling edge of the signal.

RISING = 0: The trigger asserts on the rising edge of the signal.

class nirfmxinstr.enums.StartTriggerType(value)[source]

Bases: Enum

StartTriggerType.

DIGITAL_EDGE = 1: The start trigger is not asserted until a digital edge is detected. The source of the digital edge is specified by the START_TRIGGER_DIGITAL_EDGE_SOURCE attribute.

NONE = 0: No start trigger is configured.

SOFTWARE = 3: The start trigger is not asserted until a software trigger occurs. You can assert the software trigger by calling the RFmxInstr Send Software Edge Trigger method.

class nirfmxinstr.enums.TuningSpeed(value)[source]

Bases: Enum

TuningSpeed.

FAST = 2

Adjusts the YIG main coil on the LO for an overdamped response. Setting this attribute to Fast allows the frequency to settle significantly faster for some frequency transitions at the expense of increased phase noise.

PXIe-5663/5663E/5644/5645/5646: Specifies that the RF downconverter module uses a wide loop bandwidth.

Type:: PXIe-5665/5668

MEDIUM = 1: Specifies that the RF downconverter module uses a medium loop bandwidth. This value is not supported on PXIe-5663/5663E/5665/5668 devices.

NORMAL = 0

Adjusts the YIG main coil on the LO for an underdamped response.

PXIe-5663/5663E/5644/5645/5646: Specifies that the RF downconverter module uses a narrow loop bandwidth.

Type:: PXIe-5665/5668