Enums

Enums used in NI-RFSG

AllowOutOfSpecificationUserSettings

class nirfsg.AllowOutOfSpecificationUserSettings

DISABLE: Disables out-of-specification user settings.

ENABLE: Enables out-of-specification user settings.

AmpPath

class nirfsg.AmpPath

HIGH_POWER: Sets the amplification path to use the high power path.

LOW_HARMONIC: Sets the amplification path to use the low harmonic path.

AnalogModulationFmBand

class nirfsg.AnalogModulationFmBand

NARROWBAND: Specifies narrowband frequency modulation.

WIDEBAND: Specifies wideband frequency modulation.

AnalogModulationFmNarrowbandIntegrator

class nirfsg.AnalogModulationFmNarrowbandIntegrator

RANGE_100_HERTZ_TO_1_KILOHERTZ: Specifies a range from 100Hz to 1kHz.

RANGE_1_KILOHERTZ_TO_10_KILOHERTZ: Specifies a range from 1kHz to 10kHz.

RANGE_10_KILOHERTZ_TO_100_KILOHERTZ: Specifies a range from 10kHz to 100kHz.

AnalogModulationPmMode

class nirfsg.AnalogModulationPmMode

HIGH_DEVIATION: Specifies high deviation. High deviation comes at the expense of a higher phase noise.

LOW_PHASE_NOISE: Specifies low phase noise. Low phase noise comes at the expense of a lower maximum deviation.

AnalogModulationType

class nirfsg.AnalogModulationType

NONE: Disables analog modulation.

FM: Specifies that the analog modulation type is FM.

PM: Specifies that the analog modulation type is PM.

AM: Specifies that the analog modulation type is AM.

ArbOnboardSampleClockMode

class nirfsg.ArbOnboardSampleClockMode

HIGH_RESOLUTION: Sample rates are generated by a high-resolution clock.

DIVIDE_DOWN: Sample rates are generated by dividing the source frequency.

ArbSampleClockSource

class nirfsg.ArbSampleClockSource

ONBOARD_CLOCK: Uses the AWG module onboard clock as the Sample Clock source.

CLK_IN: Uses the external clock as the Sample Clock source.

AutomaticLevelControl

class nirfsg.AutomaticLevelControl

DISABLE: Disables ALC.

ENABLE: Enables the ALC.

AutomaticPowerSearch

class nirfsg.AutomaticPowerSearch

DISABLE: Disables automatic power search.

ENABLE: Enables automatic power search.

AutomaticThermalCorrection

class nirfsg.AutomaticThermalCorrection

DISABLE: Automatic thermal correction is disabled.

ENABLE: Automatic thermal correction is enabled.

DeembeddingType

class nirfsg.DeembeddingType

NONE: De-embedding is not applied to the measurement.

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

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

DigitalEqualizationEnabled

class nirfsg.DigitalEqualizationEnabled

DISABLE: Filter is not applied

ENABLE: Filter is applied.

DirectDownload

class nirfsg.DirectDownload

DISABLE: The RF In local oscillator signal is not present at the front panel LO OUT connector.

ENABLE: The RF In local oscillator signal is present at the front panel LO OUT connector.

UNSPECIFIED: The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may be controlling it.

Format

class nirfsg.Format

MAGNITUDE_AND_PHASE: Results in a linear interpolation of the magnitude and a separate linear interpolation of the phase.

MAGNITUDE_DB_AND_PHASE: Results in a linear interpolation of the magnitude, in decibels, and a separate linear interpolation of the phase.

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

FrequencySettlingUnits

class nirfsg.FrequencySettlingUnits

TIME_AFTER_LOCK: Specifies the time to wait after the frequency PLL locks.

TIME_AFTER_IO: Specifies the time to wait after all writes occur to change the frequency

PPM: Specifies the minimum frequency accuracy when settling completes. Units are in parts per million (PPM or 1E-6).

GenerationMode

class nirfsg.GenerationMode

CW: Configures the RF signal generator to generate a CW signal.

ARB_WAVEFORM: Configures the RF signal generator to generate the arbitrary waveform specified by the nirfsg.Session.arb_selected_waveform property.

SCRIPT: Configures the RF signal generator to generate arbitrary waveforms as directed by the nirfsg.Session.selected_script property.

IQOutPortTerminalConfiguration

class nirfsg.IQOutPortTerminalConfiguration

DIFFERENTIAL: Sets the terminal configuration to differential.

SINGLE_ENDED: Sets the terminal configuration to single-ended.

LoOutExportConfigureFromRfsaEnable

class nirfsg.LoOutExportConfigureFromRfsaEnable

DISABLE: Do not allow NI-RFSA to control the NI-RFSG local oscillator export.

ENABLE: Allow NI-RFSA to control the NI-RFSG local oscillator export.

LoPllFractionalModeEnabled

class nirfsg.LoPllFractionalModeEnabled

DISABLE: Disables fractional mode for the LO PLL.

ENABLE: Enables fractional mode for the LO PLL.

LoSource

class nirfsg.LoSource

ONBOARD: Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself.

LO_IN: Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the UPCONVERTER_CENTER_FREQUENCY property to specify the LO frequency.

SECONDARY: Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653.

SG_SA_SHARED: Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842.

AUTOMATIC_SG_SA_SHARED: NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842.

LoadConfigurationResetOptions

class nirfsg.LoadConfigurationResetOptions

WAVEFORMS: NI-RFSG skips resetting the waveform configurations.

DEEMBEDDING_TABLES: NI-RFSG skips resetting the de-embedding tables.

SCRIPTS: NI-RFSG skips resetting the scripts.

NONE: NI-RFSG resets all configurations.

LoadOptions

class nirfsg.LoadOptions

NONE: NI-RFSG loads all the configurations to the session.

WAVEFORMS: NI-RFSG skips loading the waveform configurations to the session.

LoopBandwidth

class nirfsg.LoopBandwidth

NARROW: Uses the narrowest loop bandwidth setting for the PLL.

MEDIUM: Uses the medium loop bandwidth setting for the PLL.

WIDE: Uses the widest loop bandwidth setting for the PLL.

MarkerEventOutputBehavior

class nirfsg.MarkerEventOutputBehavior

PULSE: Specifies the Marker Event output behavior as pulse.

TOGGLE: Specifies the Marker Event output behavior as toggle.

MarkerEventPulseWidthUnits

class nirfsg.MarkerEventPulseWidthUnits

SECONDS: Specifies the Marker Event pulse width units as seconds.

SAMPLE_CLOCK_PERIODS: Specifies the Marker Event pulse width units as Sample Clock periods.

MarkerEventToggleInitialState

class nirfsg.MarkerEventToggleInitialState

LOW: Specifies the initial state of the Marker Event toggle behavior as digital low.

HIGH: Specifies the initial state of the Marker Event toggle behavior as digital high.

Module

class nirfsg.Module

AWG: The AWG associated with the primary module.

LO: The LO associated with the primary module.

PRIMARY_MODULE: The stand-alone device or the main module in a multi-module device.

OffsetUnits

class nirfsg.OffsetUnits

PERCENT: Specifies the unit in percentage.

VOLTS: Specifies the unit in volts.

OutputPort

class nirfsg.OutputPort

RF_OUT: Enables the RF OUT port. This value is not valid for the PXIe-5820.

IQ_OUT: Enables the I/Q OUT port. This value is valid on only the PXIe-5645 and PXIe-5820.

CAL_OUT: Enables the CAL OUT port.

I_ONLY: Enables the I connectors of the I/Q OUT port. This value is valid on only the PXIe-5645.

OverflowErrorReporting

class nirfsg.OverflowErrorReporting

WARNING: NI-RFSG returns a warning when an OSP overflow occurs.

DISABLED: NI-RFSG does not return an error or a warning when an OSP overflow occurs.

PhaseContinuityEnabled

class nirfsg.PhaseContinuityEnabled

AUTO: The arbitrary waveform may be repeated to ensure phase continuity after upconversion. This setting could cause waveform size to increase.

DISABLE: The arbitrary waveform plays back without regard to any possible phase discontinuities introduced by upconversion. The time duration of the original waveform is maintained.

ENABLE: The arbitrary waveform may be repeated to ensure phase continuity after upconversion. Enabling this property could cause waveform size to increase.

PowerLevelType

class nirfsg.PowerLevelType

