Enums

enums.py - Contains enum classes.

class nirfmxvna.enums.AutoIFBandwidthScalingEnabled(value)[source]

Bases: Enum

AutoIFBandwidthScalingEnabled.

FALSE = 0

Disables automatic IF Bandwidth scaling that compensates for the increased VNA receiver noise at low frequencies.

TRUE = 1

Enables automatic IF Bandwidth scaling that compensates for the increased VNA receiver noise at low frequencies.

class nirfmxvna.enums.AveragingEnabled(value)[source]

Bases: Enum

AveragingEnabled.

FALSE = 0

Disables measurement averaging.

TRUE = 1

Enables measurement averaging. You can set number of times each measurement is repeated and averaged-over using the AVERAGING_COUNT attribute.

class nirfmxvna.enums.CalErrorTerm(value)[source]

Bases: Enum

CalErrorTerm.

ALPHA = 6

alpha measured at Measurement Port (Source Port ignored).

BETA = 7

beta measured at Measurement Port (Source Port ignored).

DELTA = 9

delta measured at Measurement Port (Source Port ignored).

DIRECTIVITY = 0

Directivity measured at Measurement Port (Source Port ignored).

GAMMA = 8

gamma measured at Measurement Port (Source Port ignored).

K = 5

K measured at Measurement Port (Source Port ignored).

LOAD_MATCH = 4

Load Match measured at Measurement Port with Source Port being the source port.

REFLECTION_TRACKING = 2

Reflection Tracking measured at Measurement Port (Source Port ignored).

SOURCE_MATCH = 1

Source Match measured at Measurement Port (Source Port ignored).

SWITCH_TERM = 10

Switch term measured at Measurement Port (Source Port ignored).

TRANSMISSION_TRACKING = 3

Transmission Tracking measured at Measurement Port with Source Port being the source port.

class nirfmxvna.enums.CalFrequencyGrid(value)[source]

Bases: Enum

CalFrequencyGrid.

ALPHA = 6

alpha measured at Measurement Port (Source Port ignored).

BETA = 7

beta measured at Measurement Port (Source Port ignored).

DELTA = 9

delta measured at Measurement Port (Source Port ignored).

DIRECTIVITY = 0

Directivity measured at Measurement Port (Source Port ignored).

GAMMA = 8

gamma measured at Measurement Port (Source Port ignored).

K = 5

K measured at Measurement Port (Source Port ignored).

LOAD_MATCH = 4

Load Match measured at Measurement Port with Source Port being the source port.

REFLECTION_TRACKING = 2

Reflection Tracking measured at Measurement Port (Source Port ignored).

SOURCE_MATCH = 1

Source Match measured at Measurement Port (Source Port ignored).

SWITCH_TERM = 10

Switch term measured at Measurement Port (Source Port ignored).

TRANSMISSION_TRACKING = 3

Transmission Tracking measured at Measurement Port with Source Port being the source port.

class nirfmxvna.enums.CalkitManagerCalkitCalibrationElementReflectModelSParameterAvailability(value)[source]

Bases: Enum

CalkitManagerCalkitCalibrationElementReflectModelSParameterAvailability.

ESTIMATE = 0

S-Parameter is estimated.

KNOWN = 1

S-Parameter is known.

class nirfmxvna.enums.CalkitManagerCalkitCalibrationElementReflectModelType(value)[source]

Bases: Enum

CalkitManagerCalkitCalibrationElementReflectModelType.

LOAD = 2

Reflect model is Load.

REFLECT_OPEN = 0

Reflect model is Open.

REFLECT_SHORT = 1

Reflect model is Short.

class nirfmxvna.enums.CalkitManagerCalkitCalibrationElementSParameterAvailability(value)[source]

Bases: Enum

CalkitManagerCalkitCalibrationElementSParameterAvailability.

ESTIMATE = 0

S-Parameter is estimated.

KNOWN = 1

S-Parameter is known.

class nirfmxvna.enums.CalkitManagerCalkitCalibrationElementSParameterDefinition(value)[source]

Bases: Enum

CalkitManagerCalkitCalibrationElementSParameterDefinition.

DELAY_MODEL = 2

S-Parameter is defined using delay model.

REFLECT_MODEL = 0

S-Parameter is defined using reflect model.

SPARAMETER = 1

S-Parameter is defined using S-Parameter data.

UNKNOWN = 3

S-Parameter definition is unknown.

class nirfmxvna.enums.CalkitManagerCalkitCalibrationElementType(value)[source]

Bases: Enum

CalkitManagerCalkitCalibrationElementType.

LINE = 4

Specifies Line calibration element type.

LOAD = 0

Specifies Load calibration element type.

OPEN = 1

Specifies Open calibration element type.

REFLECT = 5

Specifies Reflect calibration element type.

SHORT = 2

Specifies Short calibration element type.

TERMINATION = 6

Specifies Termination calibration element type.

THRU = 3

Specifies Thru calibration element type.

class nirfmxvna.enums.CalkitManagerCalkitConnectorGender(value)[source]

Bases: Enum

CalkitManagerCalkitConnectorGender.

FEMALE = 1

Specifies female connector gender.

MALE = 0

Specifies male connector gender.

NO_GENDER = 2

Specifies no connector gender.

class nirfmxvna.enums.CalkitManagerCalkitTrlReferencePlane(value)[source]

Bases: Enum

CalkitManagerCalkitTrlReferencePlane.

REFLECT = 1

Specifies Reflect as the reference plane.

THRU = 0

Specifies Thru as the reference plane.

class nirfmxvna.enums.CorrectionCalibrationCalkitType(value)[source]

Bases: Enum

CorrectionCalibrationCalkitType.

ELECTRONIC = 0

Perform calibration using an electronic calkit module. Supported Electronic Calkit Modules: NI CAL-5501.

MECHANICAL = 1

Perform calibration using discrete cal standards from a mechanical calkit.

class nirfmxvna.enums.CorrectionCalibrationMethod(value)[source]

Bases: Enum

CorrectionCalibrationMethod.

SOL = 0

Full 1-port calibration using atleast three distinct reflection standards, typically named Short, Open and Load.

SOLT = 1

Full 2-port calibration by performing two SOL calibrations on the two ports using atleast three distinct reflection standards, and a Thru cal using a transmission standard connecting the two ports. Use CORRECTION_CALIBRATION_THRU_METHOD attribute to select a suitable Thru cal procedure.

TRL = 2

Full 2-port calibration using a Thru, at least one Line, and one Reflect standard (Thru-Reflect-Line). The Thru standard can be an flush Thru or can have non-zero length (LRL, Line-Reflect-Line). The Reflect standard has to be identical for both ports. If multiple lines with different lengths are defined, the measurement automatically splits the measurement frequency range into segments and picks the line standard with appropriate length for each segment. The reference impedance of the calibration is the characteristic impedance of the Line(s).

class nirfmxvna.enums.CorrectionCalibrationThruMethod(value)[source]

Bases: Enum

CorrectionCalibrationThruMethod.

AUTO = 0

Measurement selects the appropriate Thru calibration method based on the value you specified for CORRECTION_CALIBRATION_CALKIT_TYPE attribute. If CORRECTION_CALIBRATION_CALKIT_TYPE is Electronic, then Delay Thru Using Defined Thru is selected. If CORRECTION_CALIBRATION_CALKIT_TYPE is Mechanical, then Undefined Thru is selected.

DEFINED_THRU = 1

The Thru definition from calkit definition is used based on the value you specified for CORRECTION_CALIBRATION_CALKIT_TYPE attribute. If CORRECTION_CALIBRATION_CALKIT_TYPE is Electronic, the Thru definition from the electronic calkit EPROM is used. If CORRECTION_CALIBRATION_CALKIT_TYPE is Mechanical, the Thru definition from the calkit definition file is used.

FLUSH_THRU = 2

Indicates a direct connection of the test ports when CORRECTION_CALIBRATION_CALKIT_TYPE is Mechanical. The measured Thru is treated as flush Thru ignoring the Thru definition from the Calkit file. This method is not supported when CORRECTION_CALIBRATION_CALKIT_TYPE is Electronic.

UNDEFINED_THRU = 3

Indicates connection of a Thru without a stored definition when CORRECTION_CALIBRATION_CALKIT_TYPE is Mechanical. The measured Thru is treated as unknown Thru ignoring the Thru definition from the Calkit file. If a delay is configured, the delay will be utilized for the calibration. This method is not supported when CORRECTION_CALIBRATION_CALKIT_TYPE is Electronic.

VCAL_THRU_AS_UNKNOWN_THRU = 5

The Thru from the electronical Calkit is used for Thru measurement during calibration. The Thru definirion from vCal EPROM is used as a phase reference for the Thru characterization during calibration. This method is not supported when Calkit Type is Mechanical.

class nirfmxvna.enums.CorrectionEnabled(value)[source]

Bases: Enum

CorrectionEnabled.

FALSE = 0

The measurement disables error corection.

TRUE = 1

The measurement enables error correction.

class nirfmxvna.enums.CorrectionInterpolationEnabled(value)[source]

Bases: Enum

CorrectionInterpolationEnabled.

FALSE = 0

The measurement disables interpolation of error terms for error correction.

TRUE = 1

The measurement enables interpolation of error terms for error correction.

class nirfmxvna.enums.CorrectionPortExtensionAutoFrequencyMode(value)[source]

Bases: Enum

CorrectionPortExtensionAutoFrequencyMode.

SWEEP = 0

Sets the frequency mode to Sweep. Configured sweep range is used to determine the phase and loss values.

USER = 1

Sets the frequency mode to User Span. User-defined span is used to determine the phase and loss values.

class nirfmxvna.enums.CorrectionPortExtensionAutoLossEnabled(value)[source]

Bases: Enum

CorrectionPortExtensionAutoLossEnabled.

FALSE = 0

Disable the loss estimation in automatic port extension.

TRUE = 1

Enable the loss estimation in automatic port extension.

class nirfmxvna.enums.CorrectionPortExtensionAutoRegularizationEnabled(value)[source]

Bases: Enum

CorrectionPortExtensionAutoRegularizationEnabled.

FALSE = 0

Disable the regularization of the compensated trace in automatic port extension.

TRUE = 1

Enable the regularization of the compensated trace in automatic port extension.

class nirfmxvna.enums.CorrectionPortExtensionAutoStandard(value)[source]

Bases: Enum

CorrectionPortExtensionAutoStandard.

OPEN = 0

Uses Open standard for port extension.

SHORT = 1

Uses Short standard for port extension.

class nirfmxvna.enums.CorrectionPortExtensionDCLossEnabled(value)[source]

Bases: Enum

CorrectionPortExtensionDCLossEnabled.

FALSE = 0

The measurement disables the compensation of DC Loss of the port extension.

TRUE = 1

The measurement compensates for the DC loss based on the value of Port Extension DC Loss (dB) specified by you.

class nirfmxvna.enums.CorrectionPortExtensionDelayDomain(value)[source]

Bases: Enum

CorrectionPortExtensionDelayDomain.

DELAY = 0

The port extension is specified in terms of its electrical delay.

DISTANCE = 1

The port extension is specified in terms of its physical length.

class nirfmxvna.enums.CorrectionPortExtensionDistanceUnit(value)[source]

Bases: Enum

CorrectionPortExtensionDistanceUnit.

FEET = 1

The port extension physical length is expressed in feet.

INCHES = 2

The port extension physical length is expressed in inches.

METERS = 0

The port extension physical length is expressed in meters.

class nirfmxvna.enums.CorrectionPortExtensionEnabled(value)[source]

Bases: Enum

CorrectionPortExtensionEnabled.

FALSE = 0

The measurement disables port extension.

TRUE = 1

The measurement enables port extension.

class nirfmxvna.enums.CorrectionPortExtensionLoss1Enabled(value)[source]

Bases: Enum

CorrectionPortExtensionLoss1Enabled.

FALSE = 0

The measurement disables the compensation of Loss1 of the port extension.

TRUE = 1

The measurement compensates for the Loss1 based on the configured value of Port Extension Loss1 (dB).

class nirfmxvna.enums.CorrectionPortExtensionLoss2Enabled(value)[source]

Bases: Enum

CorrectionPortExtensionLoss2Enabled.

FALSE = 0

The measurement disables the compensation of Loss2 of the port extension.

TRUE = 1

The measurement compensates for the Loss2 based on the configured value of Port Extension Loss2 (dB).

class nirfmxvna.enums.CorrectionPortSubsetEnabled(value)[source]

Bases: Enum

CorrectionPortSubsetEnabled.

FALSE = 0

The measurement disables port-subsetting for error correction.

TRUE = 1

The measurement enabes port-subsetting for error correction.

class nirfmxvna.enums.DigitalEdgeTriggerEdge(value)[source]

Bases: Enum

DigitalEdgeTriggerEdge.

FALLING_EDGE = 1

