RFmxInstrMX Class
- Updated2025-10-13
- 27 minute(s) read
Defines a root class which is used to identify and control Instr signal configuration.
Derives from
- IDisposable
Syntax
Namespace: NationalInstruments.RFmx.InstrMX
public class RFmxInstrMX : IDisposable
Remarks
For more information about RFmx Instruments, refer to RFmx Instruments Help.
Constructors
| Name | Description |
|---|---|
| RFmxInstrMX(string[], string) | Creates an RFmx session to the device you specify through the resourceName parameter. Note Enabling the SFP (Soft Front Panel) debug has a performance impact. For best performance, NI recommends disabling SFP debug. SFP debug can be enabled/disabled from either the RF Signal Analyzer panel in InstrumentStudio, the RFSA Soft Front Panel, or the RFmx Debug Configuration Utility. |
| RFmxInstrMX(string, string) | Creates an RFmx session to the device you specify through the resourceName parameter. Note Enabling the SFP (Soft Front Panel) debug has a performance impact. For best performance, NI recommends disabling SFP debug. SFP debug can be enabled/disabled from either the RF Signal Analyzer panel in InstrumentStudio, the RFSA Soft Front Panel, or the RFmx Debug Configuration Utility. |
| RFmxInstrMX(IntPtr) | Creates a new RFmx session from an existing RFmx instrument handle. |
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that indicates whether the signal has been disposed. |
| NumberOfLists | Gets the number of lists created in the current session. |
| NumberOfSignalConfigurations | Gets the number of signal configurations created in the current session. |
Methods
| Name | Description |
|---|---|
| CheckAcquisitionStatus(out bool) | Checks the status of the acquisition. Use this method to check for any errors that may occur during acquisition, or to check whether RFmx has completed the acquisition operation. |
| CheckIfListExists(string, out bool, out RFmxInstrMXPersonalities) | Returns whether the list you specify in the listname parameter exists, and also returns the corresponding personality of the list, if the list exists. This method does not support an empty ("") list name. |
| CheckIfSignalExists(string, out bool, out RFmxInstrMXPersonalities) | Returns whether the signal you specify in the signalname parameter exists, and also returns the corresponding personality of the signal, if the signal exists. This method does not support an empty ("") signal name. |
| Close() | Closes the RFmx session. Call this method a number of times equal to the number of times you obtained a reference to the RFmx session for a particular resource name. |
| ConfigureExternalAttenuationInterpolationLinear(string, string, RFmxInstrMXLinearInterpolationFormat) | Selects the linear interpolation method when interpolating S-parameters for the specified table. If the carrier frequency does not match a row in the S-parameter table, this method performs a linear interpolation based on the entries above and below the row in the table. |
| ConfigureExternalAttenuationInterpolationNearest(string, string) | Selects the nearest interpolation method when interpolating S-parameters for a specified table. The parameters of the table nearest to the carrier frequency are used. |
| ConfigureExternalAttenuationInterpolationSpline(string, string) | Selects the spline interpolation method when interpolating parameters for the specified table. If the carrier frequency does not match a row in the S-parameter table, this method performs a spline interpolation based on the entries above and below the row in the table. |
| ConfigureExternalAttenuationTable(string, string, double[], double[]) | Stores the external attenuation table in the calibration plane specified by the selectorString parameter. On a MIMO session, the external attenuation table is stored for each MIMO port in the specified calibration plane. |
| ConfigureFrequencyReference(string, string, double) | Configures the Reference Clock and the frequency reference source. |
| ConfigureMechanicalAttenuation(string, RFmxInstrMXMechanicalAttenuationAuto, double) | Configures the mechanical attenuation and RFmx attenuation hardware settings.supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668 |
| ConfigureRFAttenuation(string, RFmxInstrMXRFAttenuationAuto, double) | Configures the nominal attenuation and RFmx setting. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668 |
| ConfigureSParameterExternalAttenuationTable(string, string, double[], ComplexDouble, RFmxInstrMXSParameterOrientation) | Stores the S-parameter table in the calibration plane specified by the selectorString parameter. On a MIMO session the S-parameter table is stored for each MIMO port in the specified calibration plane.supporteddevices: PXIe-5830/5831/5832/5840/5841/5842/5860 |
| ConfigureSParameterExternalAttenuationType(string, RFmxInstrMXSParameterType) | Configures the type of S-parameter to apply to measurements on the specified port for a Calplane. You can use the Selector String input to specify the name of the Calplane and port to configure for S-parameter. supporteddevices: PXIe-5830/5831/5832/5840/5841/5842/5860 |
| DangerousGetNIRfsaHandle(out IntPtr) | Returns the value of the underlying instrument handle. Note Do not close the NI-RFSA driver session before calling RFmx close. Closing the NI-RFSA driver session before closing RFmx session would lead to unpredictable behavior. |
| DangerousGetNIRfsaHandleArray(ref IntPtr[]) | Returns list of underlying instrument handles. Note Do not close the NI-RFSA driver session before calling RFmx close. Closing the NI-RFSA driver session before closing RFmx session would lead to unpredictable behavior. |
| DeleteAllExternalAttenuationTables(string) | Deletes all the external attenuation tables in the calibration plane specified by the selectorString parameter. On a MIMO session, this method deletes all the external attenuation tables for the specified MIMO port. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860 |
| DeleteExternalAttenuationTable(string, string) | Deletes the external attenuation table set by the tableName parameter in the calibration plane specified by the selectorString parameter. On a MIMO session, this method selects the active external attenuation table for the specified MIMO port. The specified table will be used for amplitude correction during measurement. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860 |
| DisableCalibrationPlane(string) | Disables the calibration plane specified by the selectorString parameter for amplitude correction.supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860 |
| Dispose() | Closes the RFmx session. Call this method a number of times equal to the number of times you obtained a reference to the RFmx session for a particular resource name. |
| EnableCalibrationPlane(string) | Enables the calibration plane specified by the selectorString parameter for amplitude correction.supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860 |
| ExportSignal(RFmxInstrMXExportSignalSource, string) | Routes signals (triggers, clocks, and events) to the specified output terminal. |
| FetchRawIQData(string, double, int, long, ref ComplexWaveform< ComplexSingle >) | Fetches I/Q data from a single record in an acquisition. |
| ForceClose() | Closes all RFmx sessions. Calling this method once will destroy the session, irrespective of the many references obtained for the session for a particular resource name. |
| GetAdvanceTriggerDigitalEdgeSource(string, out string) | Gets the source terminal for the advance trigger. |
| GetAdvanceTriggerExportOutputTerminal(string, out string) | Gets the destination terminal for the exported advance trigger. |
| GetAdvanceTriggerTerminalName(string, out string) | Gets the fully qualified signal name as a string. |
| GetAdvanceTriggerType(string, out RFmxInstrMXAdvanceTriggerType) | Gets whether the advance trigger is a digital edge or a software trigger. |
| GetAmplitudeSettling(string, out double) | Gets the amplitude settling accuracy value. This value is expressed in decibels. RFmx waits until the RF power attains the specified accuracy level after calling the RFmx Initiate function. |
| GetAttributeBool(string, int, out bool) | Gets the value of a Bool attribute. |
| GetAttributeByte(string, int, out byte) | Gets the value of a Byte attribute. |
| GetAttributeByteArray(string, int, ref byte[]) | Gets the value of a byte array attribute. |
| GetAttributeComplexDoubleArray(string, int, ref ComplexDouble[]) | Gets the value of a ComplexDouble array attribute. |
| GetAttributeComplexSingleArray(string, int, ref ComplexSingle[]) | Gets the value of a ComplexSingle array attribute. |
| GetAttributeDouble(string, int, out double) | Gets the value of a Double attribute. |
| GetAttributeDoubleArray(string, int, ref double[]) | Gets the value of a double array attribute. |
| GetAttributeFloat(string, int, out float) | Gets the value of a Float attribute. |
| GetAttributeFloatArray(string, int, ref float[]) | Gets the value of a float array attribute. |
| GetAttributeInt(string, int, out int) | Gets the value of an RFmx 32-bit integer (int32) attribute. |
| GetAttributeIntArray(string, int, ref int[]) | Gets the value of a int array attribute. |
| GetAttributeLong(string, int, out long) | Gets the value of an RFmx 64-bit integer (int64) attribute. |
| GetAttributeLongArray(string, int, ref long[]) | Gets the value of a long array attribute. |
| GetAttributeSByte(string, int, out sbyte) | Gets the value of a SByte attribute. |
| GetAttributeSByteArray(string, int, ref sbyte[]) | Gets the value of a sbyte array attribute. |
| GetAttributeShort(string, int, out short) | Gets the value of a Short attribute. |
| GetAttributeString(string, int, out string) | Gets the value of a string attribute. |
| GetAttributeUInt(string, int, out uint) | Gets the value of a uint attribute. |
| GetAttributeUIntArray(string, int, ref uint[]) | Gets the value of a uint array attribute. |
| GetAttributeULongArray(string, int, ref ulong[]) | Gets the value of a ulong array attribute. |
| GetAttributeUShort(string, int, out ushort) | Gets the value of a UShort attribute. |
| GetAvailablePaths(string, ref string[]) | Gets paths available for the session. On a MIMO session, this method fetches all the paths for the initialized MIMO paths. |
| GetAvailablePorts(string, ref string[]) | Gets ports available for the session. On a MIMO session, this method fetches all the ports for the initialized MIMO ports. |
| GetAvailablePorts(out string[]) | Gets the list of ports available for use based on your instrument configuration. |
| GetChannelCoupling(string, out RFmxInstrMXChannelCoupling) | Gets whether the RF IN connector is AC- or DC-coupled on the downconverter. |
| GetCleanerSpectrum(string, out RFmxInstrMXCleanerSpectrum) | Gets how to obtain the lowest noise floor or faster measurement speed. |
| GetCommonModeLevel(string, out double) | Gets the common-mode level presented at each differential input terminal. The common-mode level shifts both positive and negative terminals in the same direction. This must match the common-mode level of the device under test (DUT). This value is expressed in Volts. |
| GetDeviceTemperature(string, out double) | Gets the current temperature of the module. This value is expressed in degrees Celsius. |
| GetDigitalGain(string, out double) | Gets the scaling factor applied to the time-domain voltage data in the digitizer. This value is expressed in dB. |
| GetDigitizerDitherEnabled(string, out RFmxInstrMXDigitizerDitherEnabled) | Gets whether dithering is enabled on the digitizer. |
| GetDigitizerTemperature(string, out double) | Gets the current temperature of the digitizer module. This value is expressed in degrees Celsius. |
| GetDoneEventOutputTerminal(string, out string) | Gets the destination terminal for the Done event. |
| GetDoneEventTerminalName(string, out string) | Gets the fully qualified signal name as a string. |
| GetDownconverterCenterFrequency(string, out double) | Enables in-band retuning and specifies the current frequency of the RF downconverter. This value is expressed in Hz. |
| GetDownconverterFrequencyOffset(string, out double) | Gets an offset from the center frequency value for the downconverter. Use this method to offset the measurement away from the LO leakage or DC Offset of analyzers that use a direct conversion architecture. You must set this method to half the bandwidth or span of the measurement + guardband. The guardband is needed to ensure that the LO leakage is not inside the analog or digital filter rolloffs. This value is expressed in Hz. |
| GetDownconverterGain(string, out double) | Gets the net signal gain for the device at the current RFmx settings and temperature. RFmx scales the acquired I/Q and spectrum data from the digitizer using the value of this method. |
| GetDownconverterPreselectorEnabled(string, out RFmxInstrMXDownconverterPreselectorEnabled) | Gets whether the tunable preselector is enabled on the downconverter. |
| GetEndOfRecordEventOutputTerminal(string, out string) | Gets the destination terminal for the End of Record event. |
| GetEndOfRecordEventTerminalName(string, out string) | Gets the fully qualified signal name as a string. |
| GetError(out int, out string) | Gets the latest error code and description. |
| GetErrorString(int, out string) | Converts the status code returned by an RFmxInstr function into a string. |
| GetExternalAttenuationTableActualValue(string, out double) | Returns the external attenuation table actual value that is applied to the measurements for a specified signal and calibration plane. |
| GetFftWidth(string, out double) | Gets the FFT width of the device. The FFT width is the effective bandwidth of the signal path during each signal acquisition. |
| GetFrequencyReferenceExportedTerminal(string, out string) | Gets a comma-separated list of the terminals at which to export the frequency reference. |
| GetFrequencyReferenceFrequency(string, out double) | Gets the Reference Clock rate, when the Frequency Reference Source method is set to ClkIn or RefIn. This value is expressed in Hz. |
| GetFrequencyReferenceSource(string, out string) | Gets the frequency reference source. |
| GetFrequencySettling(string, out double) | Gets the value used for LO frequency settling. |
| GetFrequencySettlingUnits(string, out RFmxInstrMXFrequencySettlingUnits) | Gets the delay duration units and interpretation for LO settling. |
| GetIFFilterBandwidth(string, out double) | Gets the IF filter path bandwidth for your device configuration. |
| GetIFOutputPowerLevelOffset(string, out double) | Gets the power offset by which to adjust the default IF output power level. This value is expressed in dB. |
| GetInputIsolationEnabled(string, out RFmxInstrMXInputIsolationEnabled) | Gets whether input isolation is enabled. |
| GetInstrumentFirmwareRevision(string, out string) | Gets a string containing the firmware revision information of the RF downconverter for the composite device you are currently using. |
| GetInstrumentHandle() | Gets the SafeHandle to the RFmxInstrMX instrument session. |
| GetInstrumentModel(string, out string) | Gets a string that contains the model number or name of the RF device that you are currently using. |
| GetListNames(string, RFmxInstrMXPersonalities, ref string[], ref RFmxInstrMXPersonalities[]) | Returns the list names and the corresponding selected personality type from the personalityFilter parameter. When you set the personalityFilter parameter to all, this function returns the available list names for all supported personalities. |
| GetLO2ExportEnabled(string, out RFmxInstrMXLO2ExportEnabled) | Gets whether to enable the LO2 OUT terminals in the installed devices. |
| GetLoadOptions(string, ref RFmxInstrMXLoadOptions[]) | Specifies the configurations to skip while loading from a file using the LoadConfigurations(string) method |
| GetLOExportEnabled(string, out bool) | Gets whether to enable the LO OUT terminals on the installed devices. |
| GetLOFrequency(string, out double) | Gets the LO signal frequency for the configured center frequency. This value is expressed in Hz. |
| GetLOFrequencyStepSize(string, out double) | Gets the step size for tuning the LO phase-locked loop (PLL). |
| GetLOInjectionSide(string, out RFmxInstrMXLOInjectionSide) | Enables in-band retuning and specifies the current frequency of the RF downconverter. This value is expressed in Hz. |
| GetLOInPower(string, out double) | Gets the power level expected at the LO IN terminal when the SetLOSource(string, string) method is set to RFMXINSTR_VAL_LO_SOURCE_LO_IN. This value is expressed in dBm. |
| GetLOLeakageAvoidanceEnabled(string, out RFmxInstrMXLOLeakageAvoidanceEnabled) | Gets whether to reduce the effects of the instrument leakage by placing the LO outside the band of acquisition. |
| GetLOOutPower(string, out double) | Gets the power level of the signal at the LO OUT terminal when the SetLOExportEnabled(string, bool) method is set to TRUE. This value is expressed in dBm. |
| GetLOPllFractionalMode(string, out RFmxInstrMXLOPllFractionalMode) | Gets whether to use fractional mode for the LO phase-locked loop (PLL). |
| GetLOSharingMode(string, out RFmxInstrMXLOSharingMode) | Gets the RFmx session with the respective LO sharing mode. |
| GetLOSource(string, out string) | Gets the LO signal source used to downconvert the RF input signal. |
| GetLOSplitterLoss(string, ref double[]) | Gets an array of the insertion losses inherent to the RF Splitter. This value is expressed in dB. |
| GetLOSplitterLossFrequency(string, ref double[]) | Gets the frequencies corresponding to the insertion loss inherent to the RF Splitter, as specified by the SetLOSplitterLoss(string, double[]) method. This value is expressed in Hz. |
| GetLOTemperature(string, out double) | Gets the current temperature of the LO module associated with the device. This value is expressed in degrees Celsius. |
| GetLOVcoFrequencyStepSize(string, out double) | Gets the step size for tuning the internal voltage-controlled oscillator (VCO) used to generate the LO signal. The valid values for LO1 include 1 Hz to 50 MHz and for LO2 include 1 Hz to 100 MHz. |
| GetMechanicalAttenuationAuto(string, out RFmxInstrMXMechanicalAttenuationAuto) | Gets whether RFmx chooses an attenuation setting based on the hardware settings. |
| GetMechanicalAttenuationValue(string, out double) | Gets the level of mechanical attenuation for the RF path. This value is expressed in dB. |
| GetMixerLevel(string, out double) | Gets the mixer level, in dBm. |
| GetMixerLevelOffset(string, out double) | Gets the number of dB by which to adjust the device mixer level. |
| GetModuleRevision(string, out string) | Gets the revision of the RF downconverter module. |
| GetNumberOfLOSharingGroups(string, out int) | Gets the RFmx session with the number of LO sharing groups. |
| GetNumberOfRawIQRecords(string, out int) | Gets the number of raw IQ records to acquire to complete measurement averaging. |
| GetOptimizePathForSignalBandwidth(string, out RFmxInstrMXOptimizePathForSignalBandwidth) | Optimizes RF path for the signal bandwidth that is centered on the IQ carrier frequency. |
| GetOspDelayEnabled(string, out RFmxInstrMXOspDelayEnabled) | Gets whether to enable the digitizer OSP block to delay Reference Triggers, along with the data samples, moving through the OSP block. |
| GetOverflowErrorReporting(string, out RFmxInstrMXOverflowErrorReporting) | Configures error reporting for ADC and overflows occurred during onboard signal processing. Overflows lead to clipping of the waveform. |
| GetPhaseOffset(string, out double) | Gets the offset to apply to the initial I and Q phases. |
| GetPreampEnabled(string, out RFmxInstrMXPreampEnabled) | Gets whether the RF preamplifier is enabled in the system. |
| GetPreselectorPresent(string, out bool) | Indicates whether a preselector is available on the RF downconverter module. |
| GetReadyForAdvanceEventOutputTerminal(string, out string) | Gets the destination terminal for the Ready for Advance event. |
| GetReadyForAdvanceEventTerminalName(string, out string) | Gets the fully qualified signal name as a string. |
| GetReadyForReferenceEventOutputTerminal(string, out string) | Gets the destination terminal for the Ready for Reference event. |
| GetReadyForReferenceEventTerminalName(string, out string) | Gets the fully qualified signal name as a string. |
| GetReadyForStartEventOutputTerminal(string, out string) | Gets the destination terminal for the Ready for Start event. |
| GetReadyForStartEventTerminalName(string, out string) | Gets the fully qualified signal name as a string. |
| GetRecommendedAcquisitionType(string, out RFmxInstrMXRecommendedAcquisitionType) | Gets the recommended acquisition type for the last committed measurement configuration. |
| GetRecommendedCenterFrequency(string, out double) | Gets the recommended center frequency of the RF signal. This value is expressed in Hz. |
| GetRecommendedIQAcquisitionTime(string, out double) | Gets the recommended acquisition time for I/Q acquisition, in seconds. |
| GetRecommendedIQMinimumSampleRate(string, out double) | Gets the recommended minimum sample rate for I/Q acquisition, in Hz. |
| GetRecommendedIQPreTriggerTime(string, out double) | Gets the recommended pretrigger time for I/Q acquisition, in seconds. |
| GetRecommendedNumberOfRecords(string, out int) | Gets the recommended number of records to acquire to complete measurement averaging. |
| GetRecommendedSpectralAcquisitionSpan(string, out double) | Gets the recommended acquisition span for spectral acquisition, in Hz. |
| GetRecommendedSpectralFftWindow(string, out RFmxInstrMXRecommendedSpectralFftWindow) | Gets the recommended FFT window type for spectral acquisition. |
| GetRecommendedSpectralResolutionBandwidth(string, out double) | Gets the recommended FFT bin width for spectral acquisition. This value is expressed in Hz. |
| GetRecommendedTriggerMinimumQuietTime(string, out double) | Gets the recommended minimum quiet time during which the signal level must be below the trigger value for triggering to occur. This value is expressed in seconds. |
| GetRFAttenuationAuto(string, out RFmxInstrMXRFAttenuationAuto) | Gets whether RFmx computes the RF attenuation. |
| GetRFAttenuationStepSize(string, out double) | Gets the step size for the RF attenuation level. This value is expressed in dB. The actual RF attenuation is coerced up to the next highest multiple of the specified step size. If the mechanical attenuators are not available to implement the coerced RF attenuation, the solid state attenuators are used. |
| GetRFAttenuationValue(string, out double) | Gets the nominal attenuation setting for all attenuators before the first mixer in the RF signal chain. This value is expressed in dB. |
| GetRFHighpassFilterFrequency(string, out double) | Gets the maximum corner frequency of the high pass filter in the RF signal path. The device uses the highest frequency high-pass filter option below or equal to the value you specify and returns a coerced value. Specifying a value of 0 disables high pass filtering silly.For multispan acquisitions, the device uses the appropriate filter for each subspan during acquisition, depending on the details of your application and the value you specify. In multispan acquisition spectrum applications, this method returns the value you specified rather than a coerced value if multiple high-pass filters are used during the acquisition. |
| GetRFPreampPresent(string, out bool) | Indicates whether an RF preamplifier is available on the RF downconverter module. |
| GetSelfCalibrateLastDateAndTime(string, RFmxInstrMXSelfCalibrateSteps, out DateTime) | Gets the date and time of the last successful self-calibration. Supported Devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Note For PXIe-5644/5645/5646 devices, you must select ImageSuppression for the selfCalibrateStep parameter. |
| GetSelfCalibrateLastTemperature(string, RFmxInstrMXSelfCalibrateSteps, out double) | Gets the temperature of the last successful self-calibration. This value is expresed in degree Celsius. On a MIMO session, use the selectorString parameter to get the last successful self-calibration temperature for a specific MIMO port. Supported Devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668, PXIe-5820/5830/5831 (IF only)/5832 (IF only)/5840/5841/5842/5860 Note For PXIe-5644/5645/5646 devices, you must select ImageSuppression for the selfCalibrateStep parameter. |
| GetSelfCalibrationValidityCheck(string, out RFmxInstrMXSelfCalibrationValidityCheck) | Gets whether RFmx validates the self-calibration data. |
| GetSelfCalibrationValidityCheckTimeInterval(string, out double) | Gets the minimum time between two self calibration validity checks. This value is expressed in seconds. |
| GetSerialNumber(string, out string) | Gets the serial number of the RF downconverter module. |
| GetSignalConfigurationNames(string, RFmxInstrMXPersonalities, ref string[], ref RFmxInstrMXPersonalities[]) | Returns the signal names and corresponding personality type, for the personality type selected in the personalityFilter parameter. |
| GetSmuChannel(string, out string) | Gets the output channel to be used for noise figure (NF) measurement in RFmx. |
| GetSmuResourceName(string, out string) | Gets the resource name assigned by Measurement and Automation Explorer (MAX) for NI Source Measure Units (SMU) which is used as the noise source power supply for Noise Figure (NF) measurement, for example, PXI1Slot3, where PXI1Slot3 is an instrument resource name. SMU Resource Name can also be a logical IVI name. |
| GetSParameterExternalAttenuationType(string, out RFmxInstrMXSParameterType) | 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. Supported devices: PXIe-5830/5831/5832/5840 |
| GetStartTriggerDigitalEdge(string, out RFmxInstrMXStartTriggerDigitalEdge) | Gets the active edge for the start trigger. This method is used only when you set the SetStartTriggerType(string, RFmxInstrMXStartTriggerType) method to DigitalEdge. |
| GetStartTriggerDigitalEdgeSource(string, out string) | Gets the source terminal for the start trigger. This method is used only when you set the SetStartTriggerType(string, RFmxInstrMXStartTriggerType) method to DigitalEdge. |
| GetStartTriggerExportOutputTerminal(string, out string) | Gets the destination terminal for the exported start trigger. |
| GetStartTriggerTerminalName(string, out string) | Gets the fully qualified signal name as a string. |
| GetStartTriggerType(string, out RFmxInstrMXStartTriggerType) | Gets whether the start trigger is a digital edge or a software trigger. |
| GetSubSpanOverlap(string, out double) | Gets the maximum corner frequency of the high pass filter in the RF signal path. The device uses the highest frequency high-pass filter option below or equal to the value you specify and returns a coerced value. Specifying a value of 0 disables high pass filtering silly.For multispan acquisitions, the device uses the appropriate filter for each subspan during acquisition, depending on the details of your application and the value you specify. In multispan acquisition spectrum applications, this method returns the value you specified rather than a coerced value if multiple high-pass filters are used during the acquisition. |
| GetTemperatureReadInterval(string, out double) | Gets the minimum time difference between temperature sensor readings. This value is expressed in seconds. |
| GetThermalCorrectionHeadroomRange(string, out double) | Gets the expected thermal operating range of the instrument from the self-calibration temperature returned from the GetDeviceTemperature(string, out double) method. This value is expressed in degree Celsius. |
| GetThermalCorrectionTemperatureResolution(string, out double) | Gets the temperature change required before RFmx recalculates the thermal correction settings when entering the running state. This value is expressed in degree Celsius. |
| GetTriggerExportOutputTerminal(string, out string) | Gets the destination terminal for the exported Reference Trigger. You can also choose not to export any signal. |
| GetTriggerTerminalName(string, out string) | Gets the fully-qualified signal name as a string. The standard format is as follows: |
| GetTuningSpeed(string, out RFmxInstrMXTuningSpeed) | Makes tradeoffs between tuning speed and phase noise. |
| GetWarning(out int, out string) | Gets the latest warning code and description. |
| IsSelfCalibrateValid(string, out bool, out RFmxInstrMXSelfCalibrateSteps) | Returns an array to indicate which calibration steps contain valid calibration data. To omit steps with the valid calibration data from self-calibration, you can pass the validSteps parameter to the stepsToOmit parameter of the SelfCalibrate(string, RFmxInstrMXSelfCalibrateSteps) method. On a MIMO session use the selectorString parameter to get the self-calibration validity for a specific MIMO port.supporteddevices: PXIe-5663/5663E/5665/5668 |
| LoadConfigurations(string) | Loads the methods of an RFmx session saved in a file. This file can be generated using SaveAllConfigurations(string) method or the RF Signal Analyzer panel in InstrumentStudio. You can specify the configurations to skip while loading from a file using the LoadOptions property. |
| LoadSParameterExternalAttenuationTableFromS2pFile(string, string, string, RFmxInstrMXSParameterOrientation) | Stores the S-parameter table from the S2P file in the calibration plane specified by the selectorString parameter. S-parameter tables are used for fixture de-embedding. On a MIMO session the S-parameter table is stored for each MIMO port in the specified calibration plane.supporteddevices: PXIe-5830/5831/5832/5840/5841/5842/5860 |
| ResetAttribute(string, RFmxInstrMXPropertyId) | Resets the attribute to its default value. |
| ResetDriver() | Restores the NI-RFSA driver state to a default state to avoid RFmx using any hardware or driver state that was set by the RF toolkits or other custom NI-RFSA code. |
| ResetEntireSession() | Deletes all the named signal configurations in the session and resets all methods for the default signal instances of already loaded personalities in the session. |
| ResetToDefault() | Resets the RFmxInstr methods to their default values. |
| SaveAllConfigurations(string) | Saves all the configured methods in the RFmx session to a file in the specified file path. Use this method to save the current state of the RFmx session. On a MIMO session, this method saves all the configured methods for the specified MIMO port. |
| SelectActiveExternalAttenuationTable(string, string) | Activates the external attenuation table set by the tableName parameter in the calibration plane specified by the selectorString parameter. On a MIMO session, this method selects the active external attenuation table for the specified MIMO port. The specified table will be used for amplitude correction during measurement. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860 |
| SelfCalibrate(string, RFmxInstrMXSelfCalibrateSteps) | Self-calibrates the NI-RFSA device and associated modules that support self-calibration. If self-calibration completes successfully, the new calibration constants are stored immediately in the nonvolatile memory of the module. On a MIMO session, this method self-calibrates all NI-RFSA devices and associated modules that support self-calibration. |
| SelfCalibrateRange(string, RFmxInstrMXSelfCalibrateSteps, double, double, double, double) | Self-calibrates all configurations within the specified frequency and reference level limits. If there is an open session for NI-RFSG for your device, it may remain open but cannot be used while this method runs. NI recommends that no external signals are present on the RF In port while the calibration is taking place. For more information about Self Calibrate Range, refer to the niRFSA Self Calibrate Range method topic for your device in the NI RF Vector Signal Analyzers Help. On a MIMO session, this method self-calibrates all NI-RFSA devices and associated modules that support self-calibration.supporteddevices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 |
| SendSoftwareEdgeAdvanceTrigger() | Sends a trigger to the waiting device when you choose a software version of the Advance trigger. You can also use this method to override a hardware trigger. |
| SendSoftwareEdgeStartTrigger() | Sends a trigger to the waiting device when you choose a software version of Start trigger. You can also use this method to override a hardware trigger. |
| SetAdvanceTriggerDigitalEdgeSource(string, string) | Sets the source terminal for the advance trigger. |
| SetAdvanceTriggerExportOutputTerminal(string, string) | Sets the destination terminal for the exported advance trigger. |
| SetAdvanceTriggerType(string, RFmxInstrMXAdvanceTriggerType) | Sets whether the advance trigger is a digital edge or a software trigger. |
| SetAmplitudeSettling(string, double) | Sets the amplitude settling accuracy value. This value is expressed in decibels. RFmx waits until the RF power attains the specified accuracy level after calling the RFmx Initiate method. Any specified amplitude settling value that is above the acceptable minimum value is coerced down to the closest valid value. Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 |
| SetAttributeBool(string, int, bool) | Sets the value of a Bool attribute. |
| SetAttributeByte(string, int, byte) | Sets the value of a Byte attribute. |
| SetAttributeByteArray(string, int, byte[]) | Sets the value of a byte array attribute. |
| SetAttributeComplexDoubleArray(string, int, ComplexDouble[]) | Sets the value of a ComplexDouble array attribute. |
| SetAttributeComplexSingleArray(string, int, ComplexSingle[]) | Sets the value of a ComplexSingle array attribute. |
| SetAttributeDouble(string, int, double) | Sets the value of a Double attribute. |
| SetAttributeDoubleArray(string, int, double[]) | Sets the value of a double array attribute. |
| SetAttributeFloat(string, int, float) | Sets the value of a Float attribute. |
| SetAttributeFloatArray(string, int, float[]) | Sets the value of a float array attribute. |
| SetAttributeInt(string, int, int) | Sets the value of a Int attribute. |
| SetAttributeIntArray(string, int, int[]) | Sets the value of a int array attribute. |
| SetAttributeLong(string, int, long) | Sets the value of a Long attribute. |
| SetAttributeLongArray(string, int, long[]) | Sets the value of a long array attribute. |
| SetAttributeSByte(string, int, sbyte) | Sets the value of a SByte attribute. |
| SetAttributeSByteArray(string, int, sbyte[]) | Sets the value of a sbyte array attribute. |
| SetAttributeShort(string, int, short) | Sets the value of a Short attribute. |
| SetAttributeString(string, int, string) | Sets the value of a String attribute. |
| SetAttributeUInt(string, int, uint) | Sets the value of a UInt attribute. |
| SetAttributeUIntArray(string, int, uint[]) | Sets the value of a uint array attribute. |
| SetAttributeULongArray(string, int, ulong[]) | Sets the value of a ulong array attribute. |
| SetAttributeUShort(string, int, ushort) | Sets the value of a UShort attribute. |
| SetChannelCoupling(string, RFmxInstrMXChannelCoupling) | Sets whether the RF IN connector is AC- or DC-coupled on the downconverter. |
| SetCleanerSpectrum(string, RFmxInstrMXCleanerSpectrum) | Sets how to obtain the lowest noise floor or faster measurement speed. |
| SetCommonModeLevel(string, double) | Sets the common-mode level presented at each differential input terminal. The common-mode level shifts both positive and negative terminals in the same direction. This must match the common-mode level of the device under test (DUT). This value is expressed in Volts. |
| SetDigitalGain(string, double) | Sets the scaling factor applied to the time-domain voltage data in the digitizer. This value is expressed in dB. |
| SetDigitizerDitherEnabled(string, RFmxInstrMXDigitizerDitherEnabled) | Sets whether dithering is enabled on the digitizer. |
| SetDoneEventOutputTerminal(string, string) | Sets the destination terminal for the Done event. |
| SetDownconverterCenterFrequency(string, double) | Enables in-band retuning and specifies the current frequency of the RF downconverter. This value is expressed in Hz. |
| SetDownconverterFrequencyOffset(string, double) | Sets an offset from the center frequency value for the downconverter. Use this method to offset the measurement away from the LO leakage or DC Offset of analyzers that use a direct conversion architecture. You must set this method to half the bandwidth or span of the measurement + guardband. The guardband is needed to ensure that the LO leakage is not inside the analog or digital filter rolloffs. This value is expressed in Hz. |
| SetDownconverterPreselectorEnabled(string, RFmxInstrMXDownconverterPreselectorEnabled) | Sets whether the tunable preselector is enabled on the downconverter. |
| SetEndOfRecordEventOutputTerminal(string, string) | Sets the destination terminal for the End of Record event. |
| SetFftWidth(string, double) | Sets the FFT width of the device. The FFT width is the effective bandwidth of the signal path during each signal acquisition. |
| SetFrequencyReferenceExportedTerminal(string, string) | Sets a comma-separated list of the terminals at which to export the frequency reference. |
| SetFrequencyReferenceFrequency(string, double) | Sets the Reference Clock rate, when the Frequency Reference Source method is set to ClkIn or RefIn. This value is expressed in Hz. |
| SetFrequencyReferenceSource(string, string) | Sets the frequency reference source. |
| SetFrequencySettling(string, double) | Sets the value used for LO frequency settling. Specify the units and interpretation for this scalar value using the SetFrequencySettlingUnits(string, RFmxInstrMXFrequencySettlingUnits) method. Note Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668, PXIe-5830/5831/5832/5840/5841/5842 This method is not supported if you are using an external LO. |
| SetFrequencySettlingUnits(string, RFmxInstrMXFrequencySettlingUnits) | Gets the value used for LO frequency settling. Specify the units and interpretation for this scalar value using the SetFrequencySettlingUnits(string, RFmxInstrMXFrequencySettlingUnits) method. Note Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668, PXIe-5830/5831/5832/5840/5841/5842 This method is not supported if you are using an external LO. |
| SetIFFilterBandwidth(string, double) | Sets the IF filter path bandwidth for your device configuration. |
| SetIFOutputPowerLevelOffset(string, double) | Sets the power offset by which to adjust the default IF output power level. This value is expressed in dB. |
| SetInputIsolationEnabled(string, RFmxInstrMXInputIsolationEnabled) | Sets whether input isolation is enabled. |
| SetLO2ExportEnabled(string, RFmxInstrMXLO2ExportEnabled) | Sets whether to enable the LO2 OUT terminals in the installed devices. |
| SetLoadOptions(string, RFmxInstrMXLoadOptions[]) | Specifies the configurations to skip while loading from a file using the LoadConfigurations(string) method |
| SetLOExportEnabled(string, bool) | Sets whether to enable the LO OUT terminals on the installed devices. |
| SetLOFrequency(string, double) | Sets the LO signal frequency for the configured center frequency. This value is expressed in Hz. |
| SetLOFrequencyStepSize(string, double) | Sets the step size for tuning the LO phase-locked loop (PLL). |
| SetLOInjectionSide(string, RFmxInstrMXLOInjectionSide) | Enables in-band retuning and specifies the current frequency of the RF downconverter. This value is expressed in Hz. |
| SetLOInPower(string, double) | Sets the power level expected at the LO IN terminal when the SetLOSource(string, string) method is set to RFMXINSTR_VAL_LO_SOURCE_LO_IN. This value is expressed in dBm. |
| SetLOLeakageAvoidanceEnabled(string, RFmxInstrMXLOLeakageAvoidanceEnabled) | Sets whether to reduce the effects of the instrument leakage by placing the LO outside the band of acquisition. |
| SetLOOutPower(string, double) | Sets the power level of the signal at the LO OUT terminal when the SetLOExportEnabled(string, bool) method is set to TRUE. This value is expressed in dBm. |
| SetLOPllFractionalMode(string, RFmxInstrMXLOPllFractionalMode) | Sets whether to use fractional mode for the LO phase-locked loop (PLL). |
| SetLOSharingMode(string, RFmxInstrMXLOSharingMode) | Sets the RFmx session with the respective LO sharing mode. |
| SetLOSource(string, string) | Sets the LO signal source used to downconvert the RF input signal. |
| SetLOSplitterLoss(string, double[]) | Sets an array of the insertion losses inherent to the RF Splitter. This value is expressed in dB. |
| SetLOSplitterLossFrequency(string, double[]) | Sets the frequencies corresponding to the insertion loss inherent to the RF Splitter, as specified by the SetLOSplitterLoss(string, double[]) method. This value is expressed in Hz. |
| SetLOVcoFrequencyStepSize(string, double) | Sets the step size for tuning the internal voltage-controlled oscillator (VCO) used to generate the LO signal. The valid values for LO1 include 1 Hz to 50 MHz and for LO2 include 1 Hz to 100 MHz. |
| SetMechanicalAttenuationAuto(string, RFmxInstrMXMechanicalAttenuationAuto) | Sets whether RFmx chooses an attenuation setting based on the hardware settings. |
| SetMechanicalAttenuationValue(string, double) | Sets the level of mechanical attenuation for the RF path. This value is expressed in dB. |
| SetMixerLevel(string, double) | Sets the mixer level, in dBm. |
| SetMixerLevelOffset(string, double) | Sets the number of dB by which to adjust the device mixer level. |
| SetNumberOfLOSharingGroups(string, int) | Sets the RFmx session with the number of LO sharing groups. |
| SetOptimizePathForSignalBandwidth(string, RFmxInstrMXOptimizePathForSignalBandwidth) | Optimizes RF path for the signal bandwidth that is centered on the IQ carrier frequency. |
| SetOspDelayEnabled(string, RFmxInstrMXOspDelayEnabled) | Sets whether to enable the digitizer OSP block to delay Reference Triggers, along with the data samples, moving through the OSP block. |
| SetOverflowErrorReporting(string, RFmxInstrMXOverflowErrorReporting) | Configures error reporting for ADC and overflows occurred during onboard signal processing. Overflows lead to clipping of the waveform. |
| SetPhaseOffset(string, double) | Sets the offset to apply to the initial I and Q phases. |
| SetPreampEnabled(string, RFmxInstrMXPreampEnabled) | Sets whether the RF preamplifier is enabled in the system. |
| SetReadyForAdvanceEventOutputTerminal(string, string) | Sets the destination terminal for the Ready for Advance event. |
| SetReadyForReferenceEventOutputTerminal(string, string) | Sets the destination terminal for the Ready for Reference event. |
| SetReadyForStartEventOutputTerminal(string, string) | Sets the destination terminal for the Ready for Start event. |
| SetRFAttenuationAuto(string, RFmxInstrMXRFAttenuationAuto) | Sets whether RFmx computes the RF attenuation. |
| SetRFAttenuationStepSize(string, double) | Sets the step size for the RF attenuation level. This value is expressed in dB. The actual RF attenuation is coerced up to the next highest multiple of the specified step size. If the mechanical attenuators are not available to implement the coerced RF attenuation, the solid state attenuators are used. |
| SetRFAttenuationValue(string, double) | Sets the nominal attenuation setting for all attenuators before the first mixer in the RF signal chain. This value is expressed in dB. |
| SetRFHighpassFilterFrequency(string, double) | Sets the maximum corner frequency of the high pass filter in the RF signal path. The device uses the highest frequency high-pass filter option below or equal to the value you specify and returns a coerced value. Specifying a value of 0 disables high pass filtering silly.For multispan acquisitions, the device uses the appropriate filter for each subspan during acquisition, depending on the details of your application and the value you specify. In multispan acquisition spectrum applications, this method returns the value you specified rather than a coerced value if multiple high-pass filters are used during the acquisition. |
| SetSelfCalibrationValidityCheck(string, RFmxInstrMXSelfCalibrationValidityCheck) | Sets whether RFmx validates the self-calibration data. |
| SetSelfCalibrationValidityCheckTimeInterval(string, double) | Sets the minimum time between two self calibration validity checks. This value is expressed in seconds. |
| SetSmuChannel(string, string) | Sets the output channel to be used for noise figure (NF) measurement in RFmx. |
| SetSmuResourceName(string, string) | Sets the resource name assigned by Measurement and Automation Explorer (MAX) for NI Source Measure Units (SMU) which is used as the noise source power supply for Noise Figure (NF) measurement, for example, PXI1Slot3, where PXI1Slot3 is an instrument resource name. SMU Resource Name can also be a logical IVI name. |
| SetStartTriggerDigitalEdge(string, RFmxInstrMXStartTriggerDigitalEdge) | Sets the active edge for the start trigger. This method is used only when you set the SetStartTriggerType(string, RFmxInstrMXStartTriggerType) method to DigitalEdge. |
| SetStartTriggerDigitalEdgeSource(string, string) | Sets the source terminal for the start trigger. This method is used only when you set the SetStartTriggerType(string, RFmxInstrMXStartTriggerType) method to DigitalEdge. |
| SetStartTriggerExportOutputTerminal(string, string) | Sets the destination terminal for the exported start trigger. |
| SetStartTriggerType(string, RFmxInstrMXStartTriggerType) | Sets whether the start trigger is a digital edge or a software trigger. |
| SetSubSpanOverlap(string, double) | Sets the maximum corner frequency of the high pass filter in the RF signal path. The device uses the highest frequency high-pass filter option below or equal to the value you specify and returns a coerced value. Specifying a value of 0 disables high pass filtering silly.For multispan acquisitions, the device uses the appropriate filter for each subspan during acquisition, depending on the details of your application and the value you specify. In multispan acquisition spectrum applications, this method returns the value you specified rather than a coerced value if multiple high-pass filters are used during the acquisition. |
| SetTemperatureReadInterval(string, double) | Sets the minimum time difference between temperature sensor readings. This value is expressed in seconds. |
| SetThermalCorrectionHeadroomRange(string, double) | Sets the expected thermal operating range of the instrument from the self-calibration temperature returned from the GetDeviceTemperature(string, out double) method. This value is expressed in degree Celsius. |
| SetThermalCorrectionTemperatureResolution(string, double) | Sets the temperature change required before RFmx recalculates the thermal correction settings when entering the running state. This value is expressed in degree Celsius. |
| SetTriggerExportOutputTerminal(string, string) | Sets the destination terminal for the exported Reference Trigger. You can also choose not to export any signal. |
| SetTuningSpeed(string, RFmxInstrMXTuningSpeed) | Makes tradeoffs between tuning speed and phase noise. |
| WaitForAcquisitionComplete(double) | Waits and blocks the data flow until the acquisition is complete. This method is typically called after a specific initiate method. |
| BuildCalibrationPlaneString(string) | Creates the selector string to use with External Attenuation Table methods. |
| BuildInstrumentString(string, int) | Creates the instrument string to use as the Selector String for reading the recommended settings. |
| BuildLOString(string, int) | Creates the LO string to use as the selector string for LO related methods. |
| BuildModuleString(string, string) | Configures the Module string to use as the Selector String for reading temperature of specific modules of the device. |
| BuildPortString2(string, string, string, int) | Creates the port string to use as the selector string with External Attenuation Table methods. On a MIMO session, this method can be used to build port string to use as a selector string for configuring or reading port-specific methods and external attenuation table methods. |
| GetSession(string, string) | Gets a session, if it exists for given resource name; else, returns a new one. |
| GetSession(string, string, out bool) | Gets a session, if it exists for given resource name; else, returns a new one. |
| GetSession(string[], string, out bool) | Gets a session, if it exists for given set of resource name; else, returns a new one. |
| GetSession(string[], string) | Gets a session, if it exists for given set of resource name; else, returns a new one. |
| GetSessionFromNIRfsaHandle(IntPtr) | Gets a session, if it exists for given NIRfsa instrument handle; else, returns a new one. Note 1. Do not close the NI-RFSA driver session before calling RFmx close. Closing the NI-RFSA driver session before closing RFmx session would lead to unpredictable behavior. |
| GetSessionFromNIRfsaHandles(IntPtr[]) | Gets a session, if it exists for given set of NIRfsa instrument handle; else, returns a new one. Note 1. Do not close the NI-RFSA driver session before calling RFmx close. Closing the NI-RFSA driver session before closing RFmx session would lead to unpredictable behavior. |