PhaseNoiseResults

Provides methods to fetch and read the PhaseNoise measurement results.

class nirfmxspecan.phase_noise_results.PhaseNoiseResults(signal_obj)

Bases: object

Provides methods to fetch and read the PhaseNoise measurement results.

fetch_carrier_measurement(selector_string, timeout)

Fetches the carrier measurement.

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 for fetching the specified measurement. This value is expressed in seconds. 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:

carrier_frequency (float):

This parameter returns the measured carrier power. This value is expressed in Hz.

carrier_power (float):

This parameter returns the measured carrier frequency. This value is expressed in dBm.

error_code (int):

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

Return type:

Tuple (carrier_frequency, carrier_power, error_code)

fetch_integrated_noise(selector_string, timeout)

Fetches the integrated noise measurement.

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 for fetching the specified measurement. This value is expressed in seconds. 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:

integrated_phase_noise (float):

This parameter returns the integrated phase noise. This value is expressed in dBc.

residual_pm_in_radian (float):

This parameter returns the residual PM in radians.

residual_pm_in_degree (float):

This parameter returns the residual PM. This value is expressed in degrees.

residual_fm (float):

This parameter returns the residual FM. This value is expressed in Hz.

jitter (float):

This parameter returns the jitter. 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 (integrated_phase_noise, residual_pm_in_radian, residual_pm_in_degree, residual_fm, jitter, error_code)

fetch_measured_log_plot_trace(selector_string, timeout)

Fetches the log plot trace.

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 for fetching the specified measurement. This value is expressed in seconds. 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:

frequency (float):

This parameter returns an array of the frequency offsets where phase noise has been measured.

measured_phase_noise (float):

This parameter returns an array of measured phase noise at the frequency offset. This value is expressed in dBc/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 (frequency, measured_phase_noise, error_code)

fetch_smoothed_log_plot_trace(selector_string, timeout)

Fetches the smoothened log plot trace.

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 for fetching the specified measurement. This value is expressed in seconds. 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:

frequency (float):

This parameter returns an array of the frequency offsets where phase noise has been measured.

smoothed_phase_noise (float):

This parameter returns an array of smoothed phase noise at the frequency offset. This value is expressed in dBc/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 (frequency, smoothed_phase_noise, error_code)

fetch_spot_noise(selector_string, timeout)

Fetches the spot noise.

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 for fetching the specified measurement. This value is expressed in seconds. 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:

spot_phase_noise (float):

This parameter returns the phase noise corresponding to the value of the SPOT_NOISE_FREQUENCY_LIST attribute, by using the smoothed log plot trace.

error_code (int):

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

Return type:

Tuple (spot_phase_noise, error_code)

get_carrier_frequency(selector_string)

Gets the measured carrier frequency.

You do not need to use a selector string to 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):

Returns the measured carrier frequency.

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_carrier_power(selector_string)

Gets the measured carrier power.

You do not need to use a selector string to 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):

Returns the measured carrier power.

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_integrated_phase_noise(selector_string)

Gets the integrated phase noise.

You do not need to use a selector string to 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):

Returns the integrated phase noise.

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_jitter(selector_string)

Gets the jitter in seconds.

You do not need to use a selector string to 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):

Returns the jitter 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_residual_fm(selector_string)

Gets the residual FM in Hz.

You do not need to use a selector string to 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):

Returns the residual FM 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_residual_pm_in_degree(selector_string)

Gets the residual PM in degrees.

You do not need to use a selector string to 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):

Returns the residual PM in degrees.

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_residual_pm_in_radian(selector_string)

Gets the residual PM in radians.

You do not need to use a selector string to 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):

Returns the residual PM in radians.

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_spot_phase_noise(selector_string)

Gets the phase noise corresponding to the SPOT_NOISE_FREQUENCY_LIST attribute by using the smoothed log plot trace.

You do not need to use a selector string to 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):

Returns the phase noise corresponding to the SPOT_NOISE_FREQUENCY_LIST attribute by using the smoothed log plot trace.

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)