NI RFmx SpecAn NF Configuration Functions

NF Configuration Functions

• RFmxSpecAn_NFRecommendReferenceLevel
• RFmxSpecAn_NFClearCalibrationDatabase
• RFmxSpecAn_NFCfgFrequencyList_StartStopStep
• RFmxSpecAn_NFCfgFrequencyList_StartStopPoints
• RFmxSpecAn_NFCfgFrequencyList
• RFmxSpecAn_NFCfgMeasurementBandwidth
• RFmxSpecAn_NFCfgMeasurementInterval
• RFmxSpecAn_NFCfgAveraging
• RFmxSpecAn_NFCfgMeasurementMethod
• RFmxSpecAn_NFCfgYFactorMode
• RFmxSpecAn_NFCfgYFactorNoiseSourceENR
• RFmxSpecAn_NFCfgYFactorNoiseSourceLoss
• RFmxSpecAn_NFCfgYFactorNoiseSourceSettlingTime
• RFmxSpecAn_NFCfgDUTInputLoss
• RFmxSpecAn_NFCfgDUTOutputLoss
• RFmxSpecAn_NFCfgCalibrationLoss
• RFmxSpecAn_NFCfgColdSourceMode
• RFmxSpecAn_NFCfgColdSourceInputTermination
• RFmxSpecAn_NFCfgColdSourceDUTSParameters
• RFmxSpecAn_NFValidateCalibrationData

RFmxSpecAn_NFRecommendReferenceLevel

int32 __stdcall RFmxSpecAn_NFRecommendReferenceLevel (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 DUTMaxGain, float64 DUTMaxNoiseFigure, float64* referenceLevel);

Purpose

Computes and sets an appropriate reference level based on the expected maximum DUT gain, maximum DUT noise figure, and other measurement and analyzer attributes. You must not set the RFMXINSTR_ATTR_MIXER_LEVEL), RFMXINSTR_ATTR_MIXER_LEVEL_OFFSET), RFMXINSTR_ATTR_IF_OUTPUT_POWER_LEVEL_OFFSET), and RFMXINSTR_ATTR_IF_FILTER_BANDWIDTH) attributes in order to obtain an appropriate recommended reference level.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
DUTMaxGain	float64	Returns the expected maximum gain from the DUT. This value is expressed in dB.
DUTMaxNoiseFigure	float64	Returns the expected maximum noise figure of the DUT. This value is expressed in dB.
Output
Name	Type	Description
referenceLevel	float64*	Returns the recommended reference level for the NF measurement. This value is expressed in dBm for RF devices and as Vpk-pk for baseband devices.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFClearCalibrationDatabase

int32 __stdcall RFmxSpecAn_NFClearCalibrationDatabase (niRFmxInstrHandle instrumentHandle, char calibrationSetupID[]);

Purpose

Clear the noise figure calibration data for Cold Source and Y-Factor method. Calibration data associated with the selected VSA is cleared for the Cold Source method while calibration data associated with the noise source name and the VSA is cleared for the Y-Factor method.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
calibrationSetupID	char[]	Associates a unique string identifier with the hardware setup used to perform calibration for the NF measurement.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgFrequencyList_StartStopStep

int32 __stdcall RFmxSpecAn_NFCfgFrequencyList_StartStopStep (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 startFrequency, float64 stopFrequency, float64 stepSize);

Purpose

Configures the list of frequencies at which to perform the noise figure (NF) measurement. The start frequency and stop frequency points are inclusive in the frequency list.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
startFrequency	float64	Specifies the lowest frequency at which to perform the NF measurement. This value is expressed in Hz.
stopFrequency	float64	Specifies the highest frequency at which to perform the NF measurement. This value is expressed in Hz.
stepSize	float64	Specifies the spacing between adjacent frequency points in the list of frequencies at which to perform the NF measurement. This value is expressed in Hz.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgFrequencyList_StartStopPoints

int32 __stdcall RFmxSpecAn_NFCfgFrequencyList_StartStopPoints (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 startFrequency, float64 stopFrequency, int32 numberOfPoints);

Purpose

Configures the list of frequencies at which the noise figure (NF) measurement has to be performed. The start frequency and stop frequency points are inclusive in the frequency list.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
startFrequency	float64	Specifies the lowest frequency at which to perform the NF measurement. This value is expressed in Hz.
stopFrequency	float64	Specifies the highest frequency at which to perform the NF measurement. This value is expressed in Hz.
numberOfPoints	int32	Specifies the number of frequency points in the list of frequencies at which to perform the NF measurement. This value is expressed in Hz.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgFrequencyList

int32 __stdcall RFmxSpecAn_NFCfgFrequencyList (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 frequencyList[], int32 arraySize);

Purpose

Configures the list of frequencies at which to perform the noise figure (NF) measurement.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
frequencyList	float64[]	Specifies the list of frequencies at which the NF of the DUT is computed. This value is expressed in Hz.
arraySize	int32	Specifies the size of the array.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgMeasurementBandwidth

int32 __stdcall RFmxSpecAn_NFCfgMeasurementBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementBandwidth);

Purpose

Configures the effective noise-bandwidth in which power measurements are performed in the noise figure (NF) measurement.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
measurementBandwidth	float64	Specifies the effective noise-bandwidth in which power measurements are performed for the NF measurement. This value is expressed in Hz.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgMeasurementInterval

int32 __stdcall RFmxSpecAn_NFCfgMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval);

Purpose

Configures the duration for which the signals are acquired at each frequency to perform the noise figure (NF) measurement.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
measurementInterval	float64	Specifies the duration for which signals are acquired at each frequency which you specify in the RFMXSPECAN_ATTR_NF_FREQUENCY_LIST) attribute. This value is expressed in seconds.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgAveraging

int32 __stdcall RFmxSpecAn_NFCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount);

Purpose

Configures averaging for the noise figure (NF) measurement.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
averagingEnabled	int32	Specifies whether to enable averaging for the measurement.

RFMXSPECAN_VAL_NF_AVERAGING_ENABLED_FALSE (0)	The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_NF_AVERAGING_ENABLED_TRUE (1)	The measurement uses the value of the averagingCount parameter to calculate the number of acquisitions over which the measurement is averaged.

averagingCount	int32	Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXSPECAN_VAL_NF_AVERAGING_ENABLED_TRUE.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgMeasurementMethod

int32 __stdcall RFmxSpecAn_NFCfgMeasurementMethod (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 measurementMethod);

Purpose

Configures the noise figure (NF) measurement to use either the Y-Factor or the cold source method.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
measurementMethod	int32	Specifies the measurement method used to perform the NF measurement.

RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_Y_FACTOR (0)	The NF measurement computes the noise figure of the DUT using a noise source with a calibrated excess-noise ratio (ENR). supportedDevices: PXIe-5665 (3.6 GHz), PXIe-5668, PXIe-5644/5645/5646, PXIe-5840/5841, PXIe 5830/5831/5832. Refer to the NF concept topic for more information.
RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_COLD_SOURCE (1)	The NF measurement computes the noise figure of the DUT using a 50 ohm microwave termination as the noise source. supportedDevices: PXIe-5644/5645/5646, PXIe-5840/5841, PXIe-5830/5831/5832. Refer to the NF concept topic for more information.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgYFactorMode

int32 __stdcall RFmxSpecAn_NFCfgYFactorMode (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 yFactorMode);

Purpose

Configures the Y-Factor based noise figure (NF) measurement to perform the calibration step or the measurement step.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
yFactorMode	int32	Specifies whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT when you set the RFMXSpecAn_ATTR_NF_MEASUREMENT_METHOD) attribute to RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_Y_FACTOR.

RFMXSPECAN_VAL_NF_Y_FACTOR_MODE_MEASURE (0)	The NF measurement computes the noise characteristics of the DUT, compensating for the noise figure of the analyzer.
RFMXSPECAN_VAL_NF_Y_FACTOR_MODE_CALIBRATE (1)	The NF measurement computes the noise characteristics of the analyzer.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgYFactorNoiseSourceENR

int32 __stdcall RFmxSpecAn_NFCfgYFactorNoiseSourceENR (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 ENRFrequency[], float64 ENR[], float64 coldTemperature, float64 offTemperature, char noiseSourceName[], int32 arraySize);

Purpose

Configures excess noise ratio (ENR) and temperature of the noise source used by the Y-Factor method.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
ENRFrequency	float64[]	Specifies an array of frequencies corresponding to the effective noise ratio (ENR) values specified by the ENR parameter. This value is expressed in Hz. The default value is an empty array.
ENR	float64[]	Specifies the array of ENR values of the noise source as a function of the frequency. This value is expressed in dB. The corresponding frequencies are specified by the ENRFreq parameter. This attribute is used only when you set the RFMXSPECAN_ATTR_NF_MEASUREMENT_METHOD) attribute to RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_Y_FACTOR. This value is expressed in dB.
coldTemperature	float64	Specifies the calibrated cold noise temperature of the noise source used in the Y-Factor method. This value is expressed in kelvin.
offTemperature	float64	Specifies the physical temperature of the noise source used in the Y-Factor method when the noise source is turned off. This value is expressed in kelvin.
arraySize	int32	Specifies the size of the array.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgYFactorNoiseSourceLoss

int32 __stdcall RFmxSpecAn_NFCfgYFactorNoiseSourceLoss (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 noiseSourceLossCompensationEnabled, float64 noiseSourceLossFrequency[], float64 noiseSourceLoss[], float64 noiseSourceLossTemperature, int32 arraySize);

Purpose

Configures the ohmic loss inherent to the noise source used in the Y-Factor method that is common to the calibration and the measurement steps.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
noiseSourceLossCompensationEnabled	int32	Specifies whether the noise figure (NF) measurement should account for ohmic losses inherent to the noise source used in the Y-Factor method common to the calibration and measurement steps.
noiseSourceLossFrequency	float64[]	Specifies the array of the frequencies corresponding to the ohmic loss inherent to the noise source used in the Y-Factor method specified by the noiseSourceLoss parameter. This value is expressed in Hz.
noiseSourceLoss	float64[]	Specifies an array of the ohmic losses inherent to the noise source used in the Y-Factor method. This value is expressed in dB. This loss is accounted for by the NF measurement when you set the noiseSourceLossCompensationEnabled parameter to true. You must specify the frequencies at which the losses were measured using the noiseSourceLossFrequency parameter.
noiseSourceLossTemperature	float64	Specifies the physical temperature of the ohmic loss elements specified in the noiseSourceLoss parameter. This value is expressed in kelvin.
arraySize	int32	Specifies the size of the array.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgYFactorNoiseSourceSettlingTime

int32 __stdcall RFmxSpecAn_NFCfgYFactorNoiseSourceSettlingTime (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 settlingTime);

Purpose

Configures the time required for the acquisition to wait till the noise source used in the Y-Factor method settles to hot or cold state when the noise source is powered on or off.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
settlingTime	float64	Specifies the time to wait till the noise source used in the Y-Factor method settles to either hot or cold state when the noise source is enabled or disabled. This value is expressed in seconds.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgDUTInputLoss

int32 __stdcall RFmxSpecAn_NFCfgDUTInputLoss (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 DUTInputLossCompensationEnabled, float64 DUTInputLossFrequency[], float64 DUTInputLoss[], float64 DUTInputLossTemperature, int32 arraySize);

Purpose

Configures the ohmic loss, as a function of frequency, of the loss elements between the noise source and the input port of the DUT, excluding the losses that are common to the calibration step and the measurement step.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
DUTInputLossCompensationEnabled	int32	Specifies whether the noise figure (NF) measurement accounts for ohmic losses between the noise source and the input port of the DUT, excluding the losses that are common to calibration and the measurement steps for the Y-Factor method, which are specified by the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_LOSS) attribute.

RFMXSPECAN_VAL_NF_DUT_INPUT_LOSS_COMPENSATION_ENABLED_FALSE (0)	The measurement ignores ohmic losses.
RFMXSPECAN_VAL_NF_DUT_INPUT_LOSS_COMPENSATION_ENABLED_TRUE (1)	The measurement accounts for the ohmic losses.

DUTInputLossFrequency	float64[]	Specifies an array of frequencies corresponding to the value of the DUTInputLoss parameter. This value is expressed in Hz. To specify a constant loss value for all frequencies, you must set this attribute to an empty array.
DUTInputLoss	float64[]	Specifies an array of the the ohmic losses between the noise source and the input port of the DUT, as a function of the frequency. This value is expressed in dB. You must exclude any loss which is inherent to the noise source and is common between the calibration and measurement steps, and configure the loss using the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_LOSS attribute. Specify the frequencies at which the losses were measured using the DUTInputLossFrequency parameter. To specify a constant loss value for all frequencies, you should set the DUTInputLossFrequency attribute to an empty array and set the DUTInputLossFrequency parameter to a single element array, where the value of that element is equal to the frequency-independent loss. This loss is accounted for by the NF measurement when you set the DUTInputLossCompensationEnabled parameter to RFMXSPECAN_VAL_NF_DUT_INPUT_LOSS_COMPENSATION_ENABLED_TRUE.
DUTInputLossTemperature	float64	Specifies the physical temperature of the ohmic loss elements considered in the DUTInputLoss parameter. This value is expressed in kelvin.
arraySize	int32	Specifies the size of the array.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgDUTOutputLoss

int32 __stdcall RFmxSpecAn_NFCfgDUTOutputLoss (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 DUTOutputLossCompensationEnabled, float64 DUTOutputLossFrequency[], float64 DUTOutputLoss[], float64 DUTOutputLossTemperature, int32 arraySize);

Purpose

Configures the ohmic loss, as a function of frequency, of the loss elements between the output port of the DUT and the input port of the analyzer.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
DUTOutputLossCompensationEnabled	int32	Specifies whether the noise figure (NF) measurement accounts for ohmic losses between the output port of the DUT and the input port of the analyzer.

RFMXSPECAN_VAL_NF_DUT_OUTPUT_LOSS_COMPENSATION_ENABLED_FALSE (0)	The measurement ignores ohmic losses.
RFMXSPECAN_VAL_NF_DUT_OUTPUT_LOSS_COMPENSATION_ENABLED_TRUE (1)	The measurement accounts for the ohmic losses.

DUTOutputLossFrequency	float64[]	Specifies the array of frequencies corresponding to the value of the RFMXSpecAn_ATTR_NF_DUT_OUTPUT_LOSS) attribute. This value is expressed in Hz.
DUTOutputLoss	float64[]	Specifies the array of ohmic losses between the output port of the DUT and the input port of the analyzer, as a function of frequency. This value is expressed in dB. This loss is accounted for by the NF measurement when you set the DUTOutputLossCompensationEnabled parameter to RFMXSPECAN_VAL_NF_DUT_OUTPUT_LOSS_COMPENSATION_ENABLED_TRUE. Specify the array of frequencies at which the losses were measured using the DUTOutputLossFrequency parameter.
DUTOutputLossTemperature	float64	Specifies the physical temperature of the ohmic loss elements specified by the RFMXSpecAn_ATTR_NF_DUT_OUTPUT_LOSS) attribute. This value is expressed in kelvin.
arraySize	int32	Specifies the size of the array.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgCalibrationLoss

int32 __stdcall RFmxSpecAn_NFCfgCalibrationLoss (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 calibrationLossCompensationEnabled, float64 calibrationLossFrequency[], float64 calibrationLoss[], float64 calibrationLossTemperature, int32 arraySize);

Purpose

Configures the ohmic loss, as a function of frequency, of the loss elements between the noise source and the input port of the analyzer during the calibration step, excluding the loss specified as the noise source loss.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
calibrationLossCompensationEnabled	int32	Specifies whether the noise figure (NF) measurement accounts for the ohmic losses between the noise source and input port of the analyzer during the calibration step, excluding any losses which you have specified using the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_LOSS) attribute.

RFMXSPECAN_VAL_NF_CALIBRATION_LOSS_COMPENSATION_ENABLED_FALSE (0)	The NF measurement ignores the ohmic losses.
RFMXSPECAN_VAL_NF_CALIBRATION_LOSS_COMPENSATION_ENABLED_TRUE (1)	The NF measurement accounts for the ohmic losses.

calibrationLossFrequency	float64[]	Specifies an array of frequencies corresponding to the ohmic losses between the source and the input port of the analyzer. This value is expressed in Hz. This parameter is applicable only when you set the RFMXSPECAN_ATTR_NF_Y_FACTOR_MODE) attribute to RFMXSPECAN_VAL_NF_Y_FACTOR_MODE_CALIBRATE and set the RFMXSPECAN_ATTR_NF_MEASUREMENT_METHOD) attribute to RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_Y_FACTOR, or when you set the RFMXSPECAN_ATTR_NF_COLD_SOURCE_MODE) attribute to RFMXSPECAN_VAL_NF_COLD_SOURCE_MODE_CALIBRATE and set the RFMXSPECAN_ATTR_NF_MEASUREMENT_METHOD attribute to RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_COLD_SOURCE.
calibrationLoss	float64[]	Specifies the array of ohmic losses between the noise source and input port of the analyzer during calibration, as a function of frequency. You must exclude any loss specified by the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_LOSS) attribute. This loss is accounted for by the NF measurement when you set the calibrationLossCompensationEnabled parameter to RFMXSPECAN_VAL_NF_CALIBRATION_LOSS_COMPENSATION_ENABLED_TRUE. This parameter specifies the frequencies at which the calibrationLossFrequency parameter measures the losses.
calibrationLossTemperature	float64	Specifies the physical temperature of the ohmic loss elements specified by the RFMXSPECAN_ATTR_NF_CALIBRATION_LOSS) attribute. This value is expressed in kelvin.
arraySize	int32	Specifies the size of the array.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgColdSourceMode

int32 __stdcall RFmxSpecAn_NFCfgColdSourceMode (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 coldSourceMode);

Purpose

Configures the cold source based noise figure (NF) measurement to perform the calibration step or the measurement step.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
coldSourceMode	int32	Specifies whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT for the cold source method.

RFMXSPECAN_VAL_NF_COLD_SOURCE_MODE_MEASURE (0)	NF measurement computes the noise characteristics of the DUT and compensates for the noise figure of the analyzer.
RFMXSPECAN_VAL_NF_COLD_SOURCE_MODE_CALIBRATE (1)	NF measurement computes the noise characteristics of the analyzer.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgColdSourceInputTermination

int32 __stdcall RFmxSpecAn_NFCfgColdSourceInputTermination (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 terminationVSWR[], float64 terminationVSWRFrequency[], float64 terminationTemperature, int32 arraySize);

Purpose

Configures the characteristics of the microwave termination used as a noise source in the cold source method.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
terminationVSWR	float64[]	Specifies an array of voltage standing wave ratios (VSWR) as a function of frequency of the microwave termination used as the noise source in cold source method. The corresponding array of frequencies is specified by the terminationVSWRFrequency parameter. In most cases, the exact VSWR of the microwave termination may not be known. Hence, NI recommends that you set this parameter to an empty array, in which case the noise figure (NF) measurement assumes that the VSWR of the microwave termination is unity for all frequencies.
terminationVSWRFrequency	float64[]	Specifies an array of frequencies corresponding to the VSWRs of the microwave termination used in the cold source method as specified by the terminationVSWR parameter. This value is expressed in Hz.
terminationTemperature	float64	Specifies the physical temperature of the microwave termination used as the noise source in the cold source method. This value is expressed in kelvin.
arraySize	int32	Specifies the size of the array.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFCfgColdSourceDUTSParameters

int32 __stdcall RFmxSpecAn_NFCfgColdSourceDUTSParameters (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 DUTSParametersFrequency[], float64 DUTS21[], float64 DUTS12[], float64 DUTS11[], float64 DUTS22[], int32 arraySize);

Purpose

Configures the scattering parameters of the DUT as a function of the frequency, for use in the cold source measurement method.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
DUTSParametersFrequency	float64[]	Specifies the array of frequencies corresponding to the s-parameters of the DUT specified by the DUTS21, DUTS12, DUTS11, and DUTS22 parameters. This value is expressed in Hz.
DUTS21	float64[]	Specifies an array of the gains of the DUT as a function of frequency, when the output port of the DUT is terminated with an impedance equal to the characteristic impedance. This value is expressed in dB. The corresponding array of frequencies is specified by the DUTSParametersFrequency parameter.
DUTS12	float64[]	Specifies an array of the input-isolations of the DUT as a function of frequency, when the input port of the DUT is terminated with an impedance equal to the characteristic impedance. This value is expressed in dB. The corresponding array of frequencies is specified by the DUTSParametersFrequency parameter.
DUTS11	float64[]	Specifies an array of the input-reflections of the DUT as a function of frequency, when the output port of the DUT is terminated with an impedance equal to the characteristic impedance. This value is expressed in dB. The corresponding array of frequencies is specified by the DUTSParametersFrequency parameter.
DUTS22	float64[]	Specifies an array of the output-reflections of the DUT as a function of frequency, when the input port of the DUT is terminated with an impedance equal to the characteristic impedance. This value is expressed in dB. The corresponding array of frequencies is specified by the DUTSParametersFrequency parameter.
arraySize	int32	Specifies the size of the array.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_NFValidateCalibrationData

int32 __stdcall RFmxSpecAn_NFValidateCalibrationData( niRFmxInstrHandle instrumentHandle, char selectorString[], int32* calibrationDataValid );

Purpose

Indicates whether calibration data is valid for configuration specified by the signal name in the Selector string attribute.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
calibrationDataValid	int32*	Returns whether the calibration data is valid.

RFMXSPECAN_VAL_CALIBRATION_DATA_VALID_FALSE (0)	Returns false if the calibration data is not present for one or more frequency points in the list.
RFMXSPECAN_VAL_CALIBRATION_DATA_VALID_TRUE (1)	Returns true if the calibration data is present for all frequencies in the list.

Return Value

Name	Type	Description
status	int32	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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors