RFmxInstrMX.ConfigureSParameterExternalAttenuationType Method
- Updated2024-07-17
- 2 minute(s) read
RFmx
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
supporteddevices: PXIe-5830/5831/5832/5840/5841/5842/5860
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 int ConfigureSParameterExternalAttenuationType( string selectorString, RFmxInstrMXSParameterType sParameterType )
Public Function ConfigureSParameterExternalAttenuationType ( selectorString As String, sParameterType As RFmxInstrMXSParameterType ) As Integer
Parameters
- selectorString String
-
Specifies the calibration plane name in which either S-parameter or external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.
On a MIMO session if you do not specify the port name, this configuration is applied to all MIMO ports in the session for the default calibration plane instance. To configure S-parameter external attenuation type for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note
For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector is "calplane::<calplaneName>/port::<portName>". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::(calplaneName)/port::(deviceName)/(channelNumber)/(portName)". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstrMX.GetAvailablePorts method to get the valid port names. Example:
""
"calplane::plane0"
"calplane::plane0/port::if0"
"port::if0"
"calplane::plane0/port::all"
- sParameterType RFmxInstrMXSParameterType
-
Specifies the type of S-parameter which applies to measurements on the specified port for a Calplane. If you set this parameter to Scalar or Vector, RFmx adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT.
PXIe-5831/5832: Valid values for this parameter are Scalar and Vector. Vector is only supported for TRX Ports in a Semiconductor Test System (STS).
PXIe-5840/5841/5842/5860: The only valid value for this parameter is Scalar.
Scalar (1): De-embeds the measurement using the gain term.
Vector (2): De-embeds the measurement using the gain term and the reflection term.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.