The trigger asserts on the falling edge of the digital-signal.

RISING_EDGE = 0

The trigger asserts on the rising edge of the digital-signal.

class nirfmxvna.enums.IQCorrectionState(value)[source]

Bases: Enum

IQCorrectionState.

CORRECTED = 1

Error correction is applied without interpolation using the error terms from the calset.

INTERPOLATED = 2

Error correction is applied with error terms for at least one sweep point interpolated from the calset error terms.

NONE = 0

Error correction is not applied.

SETTINGS_MODIFIED = 3

Settings during the measurment differ from those used during calibration.

class nirfmxvna.enums.IndexEventLevel(value)[source]

Bases: Enum

IndexEventLevel.

ACTIVE_HIGH = 0

Event level is HIGH when analyzer has completed all the acquisitions for the signal.

ACTIVE_LOW = 1

Event level is LOW when analyzer has completed all the acquisitions for the signal.

class nirfmxvna.enums.LimitedConfigurationChange(value)[source]

Bases: Enum

LimitedConfigurationChange.

DISABLED = 0

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

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.

class nirfmxvna.enums.MarkerMode(value)[source]

Bases: Enum

MarkerMode.

CONTINUOUS = 0

Marker is updated continuously during sweep.

DISCRETE = 1

Marker is updated only at discrete frequency points.

class nirfmxvna.enums.MarkerPeakSearchExcursionEnabled(value)[source]

Bases: Enum

MarkerPeakSearchExcursionEnabled.

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 nirfmxvna.enums.MarkerPeakSearchThresholdEnabled(value)[source]

Bases: Enum

MarkerPeakSearchThresholdEnabled.

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 nirfmxvna.enums.MarkerSearchMode(value)[source]

Bases: Enum

MarkerSearchMode.

MAX = 1

Searches for the maximum value on the trace.

MIN = 2

Searches for the minimum value on the trace.

NEXT_LEFT_PEAK = 5

Searches for the next peak to the left on the trace.

NEXT_LEFT_TARGET = 8

Searches for the next target to the left on the trace.

NEXT_PEAK = 4

Searches for the next peak on the trace.

NEXT_RIGHT_PEAK = 6

Searches for the next peak to the right on the trace.

NEXT_RIGHT_TARGET = 9

Searches for the next target to the right on the trace.

NONE = 0

No search is performed.

PEAK = 3

Searches for the peak on the trace.

TARGET = 7

Searches for the target value on the trace.

class nirfmxvna.enums.MarkerType(value)[source]

Bases: Enum

MarkerType.

DELTA = 2

The marker is enabled as a delta marker.

FIXED = 3

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 nirfmxvna.enums.MeasurementTypes(value)[source]

Bases: IntFlag

MeasurementTypes.

IQ = 4

Enables IQ measurement.

SPARAMS = 1

Enables S-Parameter measurement.

WAVES = 2

Enables Wave measurement.

class nirfmxvna.enums.PulseAcquisitionAuto(value)[source]

Bases: Enum

PulseAcquisitionAuto.

FALSE = 0

The PULSE_ACQUISITION_DELAY and PULSE_ACQUISITION_WIDTH attributes are not automatically set by the measurement. The values that you set for these attributes are used by the measurement.

TRUE = 1

The measurement uses the PULSE_MODULATOR_WIDTH attribute to automatically set appropriate values for PULSE_ACQUISITION_DELAY and PULSE_ACQUISITION_WIDTH attributes.

Pulse Acquisition Delay is set as the sum of Pulse Modulator Delay and approximately 20% of the Pulse Modulator Width, and Pulse Acquisition Width is set to approximately 75% of the Pulse Modulator Width.

class nirfmxvna.enums.PulseGeneratorEnabled(value)[source]

Bases: Enum

PulseGeneratorEnabled.

FALSE = 0

Disables the selected pulse generator.

TRUE = 1

Enables the selected pulse generator.

class nirfmxvna.enums.PulseModeEnabled(value)[source]

Bases: Enum

PulseModeEnabled.

FALSE = 0

Disables pulse mode operation. VNA pulse modulator and pulse generators are disabled.

TRUE = 1

Enables pulse mode operation.

class nirfmxvna.enums.PulseTriggerType(value)[source]

Bases: Enum

PulseTriggerType.

DIGITAL_EDGE = 1

Uses an external digital edge trigger as the pulse trigger.

NONE = 0