AVERAGE: Indicates the desired power averaged in time. The driver maximizes the dynamic range by scaling the I/Q waveform so that its peak magnitude is equal to one. If your write more than one waveform, NI-RFSG scales each waveform without preserving the power level ratio between the waveforms. This value is not valid for the PXIe-5820.

PEAK: Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires that the magnitude of the I/Q waveform must always be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the nirfsg.Session.arb_waveform_software_scaling_factor property. You can use the nirfsg.Session.peak_power_adjustment property in conjunction with the nirfsg.Session.power_level property when the nirfsg.Session.power_level_type property is set to PEAK.

PulseModulationMode

class nirfsg.PulseModulationMode

OPTIMAL_MATCH: Provides for a more optimal power output match for the device during the off cycle of the pulse mode operation. Not supported on PXIe-5842

HIGH_ISOLATION: Allows for the best on/off power ratio of the pulsed signal.

ANALOG: Analog switch blanking. Balance between switching speed and on/off power ratio of the pulsed signal.

DIGITAL: Digital only modulation. Provides the best on/off switching speed of the pulsed signal at the cost of signal isolation.

PulseModulationOutputTerminal

class nirfsg.PulseModulationOutputTerminal

DO_NOT_EXPORT: Pulse modulation video signal is not exported.

PULSE_OUT: Export the pulse modulation video signal on the pulse out terminal.

PulseModulationSource

class nirfsg.PulseModulationSource

PULSE_IN: The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.

MARKER0: The trigger is received from the Marker 0.

MARKER1: The trigger is received from the Marker 1.

MARKER2: The trigger is received from the Marker 2.

MARKER3: The trigger is received from the Marker 3.

RFBlanking

class nirfsg.RFBlanking

DISABLE: RF blanking is disabled.

ENABLE: RF blanking is enabled.

RFInLoExportEnabled

class nirfsg.RFInLoExportEnabled

UNSPECIFIED: The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may

DISABLE: The RF In local oscillator signal is not present at the front panel LO OUT connector.

ENABLE: The RF In local oscillator signal is present at the front panel LO OUT connector.

ReferenceClockExportOutputTerminal

class nirfsg.ReferenceClockExportOutputTerminal

DO_NOT_EXPORT: The Reference Clock signal is not exported.

REF_OUT: Exports the Reference Clock signal to the REF OUT connector of the device.

REF_OUT2: Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.

CLK_OUT: Exports the Reference Clock signal to the CLK OUT connector of the device.

ReferenceClockSource

class nirfsg.ReferenceClockSource

ONBOARD_CLOCK: Uses the onboard Reference Clock as the clock source.

REF_IN: Uses the clock signal present at the front panel REF IN connector as the Reference Clock source.

PXI_CLK: Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source.

CLK_IN: Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655.

REF_IN_2: This value is not valid on any supported devices.

PXI_CLK_MASTER: This value is valid on only the PXIe-5831/5832 with PXIe-5653. PXIe-5831/5832 with PXIe-5653 - NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_CLK as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.

ReferencePllBandwidth

class nirfsg.ReferencePllBandwidth

NARROW: Uses the narrowest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_NARROW allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653.

MEDIUM: Uses the medium loop bandwidth setting for the PLL.

WIDE: Uses the widest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_WIDE on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.

RelativeTo

class nirfsg.RelativeTo

CURRENT_POSITION: The reference position is relative to the current position.

START_OF_WAVEFORM: The reference position is relative to the start of the waveform.

ResetWithOptionsStepsToOmit

class nirfsg.ResetWithOptionsStepsToOmit

DEEMBEDDING_TABLES: Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840.

NONE: No step is omitted during reset.

ROUTES: Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset.

SCRIPTS: Omits clearing scripts.

WAVEFORMS: Omits clearing waveforms.

ScriptTriggerDigitalEdgeEdge

class nirfsg.ScriptTriggerDigitalEdgeEdge

RISING: Asserts the trigger when the signal transitions from low level to high level.

FALLING: Asserts the trigger when the signal transitions from high level to low level.

ScriptTriggerDigitalLevelActiveLevel

class nirfsg.ScriptTriggerDigitalLevelActiveLevel

HIGH: Trigger when the digital trigger signal is high.

LOW: Trigger when the digital trigger signal is low.

ScriptTriggerType

class nirfsg.ScriptTriggerType

NONE: No trigger is configured. Signal generation starts immediately.

DIGITAL_EDGE: The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the nirfsg.Session.digital_edge_start_trigger_source property, and the active edge is specified with the nirfsg.Session.digital_edge_start_trigger_edge property.

DIGITAL_LEVEL: The data operation does not start until the digital level is detected. The source of the digital level is specified in the nirfsg.Session.digital_level_script_trigger_source property, and the active level is specified in the nirfsg.Session.digital_level_script_trigger_active_level property.

SOFTWARE: The data operation does not start until a software trigger occurs. You can create a software event by calling the nirfsg.Session.send_software_edge_trigger() method.

SelfCalibrateRangeStepsToOmit

class nirfsg.SelfCalibrateRangeStepsToOmit

IMAGE_SUPPRESSION: Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.

LO_SELF_CAL: Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.

OMIT_NONE: No calibration steps are omitted.

POWER_LEVEL_ACCURACY: Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.

RESIDUAL_LO_POWER: Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.

SYNTHESIZER_ALIGNMENT: Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.

Signal

class nirfsg.Signal

START_TRIGGER: Exports a Start Trigger.

SCRIPT_TRIGGER: Exports a Script Trigger.

MARKER_EVENT: Exports a Marker Event.

REF_CLOCK: Exports the Reference Clock.

STARTED_EVENT: Exports a Started Event.

DONE_EVENT: Exports a Done Event.

SoftwareTriggerType

class nirfsg.SoftwareTriggerType

SCRIPT: Specifies the Script Trigger.

START: Specifies the Start Trigger.

SparameterOrientation

class nirfsg.SparameterOrientation

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

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

StartTriggerDigitalEdgeEdge

class nirfsg.StartTriggerDigitalEdgeEdge

RISING: Occurs when the signal transitions from low level to high level.

FALLING: Occurs when the signal transitions from high level to low level.

StartTriggerType

class nirfsg.StartTriggerType

NONE: No trigger is configured.

DIGITAL_EDGE: The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the nirfsg.Session.digital_edge_start_trigger_source property, and the active edge is specified in the nirfsg.Session.digital_edge_start_trigger_edge property.

SOFTWARE: The data operation does not start until a software event occurs. You may create a software trigger by calling the nirfsg.Session.send_software_edge_trigger() method.

TriggerIdentifier

class nirfsg.TriggerIdentifier

SCRIPT_TRIGGER0: Specifies Script Trigger 0.

SCRIPT_TRIGGER1: Specifies Script Trigger 1.

SCRIPT_TRIGGER2: Specifies Script Trigger 2.

SCRIPT_TRIGGER3: Specifies Script Trigger 3.

NONE: None (no signal to export)

UpconverterFrequencyOffsetMode

class nirfsg.UpconverterFrequencyOffsetMode

AUTO: NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the nirfsg.Session.signal_bandwidth property has been set and can be avoided.

ENABLE: NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the nirfsg.Session.signal_bandwidth property has been set and can be avoided. NI-RFSG returns an error if the nirfsg.Session.signal_bandwidth property has not been set, or if the signal bandwidth is too large.

USER_DEFINED: NI-RFSG uses the offset that you specified with the nirfsg.Session.upconverter_frequency_offset or nirfsg.Session.upconverter_center_frequency properties.

WriteWaveformBurstDetection

class nirfsg.WriteWaveformBurstDetection

DISABLE: Burst detection is disabled.

ENABLE: Burst detection is enabled.

WriteWaveformBurstDetectionMode

class nirfsg.WriteWaveformBurstDetectionMode

AUTO: NI-RFSG automatically detects the burst start and burst stop locations by analyzing the waveform.

MANUAL: User sets the burst detection parameters.

WriteWaveformNormalization

class nirfsg.WriteWaveformNormalization

DISABLE: Disables normalization on the waveform.

ENABLE: Enables normalization on a waveform to transform the waveform data so that its maximum is 1.00 and its minimum is -1.00

YigMainCoilDrive

class nirfsg.YigMainCoilDrive

MANUAL: Adjusts the YIG main coil for an underdamped response.

FAST: Adjusts the YIG main coil for an overdamped response.