Provides methods to configure the SParams measurement.

Derives from

Syntax

Namespace: NationalInstruments.RFmx.VnaMX

public class RFmxVnaMXSParamsConfiguration : RFmxVnaMXSubObject

Methods

NameDescription
ConfigureSParameter(string, string)

Configures the S-Parameter to be measured in format S(receiver port number)(source port number)
Use "sparam(n)" as the selector string to configure this method.
This method sets SParamsSourcePort and SParamsReceiverPort methods.Supported Devices: NI PXIe-5633

ExportToSnPFile(string, string)

Exports the measured S-parameters to a SnP file.
You can set format of the exported S-Parameters using SParamsSnPDataFormat property, use SParamsSnPUserComment property to add additional comments and use SParamsSnPPorts property to specify a subset of VNA ports. This VI exports the S-Parameters associated with SnP Ports.
Case 1: You specify file extension as S<n>P. S-Parameter data for ports M+1, M+2, .., N in the exported file are zero-filled when S-Parameter data is in linear format, and are filled with -200 dB magnitude and 45 degrees angle in log format.
Example: For a 2-Port VNA, if you measure only S11 and export the S-Parameters to a *.s2p file, then resulting file will contain measured S11 data and zero-filled S21, S12 and S22 data.
Case 2: You specify file extension as S<m>P. Resulting *.s<m>p file contains S-Parameters S11, …, SMM data.
Example: For a 2-Port VNA, if you measure only S11 and export the S-Parameters to a *.s1p file, then resulting file will contain measured S11 data.</m></m></n>

GetFormat(string, out RFmxVnaMXSParamsFormat)

Gets the format of S-Parameter measurement. Use 'sparam(n)' as the selector string to configure or read this attribute.
Use RFmxVNA SParams Fetch Y Data to fetch the S-Parameters.

GetGroupDelayApertureFrequencySpan(string, out double)

Gets the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation for all S-Parameters for which SParamsFormat method is set to Group Delay and SParams Group Delay Aperture Mode method is set to Frequency Span.

GetGroupDelayApertureMode(string, out RFmxVnaMXSParamsGroupDelayApertureMode)

Gets the group delay aperture mode used for the computation of group delay for all S-Parameters for which SParamsFormat method is set to Group Delay.

GetGroupDelayAperturePercentage(string, out double)

Gets the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation, where separation is expressed as a percentage of the total measurement frequency range for all S-Parameters for which SParamsFormat method is set to Group Delay and SParams Group Delay Aperture Mode method is set to Percentage.

GetGroupDelayAperturePoints(string, out double)

Gets the group delay aperture in terms of the number of frequency points that separates the two frequency points for all S-Parameters for which SParamsFormat method is set to Group Delay and SParams Group Delay Aperture Mode method is set to Points. You must set the value of this method between 2 and the total number of frequency points in the measurement frequency range.

GetMagnitudeUnits(string, out RFmxVnaMXSParamsMagnitudeUnits)

Gets the magnitude units for all S-Parameters for which you set SParamsFormat method to Magnitude.

GetMathActiveMeasurementMemory(string, out string)

Gets the active measurement memory for performing mathematical operation when several measurement memories are associated with the configured S-Parameter. If only one measurement memory is associated with the configured S-Parameter, that measurement memory will be used for mathematical operations.

GetMathFunction(string, out RFmxVnaMXSParamsMathFunction)

Gets the mathematical operation between the configured S-Parameter and its active measurement memory. All mathematical operations are applied on complex data before being formatted.

GetMeasurementEnabled(string, out bool)

Gets whether to enable the Sparams measurement.

GetNumberOfSParameters(string, out int)

Gets the number of S-Parameters to measure.

GetParameter(string, out string)

Gets the measured S-Parameter denoted by "S_(receiver port number)_(source port number)".

GetPhaseTraceType(string, out RFmxVnaMXSParamsPhaseTraceType)

Gets the phase type for all S-Parameters for which SParamsFormat method is set to Phase. Phase can be represented in two mathematically equivalent ways viz. phase wrapped between the range [-180, 180) degrees, and phase can be represented in an unwrapped manner.

GetReceiverPort(string, out string)

Gets the receiver port name of the S-Parameter. S-Parameter is denoted by "S_(receiver port name)_(receiver port name)".For example, to measure S_port2_port1, set this method to "port2".

