NationalInstruments.RFmx.InstrMX Namespace

RFmx SpecAn 19.1 Help

Edition Date: October 2019

Part Number: 374264N-01

»View Product Info

DOWNLOAD (Windows Only)

RFmx SpecAn 19.1 Help
RFmx SpecAn 20.0 Help
RFmx SpecAn 20.6 Help

Provides instrument session and common types for RFmx .NET assemblies.


RFmxException Represents errors that occur during RFmx application execution.
RFmxInstrMX Defines a root class that identifies and controls the instrument session.
RFmxInstrMXConstants Provides string constants used for terminal names.


ISignalConfiguration Represents a signal configuration. Implement this interface to expose measurement functionality.


RFmxInstrMXAutomaticSGSASharedLO Specifies whether RFmx automatically decides to use same LO as RFSG for signal acquisition on RFSA, based on the selected measurements, in test setups that use an RFSG to generate a signal at the DUT’s input and an RFSA to measure the signal at the DUT’s output. If you are using PXIe-5840 and you want to enable this property, you must first connect RF Out LO Out to RF In LO In on the device front panel.

Supported devices: PXIe-5830/5831/5840/5841

RFmxInstrMXChannelCoupling Specifies whether the RF IN connector is AC- or DC-coupled on the downconverter.
RFmxInstrMXCleanerSpectrum Specifies whether to obtain the lowest noise floor or a faster measurement speed.
RFmxInstrMXDigitizerDitherEnabled Specifies whether dithering is enabled on the digitizer.
RFmxInstrMXDownconverterPreselectorEnabled Specifies whether the tunable preselector is enabled on the downconverter.
RFmxInstrMXExportSignalSource Routes signals (triggers, clocks, and events) to the specified output terminal.
RFmxInstrMXFrequencySettlingUnits Specifies the delay duration units and interpretation for LO settling.

Specifies whether input isolation is enabled.

Enabling this method isolates the input signal at the RF IN connector on the RF downconverter from the rest of the RF downconverter signal path. Disabling this method reintegrates the input signal into the RF downconverter signal path.

Note:If you enable input isolation for your device, the device impedance is changed from the characteristic 50-ohm impedance. A change in the device impedance may increase the VSWR value higher than the device specifications.

Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5840

The default value is Disabled.

RFmxInstrMXLinearInterpolationFormat Specifies the format of parameters to interpolate.
RFmxInstrMXLO2ExportEnabled Specifies whether to enable the LO2 OUT terminals in the installed devices.
RFmxInstrMXLOInjectionSide Specifies the LO injection side.
RFmxInstrMXLOLeakageAvoidanceEnabled Specifies whether to reduce the effects of LO leakage by placing the LO outside the band of acquisition.

Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL).

Fractional mode provides a finer frequency step resolution, but may result in non harmonic spurs. Refer to the specifications document of your device for more information about fractional mode and non harmonic spurs.

To use this method for the PXIe-5830/5831, you must first use the selector string method to specify the name of the channel you are configuring. You can configure LO1 and LO2 channels by using lo1 or lo2 as the selector string, or set the selector string to lo1, lo2 to configure both channels. You can also use RFmxInstrMX.BuildLOString utility method to create the LO String. For all other devices, the only valid value for the selector string is "" (empty string).

Note: The LO PLL Fractional Mode attribute is applicable only when using the internal LO.
Note: For the PXIe-5831 with PXIe-5653 and PXIe-5840 with PXIe-5653, this property is ignored if the PXIe-5653 is used as the LO source.

The default value is Enabled. Supported devices: PXIe-5644/5645/5646, PXIe-5830/5831/5840/5841

RFmxInstrMXMechanicalAttenuationAuto Specifies whether the system automatically chooses an attenuation setting based on the hardware settings.
RFmxInstrMXOptimizePathForSignalBandwidth Specifies the optimized RF path for the signal bandwidth that is centered on the IQ carrier frequency. You can disable this method to avoid changes to the RF path when changing the signal bandwidth.

Supported devices: PXIe-5830/5831

The default value is Automatic.

RFmxInstrMXOspDelayEnabled Specifies whether to enable the digitizer onboard signal processing (OSP) block to delay Reference Triggers, along with the data samples, that are moving through the OSP block.
RFmxInstrMXOverflowErrorReporting Configures error reporting for ADC and onboard signal processing overflows. Overflows lead to clipping of the waveform.
RFmxInstrMXPersonalities Specifies the personality of the signal if the signal exists.
RFmxInstrMXPreampEnabled Specifies whether the RF preamplifier is enabled in the system.
RFmxInstrMXPropertyId Specifies all the attribute Ids.
RFmxInstrMXRecommendedAcquisitionType Configures the type of acquisition performed.
RFmxInstrMXRecommendedSpectralFftWindow Specifies the FFT window type.
RFmxInstrMXRFAttenuationAuto Specifies whether the measurement computes the RF attenuation.
RFmxInstrMXSelfCalibrateStepsSpecifies the self-calibration step.
RFmxInstrMXSParameterOrientation Specifies the orientation of the data in the S2P file relative to the port you specify. The default value is Port2TowardsDut.

Returns the type of S-parameter to apply to measurements on the specified port for a Calplane. You can use the selectorString input to specify the name of the Calplane and port to configure for s-parameter.

RFmxInstrMXTuningSpeed Specifies the tradeoffs between tuning speed and phase noise.


Not Helpful