Embeds the inverse of a given fixture network into a specified calset. The typical use case for this utility is to remove the effect of an adapter that was present during calibration but is not present during later measurements from the Calset itself such that corrected measurements can be performed without considering the calibration adapter in the measurement de-embedding.

Syntax

int32 __stdcall RFmxVNA_CalsetEmbedFixtureS2P(niRFmxInstrHandle instrumentHandle, char selectorString[], char calsetName[], char fixtureS2PFilePath[], char vnaPort[], int32 sParameterOrientation, char newCalsetName[])

Remarks

Behaviors for different combinations of New Calset Name, Calset Name and Signal Name strings are as follows:

  • Both Calset Name and New Calset Name are "" (empty string): RFmx modifies the default calset of the signal instance specified in the Selector String, with embedding data. If you do not specify a Signal Name, then default RFmxVNA signal instance is used.

  • Calset Name is "" (empty string) and New Calset Name is non-empty string: RFmx creates a new named calset with the name specified by New Calset Name from the default calset of the signal instance specified in the Selector String and modifies the new named calset with embedding data. This newly created named calset is made accessible across all signals. If you do not specify a Signal Name, then default RFmxVNA signal instance is used.

  • Calset Name is non-empty string and New Calset Name is "" (empty string): If you do not specify a Signal Name, then RFmx modifies the existing named calset with embedding data. RFmx returns an error if you specify both Calset Name and Signal Name as non-empty strings.

  • Both Calset Name and New Calset Name are non-empty string: If you do not specify a Signal Name, then RFmx creates a new named calset with the name specified by New Calset Name from the existing named calset specified by Calset Name and modifies the new named calset with embedding data. RFmx returns an error if you specify both Calset Name and Signal Name as non-empty strings.

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter specifies the RFmx session refnum.

selectorString[in]char

This parameter specifies a Selector String comprising of the signal name. If you do not specify the signal name, the default signal instance is used. The default value is "" (empty string).

Example:

You can use the RFmxVNA_BuildSignalString function to build the selector string.

calsetName[in]char

This parameter specifies the name of the calset. If you do not specify this parameter, the calset is saved as default calset for the specified signal and is not available for use in other signals. If you specify non-empty Calset Name string, calset is saved as a named calset available for use across all signals and is also selected as the active calset for the current signal.

fixtureS2PFilePath[in]char

This parameter Specifies the path to the s2p file containing the fixture S-parameters.

vnaPort[in]char

This parameter specifies the port name of the Calset VNA port.

sParameterOrientation[in]int32

This parameter specifies the orientation of the configured fixture network with respect to VNA port.

Name (Value)

Description

Port1 Towards VNA (0)

Specifies that port1 of the fixture is towards VNA port.

Port2 Towards VNA (1)

Specifies that port2 of the fixture is towards VNA port.

newCalsetName[in]char

This parameter specifies the name under which the result Calset (with updated error coefficients) is to be saved. If empty string is provided, the updated Calset is saved back into the original Calset. That is, the original Calset is overwritten.

Returns

Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxVNA_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors