rfsa c api reference

niRFSA_CreateDeembeddingSparameterTableArray

  • Updated2024-05-08
  • 2 minute(s) read

niRFSA_CreateDeembeddingSparameterTableArray

ViStatus niRFSA_CreateDeembeddingSparameterTableArray (ViSession vi, ViConstString port, ViConstString tableName, const ViReal64 frequencies[], ViInt32 frequenciesSize, const NIComplexNumber sparameterTable[], ViInt32 sparameterTableSize, ViInt32 numberOfPorts, ViInt32 sparameterOrientation);

Purpose

Creates an s-parameter de-embedding table for the port from the input data.

If you only create one table for a port, NI-RFSA automatically selects that table to de-embed the measurement.

Supported Devices: PXIe-5830/5831/5832/5840/5841/5842

Related Topics

De-embedding Overview

S-parameters

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function.
port ViConstString Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842 is "" (empty string).
tableName ViConstString Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.
frequencies const ViReal64[] Specifies the frequencies for the sparameterTable rows. Frequencies must be unique and in ascending order.
frequenciesSize ViInt32 Specifies the size of the frequency.
sparameterTable const NIComplexNumber[] Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.
sparameterTableSize ViInt32 Specifies the size of the S-parameter table.
numberOfPorts ViInt32 Specifies the number of DUT ports.
sparameterOrientation ViInt32 Specifies the orientation of the data in the S2P file relative to the port on the DUT port.

NIRFSA_VAL_PORT1_TOWARDS_DUT (3800) Port 1 of the S2P is oriented towards the DUT port.
NIRFSA_VAL_PORT2_TOWARDS_DUT (3801) Port 2 of the S2P is oriented towards the DUT port.

Return Value

Name Type Description
status ViStatus 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 NI-RFSA 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 niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience