NFConfiguration

Provides methods to configure the NF measurement.

class nirfmxspecan.nf_configuration.NFConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the NF measurement.

clear_calibration_database(calibration_setup_id)[source]

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:: calibration_setup_id (string) – This parameter associates a unique string identifier with the hardware setup used to perform calibration for the NF measurement. The default value is an empty string.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

Configures averaging for the noise figure (NF) measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

averaging_enabled (enums.NFAveragingEnabled, int) –

This parameter specifies whether to enable averaging for the measurement. The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The measurement uses the value of the Averaging Count parameter to calculate the number of acquisitions over which the measurement is averaged.

averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_calibration_loss(selector_string, calibration_loss_compensation_enabled, calibration_loss_frequency, calibration_loss, calibration_loss_temperature)[source]

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:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
calibration_loss_compensation_enabled (enums.NFCalibrationLossCompensationEnabled, int) –
This parameter 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute. The default value is False.

Name (Value)

Description

False (0)

The NF measurement ignores the ohmic losses.

True (1)

The NF measurement accounts for the ohmic losses.
calibration_loss_frequency (float) – This parameter 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 Y_FACTOR_MODE attribute to Calibrate and set the MEASUREMENT_METHOD attribute to Y-Factor, or when you set the COLD_SOURCE_MODE attribute to Calibrate and set the NF Meas Method attribute to Cold Source. The default value is an empty array.
calibration_loss (float) –
This parameter 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute. This loss is accounted for by the NF measurement when you set the Calibration Loss Compensation Enabled parameter to True. The default value is empty array.

This parameter specifies the frequencies at which the Calibration Loss Frequency parameter measures the losses.
calibration_loss_temperature (float) – This parameter specifies the physical temperature of the ohmic loss elements specified by the CALIBRATION_LOSS attribute. This value is expressed in kelvin.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_cold_source_dut_s_parameters(selector_string, dut_s_parameters_frequency, dut_s21, dut_s12, dut_s11, dut_s22)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
dut_s_parameters_frequency (float) – This parameter specifies the array of frequencies corresponding to the s-parameters of the DUT specified by the DUT S21, DUT S12, DUT S11, and DUT S22 parameters. This value is expressed in Hz. The default value is an empty array.
dut_s21 (float) – This parameter 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 DUT S-Parameters Frequency parameter. The default value is an empty array.
dut_s12 (float) – This parameter 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 DUT S-Parameters Frequency parameter. The default value is an empty array.
dut_s11 (float) – This parameter 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 DUT S-Parameters Frequency parameter. The default value is an empty array.
dut_s22 (float) – This parameter 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 DUT S-Parameters Frequency parameter. The default value is an empty array.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_cold_source_input_termination(selector_string, termination_vswr, termination_vswr_frequency, termination_temperature)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
termination_vswr (float) –
This parameter 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 Termination VSWR Frequency 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.

The default value is an empty array.
termination_vswr_frequency (float) – This parameter specifies an array of frequencies corresponding to the VSWRs of the microwave termination used in the cold source method as specified by the Termination VSWR parameter. This value is expressed in Hz. The default value is an empty array.
termination_temperature (float) – This parameter specifies the physical temperature of the microwave termination used as the noise source in the cold source method. This value is expressed in kelvin. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_cold_source_mode(selector_string, cold_source_mode)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

cold_source_mode (enums.NFColdSourceMode, int) –

This parameter 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. The default value is Measure.

Name (Value)	Description
Measure (0)	NF measurement computes the noise characteristics of the DUT and compensates for the noise figure of the analyzer.
Calibrate (1)	NF measurement computes the noise characteristics of the analyzer.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_dut_input_loss(selector_string, dut_input_loss_compensation_enabled, dut_input_loss_frequency, dut_input_loss, dut_input_loss_temperature)[source]

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:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
dut_input_loss_compensation_enabled (enums.NFDutInputLossCompensationEnabled, int) –
This parameter 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, which are specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute. The default value is False.

Name (Value)

Description

False (0)

The NF measurement ignores the ohmic losses.

True (1)

The NF measurement accounts for the ohmic losses.
dut_input_loss_frequency (float) – This parameter specifies the array of frequencies corresponding to the value of the DUT Input Loss parameter. This value is expressed in Hz. The default value is an empty array.
dut_input_loss (float) –
This parameter specifies the array of 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 it using the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This loss is accounted for by the NF measurement when you set the DUT Input Loss Compensation Enabled parameter to True. The default value is an empty array.

Specify the frequencies at which the losses were measured using the DUT Input Loss Frequency parameter.
dut_input_loss_temperature (float) – This parameter specifies the physical temperature of the ohmic loss elements considered in the DUT Input Loss parameter. This value is expressed in kelvin. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_dut_output_loss(selector_string, dut_output_loss_compensation_enabled, dut_output_loss_frequency, dut_output_loss, dut_output_loss_temperature)[source]

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:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
dut_output_loss_compensation_enabled (enums.NFDutOutputLossCompensationEnabled, int) –
This parameter 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. The default value is False.

Name (Value)

Description

False (0)

The measurement ignores ohmic losses.

True (1)

The measurement accounts for the ohmic losses.
dut_output_loss_frequency (float) – This parameter specifies the array of frequencies corresponding to the value of the DUT_OUTPUT_LOSS attribute. This value is expressed in Hz. The default value is an empty array.
dut_output_loss (float) –
This parameter 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 DUT Output Loss Compensation Enabled parameter to True. The default value is an empty array.

Specify the array of frequencies at which the losses were measured using the DUT Output Loss Frequency parameter.
dut_output_loss_temperature (float) – This parameter specifies the physical temperature of the ohmic loss elements specified by the DUT_OUTPUT_LOSS attribute. This value is expressed in kelvin. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_frequency_list(selector_string, frequency_list)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
frequency_list (float) – This parameter specifies the list of frequencies at which the NF of the DUT is computed. This value is expressed in Hz. The default value is 0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_frequency_list_start_stop_points(selector_string, start_frequency, stop_frequency, number_of_points)[source]

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:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
start_frequency (float) – This parameter specifies the lowest frequency at which to perform the NF measurement. This value is expressed in Hz.
stop_frequency (float) – This parameter specifies the highest frequency at which to perform the NF measurement. This value is expressed in Hz.
number_of_points (int) – This parameter specifies the number of frequency points in the list of frequencies at which to perform the NF measurement. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_frequency_list_start_stop_step(selector_string, start_frequency, stop_frequency, step_size)[source]

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:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
start_frequency (float) – This parameter specifies the lowest frequency at which to perform the NF measurement. This value is expressed in Hz.
stop_frequency (float) – This parameter specifies the highest frequency at which to perform the NF measurement. This value is expressed in Hz.
step_size (float) – This parameter 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.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_measurement_bandwidth(selector_string, measurement_bandwidth)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
measurement_bandwidth (float) – This parameter specifies the effective noise-bandwidth in which power measurements are performed for the NF measurement. This value is expressed in Hz. The default value is 100 kHz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_measurement_interval(selector_string, measurement_interval)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
measurement_interval (float) – This parameter specifies the duration for which signals are acquired at each frequency which you specify in the FREQUENCY_LIST attribute. This value is expressed in seconds. The default value is 1 ms.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_measurement_method(selector_string, measurement_method)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

measurement_method (enums.NFMeasurementMethod, int) –

This parameter specifies the measurement method used to perform the NF measurement. Refer to the NF concept topic for more information. The default value is Y-Factor.

Name (Value)	Description
Y-Factor (0)	The NF measurement computes the noise figure of the DUT using a noise source with a calibrated excess-noise ratio (ENR). Refer to NF Y-Factor NS Type for information about the supported devices and their corresponding noise source type.
Cold Source (1)	The NF measurement computes the noise figure of the DUT using a 50 ohm microwave termination as the noise source. Supported Devices: PXIe-5644/5645/5646/5840/5841/5842/5860, PXIe-5830/5831/5832

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_y_factor_mode(selector_string, y_factor_mode)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

y_factor_mode (enums.NFYFactorMode, int) –

This parameter specifies whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT when you set the MEASUREMENT_METHOD attribute to Y-Factor.

Name (Value)	Description
Measure (0)	The NF measurement computes the noise characteristics of the DUT, compensating for the noise figure of the analyzer.
Calibrate (1)	The NF measurement computes the noise characteristics of the analyzer.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_y_factor_noise_source_enr(selector_string, enr_frequency, enr, cold_temperature, off_temperature)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
enr_frequency (float) – This parameter 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 (float) – This parameter 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 ENR Freq parameter. This attribute is used only when you set the MEASUREMENT_METHOD attribute to Y-Factor. This value is expressed in dB. The default value is an empty array.
cold_temperature (float) – This parameter specifies the calibrated cold noise temperature of the noise source used in the Y-Factor method. This value is expressed in kelvin. The default value is 302.8.
off_temperature (float) – This parameter 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. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_y_factor_noise_source_loss(selector_string, noise_source_loss_compensation_enabled, noise_source_loss_frequency, noise_source_loss, noise_source_loss_temperature)[source]

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:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
noise_source_loss_compensation_enabled (enums.NFYFactorNoiseSourceLossCompensationEnabled, int) –
This parameter 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. The default value is False.

Name (Value)

Description

False (0)

Ohmic losses are ignored.

True (1)

Ohmic losses are accounted for in the NF measurement.
noise_source_loss_frequency (float) – This parameter 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 Noise Source Loss parameter. This value is expressed in Hz. The default value is an empty array.
noise_source_loss (float) –
This parameter 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 Noise Source Loss Compensation Enabled parameter to True. The default value is an empty array.

You must specify the frequencies at which the losses were measured using the Noise Source Loss Frequency parameter.
noise_source_loss_temperature (float) – This parameter specifies the physical temperature of the ohmic loss elements specified in the Noise Source Loss parameter. This value is expressed in kelvin. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_y_factor_noise_source_settling_time(selector_string, settling_time)[source]

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:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
settling_time (float) – This parameter 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 attribute is used only when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to External Noise Source. This value is expressed in seconds. The default value is 0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

get_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the noise figure (NF) measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The NF measurement uses the value of the NF Averaging Count attribute as the number of acquisitions for each frequency which you specify in the NF Freq List attribute, over which the NF measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFAveragingEnabled):: Specifies whether to enable averaging for the noise figure (NF) measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_calibration_loss(selector_string)[source]

Gets the array of ohmic losses between the noise source and input port of the analyzer during calibration, as a function of frequency. This value is expressed in dB. This loss is accounted for by the noise figure (NF) measurement when you set the CALIBRATION_LOSS_COMPENSATION_ENABLED attribute to True. You must exclude any loss specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute.

This attribute specifies the frequencies at which the CALIBRATION_LOSS_FREQUENCY attribute measures the losses.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the array of ohmic losses between the noise source and input port of the analyzer during calibration, as a function of frequency. This value is expressed in dB. This loss is accounted for by the noise figure (NF) measurement when you set the CALIBRATION_LOSS_COMPENSATION_ENABLED attribute to True. You must exclude any loss specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_calibration_loss_compensation_enabled(selector_string)[source]

Gets 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The NF measurement ignores the ohmic losses.
True (1)	The NF measurement accounts for the ohmic losses.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFCalibrationLossCompensationEnabled):: 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_calibration_loss_frequency(selector_string)[source]

Gets 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 attribute is applicable only when you set the Y_FACTOR_MODE attribute to Calibrate and set the MEASUREMENT_METHOD attribute to Y-Factor, or when you set the COLD_SOURCE_MODE attribute to Calibrate and set the NF Meas Method attribute to Cold Source.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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 attribute is applicable only when you set the Y_FACTOR_MODE attribute to Calibrate and set the MEASUREMENT_METHOD attribute to Y-Factor, or when you set the COLD_SOURCE_MODE attribute to Calibrate and set the NF Meas Method attribute to Cold Source.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_calibration_loss_temperature(selector_string)[source]

Gets the physical temperature of the ohmic loss elements specified by the CALIBRATION_LOSS attribute. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the physical temperature of the ohmic loss elements specified by the CALIBRATION_LOSS attribute. This value is expressed in kelvin.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_calibration_setup_id(selector_string)[source]

Associates a unique string identifier with the hardware setup used to perform calibration for the NF measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty string.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Associates a unique string identifier with the hardware setup used to perform calibration for the NF measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_dut_s11(selector_string)[source]

Gets 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_dut_s12(selector_string)[source]

Gets 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_dut_s21(selector_string)[source]

Gets 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_dut_s22(selector_string)[source]

Gets 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_dut_s_parameters_frequency(selector_string)[source]

Gets an array of frequencies corresponding to the s-parameters of the DUT specified by the COLD_SOURCE_DUT_S21, COLD_SOURCE_DUT_S12, COLD_SOURCE_DUT_S11, and COLD_SOURCE_DUT_S22 attributes. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of frequencies corresponding to the s-parameters of the DUT specified by the COLD_SOURCE_DUT_S21, COLD_SOURCE_DUT_S12, COLD_SOURCE_DUT_S11, and COLD_SOURCE_DUT_S22 attributes. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_input_termination_temperature(selector_string)[source]

Gets the physical temperature of the microwave termination used as the noise source in the cold source method. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the physical temperature of the microwave termination used as the noise source in the cold source method. This value is expressed in kelvin.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_input_termination_vswr(selector_string)[source]

Gets 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 COLD_SOURCE_INPUT_TERMINATION_VSWR_FREQUENCY attribute.

In most cases, the exact VSWR of the microwave termination may not be known. Hence, NI recommends that you set this attribute 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.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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 COLD_SOURCE_INPUT_TERMINATION_VSWR_FREQUENCY attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_input_termination_vswr_frequency(selector_string)[source]

Gets an array of frequencies corresponding to the voltage standing wave ratios (VSWR) of the microwave termination used in the cold source method as specified by the COLD_SOURCE_INPUT_TERMINATION_VSWR attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of frequencies corresponding to the voltage standing wave ratios (VSWR) of the microwave termination used in the cold source method as specified by the COLD_SOURCE_INPUT_TERMINATION_VSWR attribute. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cold_source_mode(selector_string)[source]

Gets whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT for the cold source method.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Measure.

Name (Value)	Description
Measure (0)	The noise figure (NF) measurement computes the noise characteristics of the DUT and compensates for the noise figure of the analyzer.
Calibrate (1)	The NF measurement computes the noise characteristics of the analyzer.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFColdSourceMode):: 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.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_device_temperature_tolerance(selector_string)[source]

Gets the tolerance for device temperature beyond which the calibration data is considered invalid. This value is expressed in Celsius.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 5.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the tolerance for device temperature beyond which the calibration data is considered invalid. This value is expressed in Celsius.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_input_loss(selector_string)[source]

Gets an array of 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. This loss is accounted for by the NF measurement when you set the DUT_INPUT_LOSS_COMPENSATION_ENABLED attribute to True. 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

Specify the frequencies at which the losses were measured using the DUT_INPUT_LOSS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of 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. This loss is accounted for by the NF measurement when you set the DUT_INPUT_LOSS_COMPENSATION_ENABLED attribute to True. 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_input_loss_compensation_enabled(selector_string)[source]

Gets 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The NF measurement ignores the ohmic losses.
True (1)	The NF measurement accounts for the ohmic losses.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFDutInputLossCompensationEnabled):: 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_input_loss_frequency(selector_string)[source]

Gets an array of frequencies corresponding to the value of the DUT_INPUT_LOSS attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of frequencies corresponding to the value of the DUT_INPUT_LOSS attribute. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_input_loss_temperature(selector_string)[source]

Gets the physical temperature of the ohmic loss elements considered in the DUT_INPUT_LOSS attribute. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the physical temperature of the ohmic loss elements considered in the DUT_INPUT_LOSS attribute. This value is expressed in kelvin.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_output_loss(selector_string)[source]

Gets 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 noise figure (NF) measurement when you set the DUT_OUTPUT_LOSS_COMPENSATION_ENABLED attribute to True.

Specify the array of frequencies at which the losses were measured using the DUT_OUTPUT_LOSS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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 noise figure (NF) measurement when you set the DUT_OUTPUT_LOSS_COMPENSATION_ENABLED attribute to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_output_loss_compensation_enabled(selector_string)[source]

Gets whether the noise figure (NF) measurement accounts for ohmic losses between the output port of the DUT and the input port of the analyzer.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The NF measurement ignores ohmic losses.
True (1)	The NF measurement accounts for the ohmic losses.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFDutOutputLossCompensationEnabled):: 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.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_output_loss_frequency(selector_string)[source]

Gets the array of frequencies corresponding to the value of the DUT_OUTPUT_LOSS attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the array of frequencies corresponding to the value of the DUT_OUTPUT_LOSS attribute. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_output_loss_temperature(selector_string)[source]

Gets the physical temperature of the ohmic loss elements specified by the DUT_OUTPUT_LOSS attribute. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the physical temperature of the ohmic loss elements specified by the DUT_OUTPUT_LOSS attribute. This value is expressed in kelvin.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dut_type(selector_string)[source]

Gets the type of DUT.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Amplifier.

Name (Value)	Description
Amplifier (0)	Specifies that the DUT only amplifies or attenuates the signal, and does not change the frequency.
Downconverter (1)	Specifies that the DUT is a downconverter, that is, the IF frequency is the difference between the LO and RF frequencies.
Upconverter (2)	Specifies that the DUT is an upconverter, that is, the IF frequency is the sum of LO and RF frequencies.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFDutType):: Specifies the type of DUT.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_external_preamp_frequency(selector_string)[source]

Gets the array of frequencies corresponding to the value of the EXTERNAL_PREAMP_GAIN attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the array of frequencies corresponding to the value of the EXTERNAL_PREAMP_GAIN attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_external_preamp_gain(selector_string)[source]

Gets the gain of the external preamp as a function of frequency. The value is expressed in dB.

Specify the frequencies at which gain values were measured using the EXTERNAL_PREAMP_FREQUENCY attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the gain of the external preamp as a function of frequency. The value is expressed in dB.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_external_preamp_present(selector_string)[source]

Gets if an external preamplifier is present in the signal path.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	No external preamplifier present in the signal path.
True (1)	An external preamplifier present in the signal path.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFExternalPreampPresent):: Specifies if an external preamplifier is present in the signal path.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_frequency_converter_frequency_context(selector_string)[source]

Gets the context of the FREQUENCY_LIST attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is RF.

Name (Value)	Description
RF (0)	Specifies that the frequency context is RF.
IF (1)	Specifies that the frequency context is IF.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFFrequencyConverterFrequencyContext):: Specifies the context of the FREQUENCY_LIST attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_frequency_converter_image_rejection(selector_string)[source]

Gets the gain ratio of the DUT at the image frequency to that at the RF frequency. This value is expressed in dB. Refer to NF concept help for more details.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 999.99 dB.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the gain ratio of the DUT at the image frequency to that at the RF frequency. This value is expressed in dB. Refer to NF concept help for more details.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_frequency_converter_lo_frequency(selector_string)[source]

Gets the fixed LO frequency of the DUT when you set the DUT_TYPE attribute to either Downconverter or Upconverter. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the fixed LO frequency of the DUT when you set the DUT_TYPE attribute to either Downconverter or Upconverter. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_frequency_converter_sideband(selector_string)[source]

Gets the sideband when you set the DUT_TYPE attribute to either Downconverter or Upconverter, and the FREQUENCY_CONVERTER_FREQUENCY_CONTEXT attribute to IF.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is LSB.

Name (Value)	Description
LSB (0)	When the frequency context is IF, out of the two possible input frequencies that gets translated to IF, the lower is treated as the RF (signal) frequency while the higher is treated as the image frequency.
USB (1)	When the frequency context is IF, out of the two possible input frequencies that gets translated to IF, the lower is treated as the image frequency while the higher is treated as the RF (signal) frequency.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFFrequencyConverterSideband):: Specifies the sideband when you set the DUT_TYPE attribute to either Downconverter or Upconverter, and the FREQUENCY_CONVERTER_FREQUENCY_CONTEXT attribute to IF.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_frequency_list(selector_string)[source]

Gets the list of frequencies at which the noise figure (NF) of the DUT is computed. This value is expressed in Hz.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the list of frequencies at which the noise figure (NF) of the DUT is computed. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_bandwidth(selector_string)[source]

Gets the effective noise-bandwidth in which power measurements are performed for the noise figure (NF) measurement. This value is expressed in Hz.

The default value is 100 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the effective noise-bandwidth in which power measurements are performed for the noise figure (NF) measurement. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Enables the noise figure (NF) measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):: Enables the noise figure (NF) measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_interval(selector_string)[source]

Gets the duration for which the signals are acquired at each frequency which you specify in the FREQUENCY_LIST attribute. This value is expressed in seconds.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1 ms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the duration for which the signals are acquired at each frequency which you specify in the FREQUENCY_LIST attribute. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_method(selector_string)[source]

Gets the measurement method used to perform the noise figure (NF) measurement. Refer to the NF concept topic for more information.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Y-Factor.

Name (Value)	Description
Y-Factor (0)	The NF measurement computes the noise figure of the DUT using a noise source with a calibrated excess-noise ratio (ENR). Refer to the NF Y-Factor NS Type attribute for information about supported devices and their corresponding noise source type.
Cold Source (1)	The NF measurement computes the noise figure of the DUT using a 50 ohm microwave termination as the noise source. Supported Devices: PXIe-5644/5645/5646/5840/5841/5842/5860, PXIe-5830/5831/5832

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFMeasurementMethod):: Specifies the measurement method used to perform the noise figure (NF) measurement. Refer to the NF concept topic for more information.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for the noise figure (NF) measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the maximum number of threads used for parallelism for the noise figure (NF) measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_mode(selector_string)[source]

Gets whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT when you set the MEASUREMENT_METHOD attribute to Y-Factor.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Measure.

Name (Value)	Description
Measure (0)	The noise figure (NF) measurement computes the noise characteristics of the DUT, compensating for the noise figure of the analyzer.
Calibrate (1)	The NF measurement computes the noise characteristics of the analyzer.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFYFactorMode):: Specifies whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT when you set the MEASUREMENT_METHOD attribute to Y-Factor.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_cold_temperature(selector_string)[source]

Gets the calibrated cold noise temperature of the noise source used in the Y-Factor method. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 302.8.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the calibrated cold noise temperature of the noise source used in the Y-Factor method. This value is expressed in kelvin.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_enr(selector_string)[source]

Gets the array of effective noise ratio (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 Y_FACTOR_NOISE_SOURCE_ENR_FREQUENCY attribute. This attribute is used only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the array of effective noise ratio (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 Y_FACTOR_NOISE_SOURCE_ENR_FREQUENCY attribute. This attribute is used only when you set the MEASUREMENT_METHOD attribute to Y-Factor.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_enr_frequency(selector_string)[source]

Gets an array of frequencies corresponding to the effective noise ratio (ENR) values specified by the Y_FACTOR_NOISE_SOURCE_ENR attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies an array of frequencies corresponding to the effective noise ratio (ENR) values specified by the Y_FACTOR_NOISE_SOURCE_ENR attribute. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_loss(selector_string)[source]

Gets 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 Y_FACTOR_NOISE_SOURCE_LOSS_COMPENSATION_ENABLED attribute to True.

You must specify the frequencies at which the losses were measured using the Y_FACTOR_NOISE_SOURCE_LOSS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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 Y_FACTOR_NOISE_SOURCE_LOSS_COMPENSATION_ENABLED attribute to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_loss_compensation_enabled(selector_string)[source]

Gets 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.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	Ohmic losses are ignored.
True (1)	Ohmic losses are accounted for in the NF measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFYFactorNoiseSourceLossCompensationEnabled):: 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.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_loss_frequency(selector_string)[source]

Gets the frequencies corresponding to the ohmic loss inherent to the noise source used in the Y-Factor method specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the frequencies corresponding to the ohmic loss inherent to the noise source used in the Y-Factor method specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_loss_temperature(selector_string)[source]

Gets the physical temperature of the ohmic loss elements specified in the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the physical temperature of the ohmic loss elements specified in the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This value is expressed in kelvin.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_off_temperature(selector_string)[source]

Gets 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.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_rf_signal_generator_port(selector_string)[source]

Gets the vector signal generator port to be configured to generate a noise signal when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to RF Signal Generator.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is “” (empty string).

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Specifies the vector signal generator port to be configured to generate a noise signal when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to RF Signal Generator.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_settling_time(selector_string)[source]

Gets 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 turned on or off. This attribute is used only when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to External Noise Source. This value is expressed in seconds.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: 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 turned on or off. This attribute is used only when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to External Noise Source. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_y_factor_noise_source_type(selector_string)[source]

Gets the noise source type for performing the noise figure (NF) measurement when you set the MEASUREMENT_METHOD attribute to Y-Factor.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is External Noise Source.

Name (Value)

Description

External Noise Source (0)

The NF measurement generates noise using an external noise source, that is controlled either by an internal noise source power supply or an NI Source Measure Unit (SMU). Supported Devices: PXIe-5665 (3.6 GHz), PXIe-5668, PXIe-5644/5645/5646*, PXIe-5840*/5841*/5842*/5860*, PXIe 5830/5831*/5832* *Use an external NI Source Measure Unit (SMU) as the noise source power supply for the Noise Figure measurement. During initialization, specify the SMU resource name using “NoiseSourcePowerSupply” as the specifier within the RFmxSetup string. For example, “RFmxSetup= NoiseSourcePowerSupply:myDCPower[0]” configures RFmx to use channel 0 on myDCPower SMU device for powering the noise source. You should allocate a dedicated SMU channel for RFmx. RFmx supports PXIe-4138, PXIe-4139, and PXIe-4139 (40 W) SMUs.

RF Signal Generator (1)

When you measure Y-Factor based NF using a supported NI vector signal transceiver (VST) instrument, RFmx generates noise using the vector signal generator (VSG) integrated into the same VST. RFmx automatically configures the vector signal generator (VSG) to generate noise at the specified bandwidth and ENR levels that you set using the NF Y-Factor NS ENR Freq and NF Y-Factor NS ENR attributes. Supported Devices: PXIe-5842/5860

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NFYFactorNoiseSourceType):: Specifies the noise source type for performing the noise figure (NF) measurement when you set the MEASUREMENT_METHOD attribute to Y-Factor.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

load_calibration_loss_from_s2p(selector_string, calibration_loss_compensation_enabled, calibration_loss_s2p_file_path, calibration_loss_s_parameter_orientation, calibration_loss_temperature)[source]

Loads the ohmic loss data from an S2P file, 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:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
calibration_loss_compensation_enabled (enums.NFCalibrationLossCompensationEnabled, int) –
This parameter 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute. The default value is False.

Name (Value)

Description

False (0)

The NF measurement ignores the ohmic losses.

True (1)

The NF measurement accounts for the ohmic losses.
calibration_loss_s2p_file_path (string) – This parameter specifies the path to the S2P file that contains Callibration Loss for the specified port.
calibration_loss_s_parameter_orientation (enums.NFCalibrationLossS2pSParameterOrientation, int) –
This parameter specifies the orientation of the data in the S-parameter table relative to the port you specify. The default value is Port1 Towards DUT.

Name (Value)

Description

Port1 Towards DUT (0)

Port 1 of the S2P is oriented towards the DUT.

Port2 Towards DUT (1)

Port 2 of the S2P is oriented towards the DUT.
calibration_loss_temperature (float) – This parameter specifies the physical temperature of the ohmic loss elements specified by the CALIBRATION_LOSS attribute. This value is expressed in kelvin.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

load_cold_source_dut_s_parameter_from_s2p(selector_string, dut_s_parameters_s2p_file_path, dut_s_parameter_orientation)[source]

Loads the scattering parameter data from an S2P file and configures them as a function of frequency for use in the cold source measurement method.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
dut_s_parameters_s2p_file_path (string) – This parameterspecifies the path to the S2P file that contains DUT S-Parameters for the specified port.
dut_s_parameter_orientation (enums.NFColdSourceDutS2pSParameterOrientation, int) –
This parameter specifies the orientation of the data in the S-parameter table relative to the port you specify. The default value is Port1 Towards DUT.

Name (Value)

Description

Port1 Towards DUT (0)

Port 1 of the S2P is oriented towards the DUT.

Port2 Towards DUT (1)

Port 2 of the S2P is oriented towards the DUT.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

load_cold_source_input_termination_from_s1p(selector_string, termination_s1p_file_path, termination_temperature)[source]

Loads the characteristics of the microwave termination from an S1P file, which used as a noise source in the cold source method.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
termination_s1p_file_path (string) – This parameterspecifies the path to the S1P file that contains DUT S-Parameters for the specified port.
termination_temperature (float) – This parameter specifies the physical temperature of the microwave termination used as the noise source in the cold source method. This value is expressed in kelvin. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

load_dut_input_loss_from_s2p(selector_string, dut_input_loss_compensation_enabled, dut_input_loss_s2p_file_path, dut_input_loss_s_parameter_orientation, dut_input_loss_temperature)[source]

Loads the ohmic Input loss data from an S2P file and configures the loss elements between the noise source and the input port of DUT, excluding the losses that are common to the calibration step and the measurement step.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
dut_input_loss_compensation_enabled (enums.NFDutInputLossCompensationEnabled, int) –
This parameter 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, which are specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute. The default value is False.

Name (Value)

Description

False (0)

The NF measurement ignores the ohmic losses.

True (1)

The NF measurement accounts for the ohmic losses.
dut_input_loss_s2p_file_path (string) – This parameterspecifies the path to the S2P file that contains DUT Input Loss for the specified port.
dut_input_loss_s_parameter_orientation (enums.NFDutInputLossS2pSParameterOrientation, int) –
This parameter specifies the orientation of the data in the S-parameter table relative to the port you specify. The default value is Port1 Towards DUT.

Name (Value)

Description

Port1 Towards DUT (0)

Port 1 of the S2P is oriented towards the DUT.

Port2 Towards DUT (1)

Port 2 of the S2P is oriented towards the DUT.
dut_input_loss_temperature (float) – This parameter specifies the physical temperature of the ohmic loss elements considered in the DUT Input Loss parameter. This value is expressed in kelvin. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

load_dut_output_loss_from_s2p(selector_string, dut_output_loss_compensation_enabled, dut_output_loss_s2p_file_path, dut_output_loss_s_parameter_orientation, dut_output_loss_temperature)[source]

Loads the ohmic Output loss data from an S2P file and configures the loss elements between the output port of the DUT and the input port of the analyzer.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
dut_output_loss_compensation_enabled (enums.NFDutOutputLossCompensationEnabled, int) –
This parameter 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. The default value is False.

Name (Value)

Description

False (0)

The measurement ignores ohmic losses.

True (1)

The measurement accounts for the ohmic losses.
dut_output_loss_s2p_file_path (string) – This parameterspecifies the path to the S2P file that contains DUT Output Loss for the specified port.
dut_output_loss_s_parameter_orientation (enums.NFDutOutputLossS2pSParameterOrientation, int) –
This parameter specifies the orientation of the data in the S-parameter table relative to the port you specify. The default value is Port1 Towards DUT.

Name (Value)

Description

Port1 Towards DUT (0)

Port 1 of the S2P is oriented towards the DUT.

Port2 Towards DUT (1)

Port 2 of the S2P is oriented towards the DUT.
dut_output_loss_temperature (float) – This parameter specifies the physical temperature of the ohmic loss elements specified by the DUT_OUTPUT_LOSS attribute. This value is expressed in kelvin. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

load_external_preamp_gain_from_s2p(selector_string, external_preamp_present, external_preamp_gain_s2p_file_path, external_preamp_gain_s_parameter_orientation)[source]

Loads the gain characteristics of the external preamplifier from an S2P file, as a function of frequency. The gain values are expressed in dB.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
external_preamp_present (enums.NFExternalPreampPresent, int) –
This parameterSpecifies if an external preamplifier is present in the signal path.

Name (Value)

Description

False (0)

No external preamplifier present in the signal path.

True (1)

An external preamplifier is present in the signal path.
external_preamp_gain_s2p_file_path (string) – This parameterspecifies the path to the S2P file that contains DUT S-Parameters for the specified port.
external_preamp_gain_s_parameter_orientation (enums.NFExternalPreampGainS2pSParameterOrientation, int) –
This parameterspecifies the orientation of the data in the S-parameter table relative to the port you specify. The default value is Port1 Towards DUT.

Name (Value)

Description

Port1 Towards DUT (0)

Port 1 of the S2P is oriented towards the DUT.

Port2 Towards DUT (1)

Port 2 of the S2P is oriented towards the DUT.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

load_y_factor_noise_source_loss_from_s2p(selector_string, noise_source_loss_compensation_enabled, noise_source_loss_s2p_file_path, noise_source_loss_s_parameter_orientation, noise_source_loss_temperature)[source]

Loads the ohmic loss from an S2P file, which is inherent to the noise source used in the Y-Factor method that is common to the calibration and the measurement steps.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
noise_source_loss_compensation_enabled (enums.NFYFactorNoiseSourceLossCompensationEnabled, int) –
This parameter 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. The default value is False.

Name (Value)

Description

False (0)

Ohmic losses are ignored.

True (1)

Ohmic losses are accounted for in the NF measurement.
noise_source_loss_s2p_file_path (string) – This parameterspecifies the path to the S2P file that contains DUT S-Parameters for the specified port.
noise_source_loss_s_parameter_orientation (enums.NFYFactorNoiseSourceLossS2pSParameterOrientation, int) –
This parameterspecifies the orientation of the data in the S-parameter table relative to the port you specify. The default value is Port1 Towards DUT.

Name (Value)

Description

Port1 Towards DUT (0)

Port 1 of the S2P is oriented towards the DUT.

Port2 Towards DUT (1)

Port 2 of the S2P is oriented towards the DUT.
noise_source_loss_temperature (float) – This parameter specifies the physical temperature of the ohmic loss elements specified in the Noise Source Loss parameter. This value is expressed in kelvin. The default value is 297.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

recommend_reference_level(selector_string, dut_max_gain, dut_max_noise_figure)[source]

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 MIXER_LEVEL, MIXER_LEVEL_OFFSET, IF_OUTPUT_POWER_LEVEL_OFFSET, and IF_FILTER_BANDWIDTH attributes in order to obtain an appropriate recommended reference level.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of result name.

Example:

””

”result::r1”

You can use the build_result_string() method to build the selector string.
dut_max_gain (float) – This parameter returns the expected maximum gain from the DUT. This value is expressed in dB.
dut_max_noise_figure (float) – This parameter returns the expected maximum noise figure of the DUT. This value is expressed in dB.

Returns:

reference_level (float):: This parameter returns the recommended reference level for the NF measurement. This value is expressed in dBm for RF devices and as V_pk-pkfor baseband devices.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (reference_level, error_code)

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the noise figure (NF) measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The NF measurement uses the value of the NF Averaging Count attribute as the number of acquisitions for each frequency which you specify in the NF Freq List attribute, over which the NF measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFAveragingEnabled, int) – Specifies whether to enable averaging for the noise figure (NF) measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_calibration_loss(selector_string, value)[source]

Sets the array of ohmic losses between the noise source and input port of the analyzer during calibration, as a function of frequency. This value is expressed in dB. This loss is accounted for by the noise figure (NF) measurement when you set the CALIBRATION_LOSS_COMPENSATION_ENABLED attribute to True. You must exclude any loss specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute.

This attribute specifies the frequencies at which the CALIBRATION_LOSS_FREQUENCY attribute measures the losses.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the array of ohmic losses between the noise source and input port of the analyzer during calibration, as a function of frequency. This value is expressed in dB. This loss is accounted for by the noise figure (NF) measurement when you set the CALIBRATION_LOSS_COMPENSATION_ENABLED attribute to True. You must exclude any loss specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_calibration_loss_compensation_enabled(selector_string, value)[source]

Sets 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The NF measurement ignores the ohmic losses.
True (1)	The NF measurement accounts for the ohmic losses.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFCalibrationLossCompensationEnabled, int) – 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_calibration_loss_frequency(selector_string, value)[source]

Sets 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 attribute is applicable only when you set the Y_FACTOR_MODE attribute to Calibrate and set the MEASUREMENT_METHOD attribute to Y-Factor, or when you set the COLD_SOURCE_MODE attribute to Calibrate and set the NF Meas Method attribute to Cold Source.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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 attribute is applicable only when you set the Y_FACTOR_MODE attribute to Calibrate and set the MEASUREMENT_METHOD attribute to Y-Factor, or when you set the COLD_SOURCE_MODE attribute to Calibrate and set the NF Meas Method attribute to Cold Source.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_calibration_loss_temperature(selector_string, value)[source]

Sets the physical temperature of the ohmic loss elements specified by the CALIBRATION_LOSS attribute. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the physical temperature of the ohmic loss elements specified by the CALIBRATION_LOSS attribute. This value is expressed in kelvin.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_calibration_setup_id(selector_string, value)[source]

Associates a unique string identifier with the hardware setup used to perform calibration for the NF measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty string.

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Associates a unique string identifier with the hardware setup used to perform calibration for the NF measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_dut_s11(selector_string, value)[source]

Sets 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_dut_s12(selector_string, value)[source]

Sets 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_dut_s21(selector_string, value)[source]

Sets 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_dut_s22(selector_string, value)[source]

Sets 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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 COLD_SOURCE_DUT_S_PARAMETERS_FREQUENCY attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_dut_s_parameters_frequency(selector_string, value)[source]

Sets an array of frequencies corresponding to the s-parameters of the DUT specified by the COLD_SOURCE_DUT_S21, COLD_SOURCE_DUT_S12, COLD_SOURCE_DUT_S11, and COLD_SOURCE_DUT_S22 attributes. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of frequencies corresponding to the s-parameters of the DUT specified by the COLD_SOURCE_DUT_S21, COLD_SOURCE_DUT_S12, COLD_SOURCE_DUT_S11, and COLD_SOURCE_DUT_S22 attributes. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_input_termination_temperature(selector_string, value)[source]

Sets the physical temperature of the microwave termination used as the noise source in the cold source method. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the physical temperature of the microwave termination used as the noise source in the cold source method. This value is expressed in kelvin.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_input_termination_vswr(selector_string, value)[source]

Sets 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 COLD_SOURCE_INPUT_TERMINATION_VSWR_FREQUENCY attribute.

In most cases, the exact VSWR of the microwave termination may not be known. Hence, NI recommends that you set this attribute 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.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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 COLD_SOURCE_INPUT_TERMINATION_VSWR_FREQUENCY attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_input_termination_vswr_frequency(selector_string, value)[source]

Sets an array of frequencies corresponding to the voltage standing wave ratios (VSWR) of the microwave termination used in the cold source method as specified by the COLD_SOURCE_INPUT_TERMINATION_VSWR attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of frequencies corresponding to the voltage standing wave ratios (VSWR) of the microwave termination used in the cold source method as specified by the COLD_SOURCE_INPUT_TERMINATION_VSWR attribute. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cold_source_mode(selector_string, value)[source]

Sets whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT for the cold source method.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Measure.

Name (Value)	Description
Measure (0)	The noise figure (NF) measurement computes the noise characteristics of the DUT and compensates for the noise figure of the analyzer.
Calibrate (1)	The NF measurement computes the noise characteristics of the analyzer.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFColdSourceMode, int) – 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.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_device_temperature_tolerance(selector_string, value)[source]

Sets the tolerance for device temperature beyond which the calibration data is considered invalid. This value is expressed in Celsius.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 5.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the tolerance for device temperature beyond which the calibration data is considered invalid. This value is expressed in Celsius.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_input_loss(selector_string, value)[source]

Sets an array of 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. This loss is accounted for by the NF measurement when you set the DUT_INPUT_LOSS_COMPENSATION_ENABLED attribute to True. 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

Specify the frequencies at which the losses were measured using the DUT_INPUT_LOSS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of 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. This loss is accounted for by the NF measurement when you set the DUT_INPUT_LOSS_COMPENSATION_ENABLED attribute to True. 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_input_loss_compensation_enabled(selector_string, value)[source]

Sets 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The NF measurement ignores the ohmic losses.
True (1)	The NF measurement accounts for the ohmic losses.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFDutInputLossCompensationEnabled, int) – 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 Y_FACTOR_NOISE_SOURCE_LOSS attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_input_loss_frequency(selector_string, value)[source]

Sets an array of frequencies corresponding to the value of the DUT_INPUT_LOSS attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of frequencies corresponding to the value of the DUT_INPUT_LOSS attribute. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_input_loss_temperature(selector_string, value)[source]

Sets the physical temperature of the ohmic loss elements considered in the DUT_INPUT_LOSS attribute. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the physical temperature of the ohmic loss elements considered in the DUT_INPUT_LOSS attribute. This value is expressed in kelvin.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_output_loss(selector_string, value)[source]

Sets 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 noise figure (NF) measurement when you set the DUT_OUTPUT_LOSS_COMPENSATION_ENABLED attribute to True.

Specify the array of frequencies at which the losses were measured using the DUT_OUTPUT_LOSS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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 noise figure (NF) measurement when you set the DUT_OUTPUT_LOSS_COMPENSATION_ENABLED attribute to True.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_output_loss_compensation_enabled(selector_string, value)[source]

Sets whether the noise figure (NF) measurement accounts for ohmic losses between the output port of the DUT and the input port of the analyzer.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The NF measurement ignores ohmic losses.
True (1)	The NF measurement accounts for the ohmic losses.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFDutOutputLossCompensationEnabled, int) – 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.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_output_loss_frequency(selector_string, value)[source]

Sets the array of frequencies corresponding to the value of the DUT_OUTPUT_LOSS attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the array of frequencies corresponding to the value of the DUT_OUTPUT_LOSS attribute. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_output_loss_temperature(selector_string, value)[source]

Sets the physical temperature of the ohmic loss elements specified by the DUT_OUTPUT_LOSS attribute. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the physical temperature of the ohmic loss elements specified by the DUT_OUTPUT_LOSS attribute. This value is expressed in kelvin.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dut_type(selector_string, value)[source]

Sets the type of DUT.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Amplifier.

Name (Value)	Description
Amplifier (0)	Specifies that the DUT only amplifies or attenuates the signal, and does not change the frequency.
Downconverter (1)	Specifies that the DUT is a downconverter, that is, the IF frequency is the difference between the LO and RF frequencies.
Upconverter (2)	Specifies that the DUT is an upconverter, that is, the IF frequency is the sum of LO and RF frequencies.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFDutType, int) – Specifies the type of DUT.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_external_preamp_frequency(selector_string, value)[source]

Sets the array of frequencies corresponding to the value of the EXTERNAL_PREAMP_GAIN attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the array of frequencies corresponding to the value of the EXTERNAL_PREAMP_GAIN attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_external_preamp_gain(selector_string, value)[source]

Sets the gain of the external preamp as a function of frequency. The value is expressed in dB.

Specify the frequencies at which gain values were measured using the EXTERNAL_PREAMP_FREQUENCY attribute.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the gain of the external preamp as a function of frequency. The value is expressed in dB.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_external_preamp_present(selector_string, value)[source]

Sets if an external preamplifier is present in the signal path.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	No external preamplifier present in the signal path.
True (1)	An external preamplifier present in the signal path.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFExternalPreampPresent, int) – Specifies if an external preamplifier is present in the signal path.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_frequency_converter_frequency_context(selector_string, value)[source]

Sets the context of the FREQUENCY_LIST attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is RF.

Name (Value)	Description
RF (0)	Specifies that the frequency context is RF.
IF (1)	Specifies that the frequency context is IF.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFFrequencyConverterFrequencyContext, int) – Specifies the context of the FREQUENCY_LIST attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_frequency_converter_image_rejection(selector_string, value)[source]

Sets the gain ratio of the DUT at the image frequency to that at the RF frequency. This value is expressed in dB. Refer to NF concept help for more details.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 999.99 dB.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the gain ratio of the DUT at the image frequency to that at the RF frequency. This value is expressed in dB. Refer to NF concept help for more details.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_frequency_converter_lo_frequency(selector_string, value)[source]

Sets the fixed LO frequency of the DUT when you set the DUT_TYPE attribute to either Downconverter or Upconverter. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10 MHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the fixed LO frequency of the DUT when you set the DUT_TYPE attribute to either Downconverter or Upconverter. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_frequency_converter_sideband(selector_string, value)[source]

Sets the sideband when you set the DUT_TYPE attribute to either Downconverter or Upconverter, and the FREQUENCY_CONVERTER_FREQUENCY_CONTEXT attribute to IF.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is LSB.

Name (Value)	Description
LSB (0)	When the frequency context is IF, out of the two possible input frequencies that gets translated to IF, the lower is treated as the RF (signal) frequency while the higher is treated as the image frequency.
USB (1)	When the frequency context is IF, out of the two possible input frequencies that gets translated to IF, the lower is treated as the image frequency while the higher is treated as the RF (signal) frequency.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFFrequencyConverterSideband, int) – Specifies the sideband when you set the DUT_TYPE attribute to either Downconverter or Upconverter, and the FREQUENCY_CONVERTER_FREQUENCY_CONTEXT attribute to IF.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_frequency_list(selector_string, value)[source]

Sets the list of frequencies at which the noise figure (NF) of the DUT is computed. This value is expressed in Hz.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the list of frequencies at which the noise figure (NF) of the DUT is computed. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_bandwidth(selector_string, value)[source]

Sets the effective noise-bandwidth in which power measurements are performed for the noise figure (NF) measurement. This value is expressed in Hz.

The default value is 100 kHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the effective noise-bandwidth in which power measurements are performed for the noise figure (NF) measurement. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Enables the noise figure (NF) measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.
value (bool) – Enables the noise figure (NF) measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_interval(selector_string, value)[source]

Sets the duration for which the signals are acquired at each frequency which you specify in the FREQUENCY_LIST attribute. This value is expressed in seconds.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1 ms.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the duration for which the signals are acquired at each frequency which you specify in the FREQUENCY_LIST attribute. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_method(selector_string, value)[source]

Sets the measurement method used to perform the noise figure (NF) measurement. Refer to the NF concept topic for more information.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Y-Factor.

Name (Value)	Description
Y-Factor (0)	The NF measurement computes the noise figure of the DUT using a noise source with a calibrated excess-noise ratio (ENR). Refer to the NF Y-Factor NS Type attribute for information about supported devices and their corresponding noise source type.
Cold Source (1)	The NF measurement computes the noise figure of the DUT using a 50 ohm microwave termination as the noise source. Supported Devices: PXIe-5644/5645/5646/5840/5841/5842/5860, PXIe-5830/5831/5832

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFMeasurementMethod, int) – Specifies the measurement method used to perform the noise figure (NF) measurement. Refer to the NF concept topic for more information.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for the noise figure (NF) measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the maximum number of threads used for parallelism for the noise figure (NF) measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_mode(selector_string, value)[source]

Sets whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT when you set the MEASUREMENT_METHOD attribute to Y-Factor.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Measure.

Name (Value)	Description
Measure (0)	The noise figure (NF) measurement computes the noise characteristics of the DUT, compensating for the noise figure of the analyzer.
Calibrate (1)	The NF measurement computes the noise characteristics of the analyzer.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFYFactorMode, int) – Specifies whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT when you set the MEASUREMENT_METHOD attribute to Y-Factor.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_cold_temperature(selector_string, value)[source]

Sets the calibrated cold noise temperature of the noise source used in the Y-Factor method. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 302.8.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the calibrated cold noise temperature of the noise source used in the Y-Factor method. This value is expressed in kelvin.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_enr(selector_string, value)[source]

Sets the array of effective noise ratio (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 Y_FACTOR_NOISE_SOURCE_ENR_FREQUENCY attribute. This attribute is used only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the array of effective noise ratio (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 Y_FACTOR_NOISE_SOURCE_ENR_FREQUENCY attribute. This attribute is used only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_enr_frequency(selector_string, value)[source]

Sets an array of frequencies corresponding to the effective noise ratio (ENR) values specified by the Y_FACTOR_NOISE_SOURCE_ENR attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies an array of frequencies corresponding to the effective noise ratio (ENR) values specified by the Y_FACTOR_NOISE_SOURCE_ENR attribute. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_loss(selector_string, value)[source]

Sets 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 Y_FACTOR_NOISE_SOURCE_LOSS_COMPENSATION_ENABLED attribute to True.

You must specify the frequencies at which the losses were measured using the Y_FACTOR_NOISE_SOURCE_LOSS_FREQUENCY attribute.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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 Y_FACTOR_NOISE_SOURCE_LOSS_COMPENSATION_ENABLED attribute to True.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_loss_compensation_enabled(selector_string, value)[source]

Sets 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.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	Ohmic losses are ignored.
True (1)	Ohmic losses are accounted for in the NF measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFYFactorNoiseSourceLossCompensationEnabled, int) – 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.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_loss_frequency(selector_string, value)[source]

Sets the frequencies corresponding to the ohmic loss inherent to the noise source used in the Y-Factor method specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is an empty array.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the frequencies corresponding to the ohmic loss inherent to the noise source used in the Y-Factor method specified by the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_loss_temperature(selector_string, value)[source]

Sets the physical temperature of the ohmic loss elements specified in the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This value is expressed in kelvin.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the physical temperature of the ohmic loss elements specified in the Y_FACTOR_NOISE_SOURCE_LOSS attribute. This value is expressed in kelvin.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_off_temperature(selector_string, value)[source]

Sets 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.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 297.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_rf_signal_generator_port(selector_string, value)[source]

Sets the vector signal generator port to be configured to generate a noise signal when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to RF Signal Generator.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is “” (empty string).

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Specifies the vector signal generator port to be configured to generate a noise signal when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to RF Signal Generator.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_settling_time(selector_string, value)[source]

Sets 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 turned on or off. This attribute is used only when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to External Noise Source. This value is expressed in seconds.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – 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 turned on or off. This attribute is used only when you set the Y_FACTOR_NOISE_SOURCE_TYPE attribute to External Noise Source. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_y_factor_noise_source_type(selector_string, value)[source]

Sets the noise source type for performing the noise figure (NF) measurement when you set the MEASUREMENT_METHOD attribute to Y-Factor.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is External Noise Source.

Name (Value)

Description

External Noise Source (0)

The NF measurement generates noise using an external noise source, that is controlled either by an internal noise source power supply or an NI Source Measure Unit (SMU). Supported Devices: PXIe-5665 (3.6 GHz), PXIe-5668, PXIe-5644/5645/5646*, PXIe-5840*/5841*/5842*/5860*, PXIe 5830/5831*/5832* *Use an external NI Source Measure Unit (SMU) as the noise source power supply for the Noise Figure measurement. During initialization, specify the SMU resource name using “NoiseSourcePowerSupply” as the specifier within the RFmxSetup string. For example, “RFmxSetup= NoiseSourcePowerSupply:myDCPower[0]” configures RFmx to use channel 0 on myDCPower SMU device for powering the noise source. You should allocate a dedicated SMU channel for RFmx. RFmx supports PXIe-4138, PXIe-4139, and PXIe-4139 (40 W) SMUs.

RF Signal Generator (1)

When you measure Y-Factor based NF using a supported NI vector signal transceiver (VST) instrument, RFmx generates noise using the vector signal generator (VSG) integrated into the same VST. RFmx automatically configures the vector signal generator (VSG) to generate noise at the specified bandwidth and ENR levels that you set using the NF Y-Factor NS ENR Freq and NF Y-Factor NS ENR attributes. Supported Devices: PXIe-5842/5860

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NFYFactorNoiseSourceType, int) – Specifies the noise source type for performing the noise figure (NF) measurement when you set the MEASUREMENT_METHOD attribute to Y-Factor.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

validate_calibration_data(selector_string)[source]

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

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

Returns:

calibration_data_valid (enums.NFCalibrationDataValid):

This parameter returns whether the calibration data is valid.

Name (Value)	Description
False (0)	Returns false if the calibration data is not present for one or more frequency points in the list or if the difference between the current device temperature and the calibration temperature exceeds the tolerance specified by the NF Device Temperature Tolerance attribute.
True (1)	Returns true if the calibration data is present for all of the frequencies in the list.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (calibration_data_valid, error_code)