NFResults

Provides methods to fetch and read the NF measurement results.

class nirfmxspecan.nf_results.NFResults(signal_obj)

Bases: object

Provides methods to fetch and read the NF measurement results.

fetch_analyzer_noise_figure(selector_string, timeout)

Fetches the noise figure of the analyzer.

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.

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

analyzer_noise_figure (float):

This parameter returns an array of the noise figure values of the analyzer measured at the frequencies specified by the FREQUENCY_LIST attribute. 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 (analyzer_noise_figure, error_code)

fetch_cold_source_power(selector_string, timeout)

Fetches the power measured by the analyzer when the cold source based noise figure (NF) measurement is performed.

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.

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

cold_source_power (float):

This parameter returns the array of powers measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dBm. A valid result is returned only when you set the MEASUREMENT_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 (cold_source_power, error_code)

fetch_dut_noise_figure_and_gain(selector_string, timeout)

Fetches the DUT noise figure, noise temperature and gain results.

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.

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

dut_noise_figure (float):

This parameter returns an array of the noise figures of the DUT measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB.

dut_noise_temperature (float):

This parameter returns an array of the equivalent thermal noise temperatures of the DUT measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in kelvin.

dut_gain (float):

This parameter returns an array of the available gains of the DUT measured at the frequencies specified by the FREQUENCY_LIST attribute. 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 (dut_noise_figure, dut_noise_temperature, dut_gain, error_code)

fetch_y_factor_powers(selector_string, timeout)

Fetches the hot and cold powers measured when the Y-Factor based noise figure (NF) measurement is performed.

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.

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

hot_power (float):

This parameter returns an array of powers measured at the frequencies specified by the FREQUENCY_LIST attribute, when the noise source is enabled. This value is expressed in dBm. A valid result is returned only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

cold_power (float):

This parameter returns an array of powers measured at the frequencies specified by the FREQUENCY_LIST attribute, when the noise source is disabled. This value is expressed in dBm. A valid result is returned 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 (hot_power, cold_power, error_code)

fetch_y_factors(selector_string, timeout)

Returns the measurement Y-factor and calibration Y-factor values.

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.

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

measurement_y_factor (float):

This parameter returns the array of measurement Y-Factor values measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB. This method returns a valid result only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

calibration_y_factor (float):

This parameter returns the array of calibration Y-Factor values measured at the frequencies specified by the NF Freq List attribute. This value is expressed in dB. This method returns a valid result 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 (measurement_y_factor, calibration_y_factor, error_code)

get_analyzer_noise_figure(selector_string)

Gets an array of the noise figures of the analyzer measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns an array of the noise figures of the analyzer measured at the frequencies specified by the FREQUENCY_LIST attribute. 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_calibration_y_factor(selector_string)

Gets an array of the calibration Y-Factors measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB. A valid result is returned only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns an array of the calibration Y-Factors measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB. A valid result is returned 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_cold_source_power(selector_string)

Gets the power measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dBm. A valid result is returned only when you set the MEASUREMENT_METHOD attribute to Cold-source.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dBm. A valid result is returned only when you set the MEASUREMENT_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_dut_gain(selector_string)

Gets an array of the available gains of the DUT measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns an array of the available gains of the DUT measured at the frequencies specified by the FREQUENCY_LIST attribute. 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_dut_noise_figure(selector_string)

Gets an array of the noise figures of the DUT measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns an array of the noise figures of the DUT measured at the frequencies specified by the FREQUENCY_LIST attribute. 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_dut_noise_temperature(selector_string)

Gets an array of the equivalent thermal noise temperatures of the DUT measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in kelvin.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns an array of the equivalent thermal noise temperatures of the DUT measured at the frequencies specified by the FREQUENCY_LIST 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_measurement_y_factor(selector_string)

Gets an array of the measurement Y-Factors measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB. A valid result is returned only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns an array of the measurement Y-Factors measured at the frequencies specified by the FREQUENCY_LIST attribute. This value is expressed in dB. A valid result is returned 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_cold_power(selector_string)

Gets the array of powers measured at the frequencies specified by the FREQUENCY_LIST attribute, when the noise source is disabled. This value is expressed in dBm. A valid result is returned only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the array of powers measured at the frequencies specified by the FREQUENCY_LIST attribute, when the noise source is disabled. This value is expressed in dBm. A valid result is returned 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_hot_power(selector_string)

Gets the array of powers measured at the frequencies specified by the FREQUENCY_LIST attribute, when the noise source is enabled. This value is expressed in dBm. A valid result is returned only when you set the MEASUREMENT_METHOD attribute to Y-Factor.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the array of powers measured at the frequencies specified by the FREQUENCY_LIST attribute, when the noise source is enabled. This value is expressed in dBm. A valid result is returned 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)