GetSnPDataFormat(string, out RFmxVnaMXSParamsSnPDataFormat)

Gets the SParams Data Format of the S-parameter measurement to be saved.

GetSnPPorts(string, out string)

Gets the Ports for which the S-parameter measurement is saved to file.

GetSnPUserComment(string, out string)

Gets user-specific additional information passed as SParams User Comment to write to SnP file.

GetSourcePort(string, out string)

Gets the source port name of the S-Parameter. S-Parameter is denoted by "S_(receiver port name)_(receiver port name)".For example, to measure S_port2_port1, set this method to "port1".

GetSParameter(string, out string)

Returns the S-Parameter being measured in format S(receiver port number)(source port number)
Use "sparam(n)" as the selector string for this method.Supported Devices: NI PXIe-5633

SetFormat(string, RFmxVnaMXSParamsFormat)

Sets the format of S-Parameter measurement. Use 'sparam(n)' as the selector string to configure or read this attribute.
Use RFmxVNA SParams Fetch Y Data to fetch the S-Parameters.

SetGroupDelayApertureFrequencySpan(string, double)

Sets the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation for all S-Parameters for which SParamsFormat method is set to Group Delay and SParams Group Delay Aperture Mode method is set to Frequency Span.

SetGroupDelayApertureMode(string, RFmxVnaMXSParamsGroupDelayApertureMode)

Sets the group delay aperture mode used for the computation of group delay for all S-Parameters for which SParamsFormat method is set to Group Delay.

SetGroupDelayAperturePercentage(string, double)

Sets the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation, where separation is expressed as a percentage of the total measurement frequency range for all S-Parameters for which SParamsFormat method is set to Group Delay and SParams Group Delay Aperture Mode method is set to Percentage.

SetGroupDelayAperturePoints(string, double)

Sets the group delay aperture in terms of the number of frequency points that separates the two frequency points for all S-Parameters for which SParamsFormat method is set to Group Delay and SParams Group Delay Aperture Mode method is set to Points. You must set the value of this method between 2 and the total number of frequency points in the measurement frequency range.

SetMagnitudeUnits(string, RFmxVnaMXSParamsMagnitudeUnits)

Sets the magnitude units for all S-Parameters for which you set SParamsFormat method to Magnitude.

SetMathActiveMeasurementMemory(string, string)

Sets the active measurement memory for performing mathematical operation when several measurement memories are associated with the configured S-Parameter. If only one measurement memory is associated with the configured S-Parameter, that measurement memory will be used for mathematical operations.

SetMathFunction(string, RFmxVnaMXSParamsMathFunction)

Sets the mathematical operation between the configured S-Parameter and its active measurement memory. All mathematical operations are applied on complex data before being formatted.

SetMeasurementEnabled(string, bool)

Sets whether to enable the Sparams measurement.

SetNumberOfSParameters(string, int)

Sets the number of S-Parameters to measure.

SetParameter(string, string)

Sets the measured S-Parameter denoted by "S_(receiver port number)_(source port number)". For example, to measure S-Parameter for receiver port 2 and source port 1, set this method to "S21".

SetPhaseTraceType(string, RFmxVnaMXSParamsPhaseTraceType)

Sets the phase type for all S-Parameters for which SParamsFormat method is set to Phase. Phase can be represented in two mathematically equivalent ways viz. phase wrapped between the range [-180, 180) degrees, and phase can be represented in an unwrapped manner.

SetReceiverPort(string, string)

Sets the receiver port name of the S-Parameter. S-Parameter is denoted by "S_(receiver port name)_(receiver port name)".For example, to measure S_port2_port1, set this method to "port2".

SetSnPDataFormat(string, RFmxVnaMXSParamsSnPDataFormat)

Sets the SParams Data Format of the S-parameter measurement to be saved.

SetSnPPorts(string, string)

Sets the Ports for which the S-parameter measurement is saved to file.

SetSnPUserComment(string, string)

Sets user-specific additional information passed as SParams User Comment to write to SnP file.

SetSourcePort(string, string)

Sets the source port name of the S-Parameter. S-Parameter is denoted by "S_(receiver port name)_(receiver port name)".For example, to measure S_port2_port1, set this method to "port1".