Based on the PULSE_PERIOD value that you set, the VNA creates an appropriate periodic pulse trigger internally. Pulse Trigger is used to control the timing of the RF pulse modulator. Additionally pulse trigger is used as timing reference for all the pulse generator digital signals that you enabled.

class nirfmxvna.enums.ReadyForTriggerEventLevel(value)[source]

Bases: Enum

ReadyForTriggerEventLevel.

ACTIVE_HIGH = 0

Event level is HIGH when analyzer is ready to receive trigger.

ACTIVE_LOW = 1

Event level is LOW when analyzer is ready to receive trigger.

class nirfmxvna.enums.RestoreConfiguration(value)[source]

Bases: Enum

RestoreConfiguration.

NONE = 0

Do not apply the stimulus settings from the calset.

STIMULUS = 1

Applies the stimulus settings from the calset.

class nirfmxvna.enums.SParameterOrientation(value)[source]

Bases: Enum

SParameterOrientation.

PORT1_TOWARDS_VNA = 0

Port 1 of the S2P is oriented towards the VNA.

PORT2_TOWARDS_VNA = 1

Port 2 of the S2P is oriented towards the VNA.

class nirfmxvna.enums.SParamsCorrectionState(value)[source]

Bases: Enum

SParamsCorrectionState.

CORRECTED = 1

Error correction is applied without interpolation using the error terms from the calset.

INTERPOLATED = 2

Error correction is applied with error terms for at least one sweep point interpolated from the calset error terms.

NONE = 0

Error correction is not applied.

SETTINGS_MODIFIED = 3

Settings during the measurment differ from those used during calibration.

class nirfmxvna.enums.SParamsFormat(value)[source]

Bases: Enum

SParamsFormat.

COMPLEX = 2

Sets the format of the selected S-Parameter as complex numbers in cartesian co-ordinates.

GROUP_DELAY = 7

Sets the format of the selected S-Parameter to Group Delay. Group delay represents the time it takes for the signal to pass through a device under test. The delay is expressed in seconds.

Group delay vs. frequency is derived from phase vs. frequency response. At a given frequency point, group delay is computed by selecting two nearby frequency points and taking the ratio of the phase difference to the frequency separation between them. The frequency separation between the two selected points is called the group delay aperture.

You can control the aperture by first configuring SPARAMS_GROUP_DELAY_APERTURE_MODE and once the mode is selected, you can set the aperture by configuring SPARAMS_GROUP_DELAY_APERTURE_POINTS, SPARAMS_GROUP_DELAY_APERTURE_PERCENTAGE or SPARAMS_GROUP_DELAY_APERTURE_FREQUENCY_SPAN.

For example, if the number of aperture points is equal to 3, then group delay at a nth frequency point is computed by selecting the (n-1)th frequency point and (n+1)th frequency point.

MAGNITUDE = 0

Sets the format of the selected S-Parameter to Magnitude. You can specify SPARAMS_MAGNITUDE_UNITS.

PHASE = 1

Sets the format of the selected S-Parameter to Phase. Phase values are expressed in degrees. Phase can be represented in various, mathematically equivalent ways such as phase wrapped between the range [-180, 180) degrees, or phase can be represented in an unwrapped manner. You can specify the phase representation by configuring SPARAMS_PHASE_TRACE_TYPE.

POLAR = 6

Sets the format of the selected S-Parameter as complex numbers in polar co-ordinates, where the radial axis (i.e., magnitude of the complex numbers) is always in linear scale and angular axis (phase) is represented in degrees and always wrapped between ±180 deg.

SMITH_ADMITTANCE = 5

Sets the format of the selected S-Parameter to Smith Admittance. S-Parameter values are transformed into admittance values. Admittance values are expressed in siemens. You can use these values to plot on an Inverted Smith Chart.

SMITH_IMPEDANCE = 4

Sets the format of the selected S-Parameter to Smith Impedance. S-Parameter values are transformed into impedence values. Impedence values are expressed in ohms. You can use these values to plot on a Smith Chart.

SWR = 3

Sets the format of the selected S-Parameter to Standing Wave Ratio (SWR). SWR is a unitless quantity.

class nirfmxvna.enums.SParamsGroupDelayApertureMode(value)[source]

Bases: Enum

SParamsGroupDelayApertureMode.

FREQUENCY_SPAN = 2

Sets group delay aperture to Frequency Span. You can specify the aperture in terms of the frequency separation by configuring SPARAMS_GROUP_DELAY_APERTURE_PERCENTAGE.

PERCENTAGE = 1

Sets group delay aperture mode to Percentage. You can specify the aperture in terms of the frequency separation expressed in percentage by configuring SPARAMS_GROUP_DELAY_APERTURE_PERCENTAGE.

POINTS = 0

Sets group delay aperture mode to Points. You can specify the aperture in terms of the number of frequency points by configuring SPARAMS_GROUP_DELAY_APERTURE_POINTS.

class nirfmxvna.enums.SParamsMagnitudeUnits(value)[source]

Bases: Enum

SParamsMagnitudeUnits.

DB = 0

Sets S-Parameter magnitude units to dB.

LINEAR = 1

Sets S-Parameter magnitude units to linear such that S-Parameters are reported in linear scale (V/V).

class nirfmxvna.enums.SParamsMathFunction(value)[source]

Bases: Enum

SParamsMathFunction.

ADD = 1

Data in measurement memory is added to S-Parameter data.

DIVIDE = 4

S-Parameter data is divided by the data in measurement memory.

MULTIPLY = 3

S-Parameter data is multiplied by the data in measurement memory.

OFF = 0

No mathematical operation is performed.

SUBTRACT = 2

Data in measurement memory is subtracted from S-Parameter data.

class nirfmxvna.enums.SParamsPhaseTraceType(value)[source]

Bases: Enum

SParamsPhaseTraceType.

UNWRAPPED = 1

The reported S-Parameter phase is unwrapped.

WRAPPED = 0

The reported S-Parameter phase is wrapped between -180 degress to +180 degrees.

class nirfmxvna.enums.SParamsSnPDataFormat(value)[source]

Bases: Enum

SParamsSnPDataFormat.

AUTO = 0

RFmx automatically selects the appropriate SnP Data Format based on the value specified for SPARAMS_FORMAT attribute.

If you set SPARAMS_FORMAT to Complex or SWR or Smith Impedence or Smith Admittance or Group Delay, S-parameters are saved in the Real-Imaginary format.

If you set SPARAMS_FORMAT to Magnitude, S-parameters are saved as either Log Magnitude-Angle or Linear Magnitude-Angle according to SPARAMS_MAGNITUDE_UNITS.

If you set SPARAMS_FORMAT to Phase or Polar, S-parameters are saved as Linear Magnitude-Angle by default.

LINEAR_MAGNITUDE_ANGLE = 3

All available S-parameters are represented as a pair of columns - first column stores magnitude of a S-Parameter in linear scale (V/V) and second column stores phase of the S-Parameter in degrees.

LOG_MAGNITUDE_ANGLE = 1

All available S-parameters are represented as a pair of columns - first column stores magnitude of a S-Parameter in log scale (dB) and second column stores phase of the S-Parameter in degrees.

REAL_IMAGINARY = 2

All available S-parameters are represented as a pair of columns - first column stores real part of the complex-valued S-Parameter and second column stores imaginary part.

class nirfmxvna.enums.SegmentDwellTimeEnabled(value)[source]

Bases: Enum

SegmentDwellTimeEnabled.

FALSE = 0

All segments are measured with the dwell time that you specify using DWELL_TIME attribute.

TRUE = 1

The selected segment is measured with the dwell time that you specify using SEGMENT_DWELL_TIME attribute.

class nirfmxvna.enums.SegmentEnabled(value)[source]

Bases: Enum

SegmentEnabled.

FALSE = 0

Disables the selected segment.

TRUE = 1

Enables the selected segment.

class nirfmxvna.enums.SegmentIFBandwidthEnabled(value)[source]

Bases: Enum

SegmentIFBandwidthEnabled.

FALSE = 0

All segments are measured with the digital IF filter bandwidth that you specify using IF_BANDWIDTH attribute.

TRUE = 1

The selected segment is measured with the digital IF filter bandwidth that you specify using SEGMENT_IF_BANDWIDTH attribute.

class nirfmxvna.enums.SegmentPowerLevelEnabled(value)[source]

Bases: Enum

SegmentPowerLevelEnabled.

FALSE = 0

All segments are measured with the source power level that you specify using POWER_LEVEL attribute.

TRUE = 1

The selected segment is measured with the source power level that you specify using SEGMENT_POWER_LEVEL attribute.

