RFmxInstrMX Class
- Updated2024-07-17
- 41 minute(s) read
RFmx
Defines a root class which is used to identify and control Instr signal configuration.
Inheritance Hierarchy
Namespace: NationalInstruments.RFmx.InstrMX
Assembly: NationalInstruments.RFmx.InstrMX.Fx40 (in NationalInstruments.RFmx.InstrMX.Fx40.dll) Version: 24.5.0.49285 (24.5.0.49285)
Syntax
public sealed class RFmxInstrMX : IDisposable
Public NotInheritable Class RFmxInstrMX Implements IDisposable
The RFmxInstrMX type exposes the following members.
Constructors
| Name | Description | |||
|---|---|---|---|---|
 | RFmxInstrMX(IntPtr) | Creates a new RFmx session from an existing RFmx instrument handle. | ||
| RFmxInstrMX(String, String) |
Creates an RFmx session to the device you specify through the resourceName parameter.
| ||
| RFmxInstrMX(String, String) |
Creates an RFmx session to the device you specify through the resourceName parameter.
|
NoteProperties
| 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 | |||
|---|---|---|---|---|
 | BuildCalibrationPlaneString |
Creates the selector string to use with External Attenuation Table methods. | ||
| BuildInstrumentString |
Creates the instrument string to use as the Selector String for reading the recommended settings. | ||
| BuildLOString |
Creates the LO string to use as the selector string for LO related methods. | ||
| BuildModuleString |
Configures the Module string to use as the Selector String for reading temperature of specific modules of the device. | ||
| BuildPortString2 |
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. | ||
| CheckAcquisitionStatus |
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 |
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 |
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. | ||
| ConfigureExternalAttenuationInterpolationLinear |
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. Currently interpolation is supported only for S-parameter tables. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860 | ||
| ConfigureExternalAttenuationInterpolationNearest |
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. Currently interpolation is supported only for S-parameter tables. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5860 | ||
| ConfigureExternalAttenuationInterpolationSpline |
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. Currently interpolation is supported only for S-parameter tables. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860 | ||
| ConfigureExternalAttenuationTable |
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. If there is only one table configured in any calibration plane, it is automatically selected as the active table. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860 | ||
| ConfigureFrequencyReference |
Configures the Reference Clock and the frequency reference source. | ||
| ConfigureMechanicalAttenuation |
Configures the mechanical attenuation and RFmx attenuation hardware settings. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668 | ||
| ConfigureRFAttenuation |
Configures the nominal attenuation and RFmx setting. supporteddevices: PXIe-5663/5663E, PXIe-5665, PXIe-5668 | ||
| ConfigureSParameterExternalAttenuationTable |
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 If there is only one table configured in any calibration plane, it is automatically selected as the active table. | ||
| ConfigureSParameterExternalAttenuationType |
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 |
Returns the value of the underlying instrument handle.
| ||
| DangerousGetNIRfsaHandleArray |
Returns list of underlying instrument handles.
| ||
| DeleteAllExternalAttenuationTables |
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 |
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 |
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 | Deletes the signal configuration if it is not the default signal configuration and clears any trace of the current signal configuration, if any. | ||
| EnableCalibrationPlane |
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 | ||
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object) | ||
| ExportSignal |
Routes signals (triggers, clocks, and events) to the specified output terminal. This method is not supported on a MIMO session. | ||
| FetchRawIQData | 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 | Gets the source terminal for the advance trigger. | ||
| GetAdvanceTriggerExportOutputTerminal | Gets the destination terminal for the exported advance trigger. | ||
| GetAdvanceTriggerTerminalName | Gets the fully qualified signal name as a string. | ||
| GetAdvanceTriggerType | Gets whether the advance trigger is a digital edge or a software trigger. | ||
| GetAmplitudeSettling | 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 | Gets the value of a Bool attribute. | ||
| GetAttributeByte | Gets the value of a Byte attribute. | ||
| GetAttributeByteArray | Gets the value of a byte array attribute. | ||
| GetAttributeComplexDoubleArray | Gets the value of a ComplexDouble array attribute. | ||
| GetAttributeComplexSingleArray | Gets the value of a ComplexSingle array attribute. | ||
| GetAttributeDouble | Gets the value of a Double attribute. | ||
| GetAttributeDoubleArray | Gets the value of a double array attribute. | ||
| GetAttributeFloat | Gets the value of a Float attribute. | ||
| GetAttributeFloatArray | Gets the value of a float array attribute. | ||
| GetAttributeInt | Gets the value of an RFmx 32-bit integer (int32) attribute. | ||
| GetAttributeIntArray | Gets the value of a int array attribute. | ||
| GetAttributeLong | Gets the value of an RFmx 64-bit integer (int64) attribute. | ||
| GetAttributeLongArray | Gets the value of a long array attribute. | ||
| GetAttributeSByte | Gets the value of a SByte attribute. | ||
| GetAttributeSByteArray | Gets the value of a sbyte array attribute. | ||
| GetAttributeShort | Gets the value of a Short attribute. | ||
| GetAttributeString | Gets the value of a string attribute. | ||
| GetAttributeUInt | Gets the value of a uint attribute. | ||
| GetAttributeUIntArray | Gets the value of a uint array attribute. | ||
| GetAttributeULongArray | Gets the value of a ulong array attribute. | ||
| GetAttributeUShort | Gets the value of a UShort attribute. | ||
| GetAvailablePaths | Gets paths available for the session. On a MIMO session, this method fetches all the paths for the initialized MIMO paths. | ||
| GetAvailablePorts(String) | Obsolete. Gets the list of ports available for use based on your instrument configuration. | ||
| GetAvailablePorts(String, String) | Gets ports available for the session. On a MIMO session, this method fetches all the ports for the initialized MIMO ports. | ||
| GetChannelCoupling | Gets whether the RF IN connector is AC- or DC-coupled on the downconverter. | ||
| GetCleanerSpectrum | Gets how to obtain the lowest noise floor or faster measurement speed. | ||
| GetCommonModeLevel | 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 | Gets the current temperature of the module. This value is expressed in degrees Celsius. | ||
| GetDigitalGain | Gets the scaling factor applied to the time-domain voltage data in the digitizer. This value is expressed in dB. | ||
| GetDigitizerDitherEnabled | Gets whether dithering is enabled on the digitizer. | ||
| GetDigitizerTemperature | Gets the current temperature of the digitizer module. This value is expressed in degrees Celsius. | ||
| GetDoneEventOutputTerminal | Gets the destination terminal for the Done event. | ||
| GetDoneEventTerminalName | Gets the fully qualified signal name as a string. | ||
| GetDownconverterCenterFrequency | Enables in-band retuning and specifies the current frequency of the RF downconverter. This value is expressed in Hz. | ||
| GetDownconverterFrequencyOffset | 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 | 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 | Gets whether the tunable preselector is enabled on the downconverter. | ||
| GetEndOfRecordEventOutputTerminal | Gets the destination terminal for the End of Record event. | ||
| GetEndOfRecordEventTerminalName | Gets the fully qualified signal name as a string. | ||
| GetErrorString | Converts the status code returned by an RFmxInstr function into a string. | ||
| GetExternalAttenuationTableActualValue | Returns the external attenuation table actual value that is applied to the measurements for a specified signal and calibration plane. | ||
| GetFftWidth | Gets the FFT width of the device. The FFT width is the effective bandwidth of the signal path during each signal acquisition. | ||
| GetFrequencyReferenceExportedTerminal | Gets a comma-separated list of the terminals at which to export the frequency reference. | ||
| GetFrequencyReferenceFrequency | Gets the Reference Clock rate, when the Frequency Reference Source method is set to ClkIn or RefIn. This value is expressed in Hz. | ||
| GetFrequencyReferenceSource | Gets the frequency reference source. | ||
| GetFrequencySettling | Gets the value used for LO frequency settling. | ||
| GetFrequencySettlingUnits | Gets the delay duration units and interpretation for LO settling. | ||
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object) | ||
| GetIFFilterBandwidth | Gets the IF filter path bandwidth for your device configuration. | ||
| GetIFOutputPowerLevelOffset | Gets the power offset by which to adjust the default IF output power level. This value is expressed in dB. | ||
| GetInputIsolationEnabled | Gets whether input isolation is enabled. | ||
| GetInstrumentFirmwareRevision | 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 | Gets a string that contains the model number or name of the RF device that you are currently using. | ||
| GetListNames | 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 | Gets whether to enable the LO2 OUT terminals in the installed devices. | ||
| GetLoadOptions |
Specifies the configurations to skip while loading from a file using the LoadConfigurations(String) method | ||
| GetLOExportEnabled | Gets whether to enable the LO OUT terminals on the installed devices. | ||
| GetLOFrequency | Gets the LO signal frequency for the configured center frequency. This value is expressed in Hz. | ||
| GetLOFrequencyStepSize | Gets the step size for tuning the LO phase-locked loop (PLL). | ||
| GetLOInjectionSide | Enables in-band retuning and specifies the current frequency of the RF downconverter. This value is expressed in Hz. | ||
| GetLOInPower | 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 | Gets whether to reduce the effects of the instrument leakage by placing the LO outside the band of acquisition. | ||
| GetLOOutPower | Gets the power level of the signal at the LO OUT terminal when the SetLOExportEnabled(String, Boolean) method is set to TRUE. This value is expressed in dBm. | ||
| GetLOPllFractionalMode | Gets whether to use fractional mode for the LO phase-locked loop (PLL). | ||
| GetLOSharingMode | Gets the RFmx session with the respective LO sharing mode. | ||
| GetLOSource | Gets the LO signal source used to downconvert the RF input signal. | ||
| GetLOTemperature | Gets the current temperature of the LO module associated with the device. This value is expressed in degrees Celsius. | ||
| GetLOVcoFrequencyStepSize | 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 | Gets whether RFmx chooses an attenuation setting based on the hardware settings. | ||
| GetMechanicalAttenuationValue | Gets the level of mechanical attenuation for the RF path. This value is expressed in dB. | ||
| GetMixerLevel | Gets the mixer level, in dBm. | ||
| GetMixerLevelOffset | Gets the number of dB by which to adjust the device mixer level. | ||
| GetModuleRevision | Gets the revision of the RF downconverter module. | ||
| GetNumberOfLOSharingGroups | Gets the RFmx session with the number of LO sharing groups. | ||
| GetNumberOfRawIQRecords | Gets the number of raw IQ records to acquire to complete measurement averaging. | ||
| GetOptimizePathForSignalBandwidth | Optimizes RF path for the signal bandwidth that is centered on the IQ carrier frequency. | ||
| GetOspDelayEnabled | Gets whether to enable the digitizer OSP block to delay Reference Triggers, along with the data samples, moving through the OSP block. | ||
| GetOverflowErrorReporting | Configures error reporting for ADC and overflows occurred during onboard signal processing. Overflows lead to clipping of the waveform. | ||
| GetPhaseOffset | Gets the offset to apply to the initial I and Q phases. | ||
| GetPreampEnabled | Gets whether the RF preamplifier is enabled in the system. | ||
| GetPreselectorPresent | Indicates whether a preselector is available on the RF downconverter module. | ||
| GetReadyForAdvanceEventOutputTerminal | Gets the destination terminal for the Ready for Advance event. | ||
| GetReadyForAdvanceEventTerminalName | Gets the fully qualified signal name as a string. | ||
| GetReadyForReferenceEventOutputTerminal | Gets the destination terminal for the Ready for Reference event. | ||
| GetReadyForReferenceEventTerminalName | Gets the fully qualified signal name as a string. | ||
| GetReadyForStartEventOutputTerminal | Gets the destination terminal for the Ready for Start event. | ||
| GetReadyForStartEventTerminalName | Gets the fully qualified signal name as a string. | ||
| GetRecommendedAcquisitionType |
Gets the recommended acquisition type for the last committed measurement configuration. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedCenterFrequency |
Gets the recommended center frequency of the RF signal. This value is expressed in Hz. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedIQAcquisitionTime |
Gets the recommended acquisition time for I/Q acquisition, in seconds. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedIQMinimumSampleRate |
Gets the recommended minimum sample rate for I/Q acquisition, in Hz. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedIQPreTriggerTime |
Gets the recommended pretrigger time for I/Q acquisition, in seconds. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedNumberOfRecords |
Gets the recommended number of records to acquire to complete measurement averaging. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedSpectralAcquisitionSpan |
Gets the recommended acquisition span for spectral acquisition, in Hz. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedSpectralFftWindow |
Gets the recommended FFT window type for spectral acquisition. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedSpectralResolutionBandwidth |
Gets the recommended FFT bin width for spectral acquisition. This value is expressed in Hz. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRecommendedTriggerMinimumQuietTime |
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. This method is supported when 1. RFmxInstrMX(String, String) is called with option string "AnalysisOnly=1". 2. RFmxInstrMX(String, String) is called with option string 'AnalysisOnly=1;MaxNumWfms:n'. Use 'instr(n)' as the selector string to read this method. | ||
| GetRFAttenuationAuto | Gets whether RFmx computes the RF attenuation. | ||
| GetRFAttenuationStepSize | 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 | Gets the nominal attenuation setting for all attenuators before the first mixer in the RF signal chain. This value is expressed in dB. | ||
| GetRFHighpassFilterFrequency | 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 | Indicates whether an RF preamplifier is available on the RF downconverter module. | ||
| GetSelfCalibrateLastDateAndTime |
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
| ||
| GetSelfCalibrateLastTemperature |
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
| ||
| GetSelfCalibrationValidityCheck | Gets whether RFmx validates the self-calibration data. | ||
| GetSelfCalibrationValidityCheckTimeInterval | Gets the minimum time between two self calibration validity checks. This value is expressed in seconds. | ||
| GetSerialNumber | Gets the serial number of the RF downconverter module. | ||
| GetSession(String, String) | Gets a session, if it exists for given 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. | ||
| GetSession(String, String, Boolean) | Gets a session, if it exists for given resource name; else, returns a new one. | ||
| GetSession(String, String, Boolean) | Gets a session, if it exists for given set of resource name; else, returns a new one. | ||
| GetSessionFromNIRfsaHandle |
Gets a session, if it exists for given NIRfsa instrument handle; else, returns a new one.
| ||
| GetSessionFromNIRfsaHandles |
Gets a session, if it exists for given set of NIRfsa instrument handle; else, returns a new one.
| ||
| GetSignalConfigurationNames | Returns the signal names and corresponding personality type, for the personality type selected in the personalityFilter parameter. | ||
| GetSmuChannel | Gets the output channel to be used for noise figure (NF) measurement in RFmx. | ||
| GetSmuResourceName | 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 | 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 | Gets the active edge for the start trigger. This method is used only when you set the SetStartTriggerType(String, RFmxInstrMXStartTriggerType) method to DigitalEdge. | ||
| GetStartTriggerDigitalEdgeSource | Gets the source terminal for the start trigger. This method is used only when you set the SetStartTriggerType(String, RFmxInstrMXStartTriggerType) method to DigitalEdge. | ||
| GetStartTriggerExportOutputTerminal | Gets the destination terminal for the exported start trigger. | ||
| GetStartTriggerTerminalName | Gets the fully qualified signal name as a string. | ||
| GetStartTriggerType | Gets whether the start trigger is a digital edge or a software trigger. | ||
| GetSubSpanOverlap | 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 | Gets the minimum time difference between temperature sensor readings. This value is expressed in seconds. | ||
| GetThermalCorrectionHeadroomRange | Gets the expected thermal operating range of the instrument from the self-calibration temperature returned from the GetDeviceTemperature(String, Double) method. This value is expressed in degree Celsius. | ||
| GetThermalCorrectionTemperatureResolution | 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 | Gets the destination terminal for the exported Reference Trigger. You can also choose not to export any signal. | ||
| GetTriggerTerminalName |
Gets the fully-qualified signal name as a string. The standard format is as follows: Supported devices: PXIe-5663/5663E/5665/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 | ||
| GetTuningSpeed | Makes tradeoffs between tuning speed and phase noise. | ||
| GetType | Gets the Type of the current instance. (Inherited from Object) | ||
| GetWarning | Gets the latest warning code and description. | ||
| IsSelfCalibrateValid |
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 |
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. If the file contains a named signal configuration which is already present in the session, then this method will return an error. It is recommended to call the RFmxInstr Reset Entire Session method to delete all the named signal configurations in the session. | ||
| LoadSParameterExternalAttenuationTableFromS2pFile |
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 If there is only one table configured in any calibration plane, it is automatically selected as the active table. | ||
| ResetAttribute | 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. Use this method when you switch back to using RFmx to perform measurements after you have used the NI-RFSA handle to perform measurements with RF toolkits or you have used other custom NI-RFSA code. Unlike the ResetToDefault method, the RfmxInstr Reset Driver method does not reset RFmx methods configured on the RFmx session. Hence, you do not need to set RFmx methods again when switching back to RFmx measurements. Refer to RFmx SpecAn CHP - WCDMA ModAcc - CHP Example (LabVIEW) on ni.com for more information about using RFmx to perform measurements. | ||
| 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. This method disables all the calibration planes. | ||
| ResetToDefault |
Resets the RFmxInstr methods to their default values. This method disables all the calibration planes. | ||
| SaveAllConfigurations |
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.
List configurations, reference waveforms and external attenuation tables are not saved by this method. | ||
| SelectActiveExternalAttenuationTable |
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 |
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. Refer to the specifications document for your device for more information about how often to self-calibrate. For more information about Self Calibrate, refer to the niRFSA Self Cal method topic for your device in the NI RF Vector Signal Analyzers Help. For PXIe-5644/5645/5646, RFmx internally closes the RFSA session, performs self-calibration and opens a new session for the same device. If the RFSA session has been accessed from RFmx, using the RFmxInstr Get NIRFSA Session method before calling the RFmxInstr Self Calibrate method, the RFSA session will become invalid upon calling the RFmxInstr Self Calibrate. supporteddevices: PXIe-5663/5663E/5665/5668, PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 | ||
| SelfCalibrateRange |
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 This method does not update self-calibration date and temperature. Self-calibration range data is not saved to your device if you restart the system. | ||
| 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.
This method returns an error if:
| ||
| 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.
This method returns an error if:
| ||
| SetAdvanceTriggerDigitalEdgeSource | Sets the source terminal for the advance trigger. | ||
| SetAdvanceTriggerExportOutputTerminal | Sets the destination terminal for the exported advance trigger. | ||
| SetAdvanceTriggerType | Sets whether the advance trigger is a digital edge or a software trigger. | ||
| SetAmplitudeSettling |
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 | Sets the value of a Bool attribute. | ||
| SetAttributeByte | Sets the value of a Byte attribute. | ||
| SetAttributeByteArray | Sets the value of a byte array attribute. | ||
| SetAttributeComplexDoubleArray | Sets the value of a ComplexDouble array attribute. | ||
| SetAttributeComplexSingleArray | Sets the value of a ComplexSingle array attribute. | ||
| SetAttributeDouble | Sets the value of a Double attribute. | ||
| SetAttributeDoubleArray | Sets the value of a double array attribute. | ||
| SetAttributeFloat | Sets the value of a Float attribute. | ||
| SetAttributeFloatArray | Sets the value of a float array attribute. | ||
| SetAttributeInt | Sets the value of a Int attribute. | ||
| SetAttributeIntArray | Sets the value of a int array attribute. | ||
| SetAttributeLong | Sets the value of a Long attribute. | ||
| SetAttributeLongArray | Sets the value of a long array attribute. | ||
| SetAttributeSByte | Sets the value of a SByte attribute. | ||
| SetAttributeSByteArray | Sets the value of a sbyte array attribute. | ||
| SetAttributeShort | Sets the value of a Short attribute. | ||
| SetAttributeString | Sets the value of a String attribute. | ||
| SetAttributeUInt | Sets the value of a UInt attribute. | ||
| SetAttributeUIntArray | Sets the value of a uint array attribute. | ||
| SetAttributeULongArray | Sets the value of a ulong array attribute. | ||
| SetAttributeUShort | Sets the value of a UShort attribute. | ||
| SetChannelCoupling | Sets whether the RF IN connector is AC- or DC-coupled on the downconverter. | ||
| SetCleanerSpectrum | Sets how to obtain the lowest noise floor or faster measurement speed. | ||
| SetCommonModeLevel | 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 | Sets the scaling factor applied to the time-domain voltage data in the digitizer. This value is expressed in dB. | ||
| SetDigitizerDitherEnabled | Sets whether dithering is enabled on the digitizer. | ||
| SetDoneEventOutputTerminal | Sets the destination terminal for the Done event. | ||
| SetDownconverterCenterFrequency | Enables in-band retuning and specifies the current frequency of the RF downconverter. This value is expressed in Hz. | ||
| SetDownconverterFrequencyOffset | 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 | Sets whether the tunable preselector is enabled on the downconverter. | ||
| SetEndOfRecordEventOutputTerminal | Sets the destination terminal for the End of Record event. | ||
| SetFftWidth | Sets the FFT width of the device. The FFT width is the effective bandwidth of the signal path during each signal acquisition. | ||
| SetFrequencyReferenceExportedTerminal | Sets a comma-separated list of the terminals at which to export the frequency reference. | ||
| SetFrequencyReferenceFrequency | Sets the Reference Clock rate, when the Frequency Reference Source method is set to ClkIn or RefIn. This value is expressed in Hz. | ||
| SetFrequencyReferenceSource | Sets the frequency reference source. | ||
| SetFrequencySettling |
Sets the value used for LO frequency settling.
Specify the units and interpretation for this scalar value using the SetFrequencySettlingUnits(String, RFmxInstrMXFrequencySettlingUnits) method.
Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668, PXIe-5830/5831/5832/5840/5841/5842/5860 | ||
| SetFrequencySettlingUnits |
Gets the value used for LO frequency settling. Specify the units and interpretation for this scalar value using the SetFrequencySettlingUnits(String, RFmxInstrMXFrequencySettlingUnits) method.
Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668, PXIe-5830/5831/5832/5840/5841/5842/5860 | ||
| SetIFFilterBandwidth | Sets the IF filter path bandwidth for your device configuration. | ||
| SetIFOutputPowerLevelOffset | Sets the power offset by which to adjust the default IF output power level. This value is expressed in dB. | ||
| SetInputIsolationEnabled | Sets whether input isolation is enabled. | ||
| SetLO2ExportEnabled | Sets whether to enable the LO2 OUT terminals in the installed devices. | ||
| SetLoadOptions |
Specifies the configurations to skip while loading from a file using the LoadConfigurations(String) method | ||
| SetLOExportEnabled | Sets whether to enable the LO OUT terminals on the installed devices. | ||
| SetLOFrequency | Sets the LO signal frequency for the configured center frequency. This value is expressed in Hz. | ||
| SetLOFrequencyStepSize | Sets the step size for tuning the LO phase-locked loop (PLL). | ||
| SetLOInjectionSide | Enables in-band retuning and specifies the current frequency of the RF downconverter. This value is expressed in Hz. | ||
| SetLOInPower | 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 | Sets whether to reduce the effects of the instrument leakage by placing the LO outside the band of acquisition. | ||
| SetLOOutPower | Sets the power level of the signal at the LO OUT terminal when the SetLOExportEnabled(String, Boolean) method is set to TRUE. This value is expressed in dBm. | ||
| SetLOPllFractionalMode | Sets whether to use fractional mode for the LO phase-locked loop (PLL). | ||
| SetLOSharingMode | Sets the RFmx session with the respective LO sharing mode. | ||
| SetLOSource | Sets the LO signal source used to downconvert the RF input signal. | ||
| SetLOVcoFrequencyStepSize | 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 | Sets whether RFmx chooses an attenuation setting based on the hardware settings. | ||
| SetMechanicalAttenuationValue | Sets the level of mechanical attenuation for the RF path. This value is expressed in dB. | ||
| SetMixerLevel | Sets the mixer level, in dBm. | ||
| SetMixerLevelOffset | Sets the number of dB by which to adjust the device mixer level. | ||
| SetNumberOfLOSharingGroups | Sets the RFmx session with the number of LO sharing groups. | ||
| SetOptimizePathForSignalBandwidth | Optimizes RF path for the signal bandwidth that is centered on the IQ carrier frequency. | ||
| SetOspDelayEnabled | Sets whether to enable the digitizer OSP block to delay Reference Triggers, along with the data samples, moving through the OSP block. | ||
| SetOverflowErrorReporting | Configures error reporting for ADC and overflows occurred during onboard signal processing. Overflows lead to clipping of the waveform. | ||
| SetPhaseOffset | Sets the offset to apply to the initial I and Q phases. | ||
| SetPreampEnabled | Sets whether the RF preamplifier is enabled in the system. | ||
| SetReadyForAdvanceEventOutputTerminal | Sets the destination terminal for the Ready for Advance event. | ||
| SetReadyForReferenceEventOutputTerminal | Sets the destination terminal for the Ready for Reference event. | ||
| SetReadyForStartEventOutputTerminal | Sets the destination terminal for the Ready for Start event. | ||
| SetRFAttenuationAuto | Sets whether RFmx computes the RF attenuation. | ||
| SetRFAttenuationStepSize | 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 | Sets the nominal attenuation setting for all attenuators before the first mixer in the RF signal chain. This value is expressed in dB. | ||
| SetRFHighpassFilterFrequency | 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 | Sets whether RFmx validates the self-calibration data. | ||
| SetSelfCalibrationValidityCheckTimeInterval | Sets the minimum time between two self calibration validity checks. This value is expressed in seconds. | ||
| SetSmuChannel | Sets the output channel to be used for noise figure (NF) measurement in RFmx. | ||
| SetSmuResourceName | 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 | Sets the active edge for the start trigger. This method is used only when you set the SetStartTriggerType(String, RFmxInstrMXStartTriggerType) method to DigitalEdge. | ||
| SetStartTriggerDigitalEdgeSource | Sets the source terminal for the start trigger. This method is used only when you set the SetStartTriggerType(String, RFmxInstrMXStartTriggerType) method to DigitalEdge. | ||
| SetStartTriggerExportOutputTerminal | Sets the destination terminal for the exported start trigger. | ||
| SetStartTriggerType | Sets whether the start trigger is a digital edge or a software trigger. | ||
| SetSubSpanOverlap | 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 | Sets the minimum time difference between temperature sensor readings. This value is expressed in seconds. | ||
| SetThermalCorrectionHeadroomRange | Sets the expected thermal operating range of the instrument from the self-calibration temperature returned from the GetDeviceTemperature(String, Double) method. This value is expressed in degree Celsius. | ||
| SetThermalCorrectionTemperatureResolution | 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 | Sets the destination terminal for the exported Reference Trigger. You can also choose not to export any signal. | ||
| SetTuningSpeed | Makes tradeoffs between tuning speed and phase noise. | ||
| ToString | Returns a string that represents the current object. (Inherited from Object) | ||
| WaitForAcquisitionComplete |
Waits and blocks the data flow until the acquisition is complete. This method is typically called after a specific initiate method. |
Remarks
For more information about RFmx Instruments, refer to RFmx Instruments Help.