Returns values for a specific error term from either the default calset of the specified signal or a named calset accessible across all signals.

Syntax

int32 __stdcall RFmxVNA_CalsetGetErrorTerm(niRFmxInstrHandle instrumentHandle, char selectorString[], char calsetName[], int32 errorTermIdentifier, char measurementPort[], char sourcePort[], NIComplexSingle errorTerm[], int32 arraySize, int32 *actualArraySize)

Remarks

  • Calset Name is "" (empty string): RFmx returns the error term values from the default calset of the signal instance specified in the Selector String. If you do not specify a Signal Name, then default RFmxVNA signal instance is used.

  • Calset Name is non-empty string: If you do not specify a Signal Name, then RFmx returns the error term values from the named calset. 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.

errorTermIdentifier[in]int32

This parameter specifies the type of error term in the calset.

The error term can take the following values:

<ring> <ringvalue value="0"> <name>Directivity</name> <shortdescription>

Directivity measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> <ringvalue value="1"> <name>Source Match</name> <shortdescription>

Source Match measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> <ringvalue value="2"> <name>Reflection Tracking</name> <shortdescription>

Reflection Tracking measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> <ringvalue value="3"> <name>Transmission Tracking</name> <shortdescription>

Transmission Tracking measured at Measurement Port with Source Port being the source port. </shortdescription> </ringvalue> <ringvalue value="4"> <name>Load Match</name> <shortdescription>

Load Match measured at Measurement Port with Source Port being the source port. </shortdescription> </ringvalue> <ringvalue value="5"> <name>K</name> <shortdescription>

K measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> <ringvalue value="6"> <name>alpha</name> <shortdescription>

alpha measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> <ringvalue value="7"> <name>beta</name> <shortdescription>

beta measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> <ringvalue value="8"> <name>gamma</name> <shortdescription>

gamma measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> <ringvalue value="9"> <name>delta</name> <shortdescription>

delta measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> <ringvalue value="10"> <name>Switch Term</name> <shortdescription>

Switch term measured at Measurement Port (Source Port ignored). </shortdescription> </ringvalue> </ring>

The error term K, alpha, beta, gamma, and delta describe the relation of the scattered and incident waves at the calibration plane (denoted as waves a and b respectively) and the waves measured at VNA reference and test receivers (denoted as waves r and s respectively) by the following equations:
a = K[alpha r + beta s] b = K[gamma r + delta s]

, where alpha, beta, gamma, and delta represent the complex elements of a transmission matrix and K represents a complex scaling factor.

measurementPort[in]char

This parameter specifies the VNA port name corresponding to the Error Term you queried.

sourcePort[in]char

This parameter specifies the VNA port name for which the Error Term is queried. This parameter is only required to query Error Term defined by port pairs. The valid values of the parameter Error Term Identifier defined for port pairs are Transmission Tracking and Load Match.

errorTerm[out]NIComplexSingle

This parameter returns the computed error term from the calset.

arraySize[in]int32

Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.

actualArraySize[out]int32 *

Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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