class nirfmxvna.enums.SegmentTestReceiverAttenuationEnabled(value)[source]

Bases: Enum

SegmentTestReceiverAttenuationEnabled.

FALSE = 0

All segments are measured with the test receiver attenuation that you specify using TEST_RECEIVER_ATTENUATION attribute.

TRUE = 1

The selected segment is measured with the test receiver attenuation that you specify using SEGMENT_TEST_RECEIVER_ATTENUATION attribute.

class nirfmxvna.enums.SourcePowerMode(value)[source]

Bases: Enum

SourcePowerMode.

AUTO = 0

The source is turned on when making the measurement.

OFF = 1

The source is turned off for all the ports when making the measurements.

class nirfmxvna.enums.SweepSequence(value)[source]

Bases: Enum

SweepSequence.

POINT = 1

All acquisitions for a frequency point are completed with all required source ports, before moving to the next frequency point. For example, if there are three frequency points f1, f2 and f3 and two source ports, port1 and port2, then the sweep sequence will be (f1, port1), (f1, port2), (f2, port1), (f2, port2), (f3, port1), (f3, port2).

STANDARD = 0

Acquisitions for all frequency points are completed with the first source port before moving to the next source port. For example, if there are three frequency points f1, f2 and f3 and two source ports, port1 and port2, then the sweep sequence will be (f1, port1), (f2, port1), (f3, port1), (f1, port2), (f2, port2), (f3, port2).

class nirfmxvna.enums.SweepType(value)[source]

Bases: Enum

SweepType.

CW_TIME = 4

The sweep is performed repeatedly on a single frequency and the measurement results are displayed versus time.

LINEAR = 1

The frequency is swept in equidistant steps over the frequency range.

LIST = 0

The frequency is swept in arbitrary frequency steps.

SEGMENT = 2

The frequency is swept in frequency sub-sweeps, called segments. For each segment, you can define independent values for settings like IF bandwidth, dwell time, source power level and test receiver attenuation.

class nirfmxvna.enums.TriggerMode(value)[source]

Bases: Enum

TriggerMode.

POINT = 2

VNA acquires only one data point for each trigger instance that it asserts.

For example, when you measure S11 and S22 at 10 frequency points using a 2-port VNA, the device will assert a total of 20 trigger instances to complete all acquisitions.

SEGMENT = 3

When SWEEP_TYPE attribute is set to Segment, all data points within a segment that share a source port are acquired after VNA asserts one instance of the trigger.

For example, when measuring S11 and S22 using a 2-port VNA across 2 frequency segments, each containing 4 frequency points, after the first trigger is asserted, the device completes all acquisitions in the first segment that require VNA port 1 as source. Upon asserting the second trigger, the device completes all acquisitions in the second segment that require VNA port 1 as source. On the third trigger, the device completes all acquisitions in the first segment that require VNA port 2 as source. On the fourth trigger, the device completes all acquisitions in the second segment that require VNA port 2 as source. Therefore, a total of 4 triggers are required to complete all acquisitions of both segments for both source ports.

SIGNAL = 0

VNA waits for asserting only one instance of trigger before acquiring all data points for the configured measurements in the RFmxVNA Signal namespace. You can specify the RFmxVNA Signal name using Selector String attribute.

SWEEP = 1

All data points that share a source port are acquired after VNA asserts one instance of the trigger.

For example, when you measure S11 and S22 at 10 frequency points using a 2-port VNA, after asserting the first instance of trigger, the device completes all acquisitions that require VNA port 1 as source. Upon asserting the second trigger, the device completes all acquisitions that require VNA port 2 as source.

class nirfmxvna.enums.TriggerType(value)[source]

Bases: Enum

TriggerType.

DIGITAL_EDGE = 1

The trigger is asserted when a digital edge is detected. You can specify the source of the digital edge using the DIGITAL_EDGE_TRIGGER_SOURCE attribute.

NONE = 0

No trigger is configured.

SOFTWARE = 2

The trigger is asserted when you send a software trigger. Use send_software_edge_trigger() method to send a software trigger. RFmx ignores Software Edge Trigger when performing Calibration.

class nirfmxvna.enums.WavesCorrectionState(value)[source]

Bases: Enum

WavesCorrectionState.

CORRECTED = 1

Error correction is applied without interpolation using the error terms from the calset.

INTERPOLATED = 2

Error correction is applied with error terms for at least one sweep point interpolated from the calset error terms.

NONE = 0

Error correction is not applied.

SETTINGS_MODIFIED = 3

Settings during the measurment differ from those used during calibration.

class nirfmxvna.enums.WavesFormat(value)[source]

Bases: Enum

WavesFormat.

COMPLEX = 2

Sets the format for the selected wave as complex numbers in cartesian co-ordinates.

GROUP_DELAY = 7

Sets the format of the selected wave to Group Delay. Group delay represents the time it takes for the signal to pass through a device under test. The delay is expressed in seconds.

Group delay vs. frequency is derived from phase vs. frequency response. At a given frequency point, group delay is computed by selecting two nearby frequency points and taking the ratio of the phase difference to the frequency separation between them. The frequency separation between the two selected points is called the group delay aperture.

You can control the aperture by first configuring WAVES_GROUP_DELAY_APERTURE_MODE and once the mode is selected, you can set the aperture by configuring WAVES_GROUP_DELAY_APERTURE_POINTS, WAVES_GROUP_DELAY_APERTURE_PERCENTAGE or WAVES_GROUP_DELAY_APERTURE_FREQUENCY_SPAN.

For example, if the number of aperture points is equal to 3, then group delay at a nth frequency point is computed by selecting the (n-1)th frequency point and (n+1)th frequency point.

MAGNITUDE = 0

Sets the format for the selected wave to Magnitude. You can specify WAVES_MAGNITUDE_UNITS.

PHASE = 1

Sets the format of the selected wave to Phase. Phase values are expressed in degrees. Phase can be represented in various, mathematically equivalent ways such as phase wrapped between the range [-180, 180) degrees, or phase can be represented in an unwrapped manner. You can specify the phase representation by configuring WAVES_PHASE_TRACE_TYPE.

POLAR = 6

Sets the format for the selected wave as complex numbers in polar co-ordinates, where the radial axis (i.e., magnitude of the complex numbers) is always in linear scale and angular axis (phase) is represented in degrees and always wrapped between ±180 deg.

SMITH_ADMITTANCE = 5

Sets the format for the selected wave to Smith Admittance. The measured values of the wave are transformed into admittance values. Admittance values are expressed in siemens. You can use these values to plot on an Inverted Smith Chart.

SMITH_IMPEDANCE = 4

Sets the format for the selected wave to Smith Impedance. The measured values of the wave are transformed into impedence values. Impedence values are expressed in ohms. You can use these values to plot on a Smith Chart.

SWR = 3

Sets the format for the selected wave to Standing Wave Ratio (SWR). SWR is a unitless quantity.

class nirfmxvna.enums.WavesGroupDelayApertureMode(value)[source]

Bases: Enum

WavesGroupDelayApertureMode.

FREQUENCY_SPAN = 2

Sets group delay aperture to Frequency Span. You can specify the aperture in terms of the frequency separation by configuring WAVES_GROUP_DELAY_APERTURE_FREQUENCY_SPAN.

PERCENTAGE = 1

Sets group delay aperture mode to Percentage. You can specify the aperture in terms of the frequency separation expressed in percentage by configuring WAVES_GROUP_DELAY_APERTURE_PERCENTAGE.

POINTS = 0

Sets group delay aperture mode to Points. You can specify the aperture in terms of the number of frequency points by configuring WAVES_GROUP_DELAY_APERTURE_POINTS.

class nirfmxvna.enums.WavesMagnitudeUnits(value)[source]

Bases: Enum

WavesMagnitudeUnits.

A = 6

Sets wave magnitude units to ampere.

DBM = 0

Sets wave magnitude units to dBm.

DBMA = 3

Sets wave magnitude units to dBmA.

DBMV = 1

Sets wave magnitude units to dBmV.

DBUV = 2

Sets wave magnitude units to dBuV.

V = 5

Sets wave magnitude units to volts.

W = 4

Sets wave magnitude units to watts.

class nirfmxvna.enums.WavesPhaseTraceType(value)[source]

Bases: Enum

WavesPhaseTraceType.

UNWRAPPED = 1

The reported wave phase is unwrapped.

WRAPPED = 0

The reported wave phase is wrapped between -180 degress to +180 degrees.

class nirfmxvna.enums.WavesReceiver(value)[source]

Bases: Enum

WavesReceiver.

REFERENCE = 1

Measures the wave on the reference receiver.

TEST = 0

Measures the wave on the test receiver.