CcdfResults

Provides methods to fetch and read the Ccdf measurement results.

class nirfmxspecan.ccdf_results.CcdfResults(signal_obj)

Bases: object

Provides methods to fetch and read the Ccdf measurement results.

fetch_basic_power_probabilities(selector_string, timeout)

Returns CCDF power probabilities.

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:

ten_percent_power (float):

This parameter returns the power, in dB, above the mean power, over which 10% of the total samples in the signal are present.

one_percent_power (float):

This parameter returns the power, in dB, above the mean power, over which 1% of the total samples in the signal are present.

one_tenth_percent_power (float):

This parameter returns the power, in dB, above the mean power, over which 0.1% of the total samples in the signal are present.

one_hundredth_percent_power (float):

This parameter returns the power, in dB, above the mean power, over which 0.01% of the total samples in the signal are present.

one_thousandth_percent_power (float):

This parameter returns the power, in dB, above the mean power, over which 0.001% of the total samples in the signal are present.

one_ten_thousandth_percent_power (float):

This parameter returns the power, in dB, above the mean power, over which 0.0001% of the total samples in the signal are present.

error_code (int):

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

Return type:

Tuple (ten_percent_power, one_percent_power, one_tenth_percent_power, one_hundredth_percent_power, one_thousandth_percent_power, one_ten_thousandth_percent_power, error_code)

fetch_gaussian_probabilities_trace(selector_string, timeout, gaussian_probabilities)

Fetches the Gaussian probabilities trace for the CCDF 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, 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.

• gaussian_probabilities (numpy.float32) – This parameter returns the Gaussian probabilities.

Returns:

x0 (float):

This parameter represents the mean power.

dx (float):

This parameter returns the bin size used by the CCDF 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 (x0, dx, error_code)

fetch_power(selector_string, timeout)

Returns the mean power and peak power for the CCDF 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, 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:

mean_power (float):

This parameter returns the average power, in dBm, of all the samples. If you set the THRESHOLD_ENABLED attribute to True, samples above the threshold are measured.

mean_power_percentile (float):

This parameter returns the percentage of samples that have more power than the mean power.

peak_power (float):

This parameter returns the peak power of the acquired signal, relative to the mean power.

measured_samples_count (int):

This parameter returns the total number of samples measured.

error_code (int):

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

Return type:

Tuple (mean_power, mean_power_percentile, peak_power, measured_samples_count, error_code)

fetch_probabilities_trace(selector_string, timeout, probabilities)

Returns the probabilities trace for the CCDF 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, 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.

• probabilities (numpy.float32) – This parameter returns the probability, as a percentage, indicating the occurrence of samples in the signal with power greater than the mean power by x dB.

Returns:

x0 (float):

This parameter returns the mean power.

dx (float):

This parameter returns the bin size used by the CCDF 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 (x0, dx, error_code)

get_mean_power(selector_string)

Gets the average power of all the samples. This value is expressed in dBm. If you set the THRESHOLD_ENABLED attribute to True, samples above the threshold are measured.

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 average power of all the samples. This value is expressed in dBm. If you set the THRESHOLD_ENABLED attribute to True, samples above the threshold are measured.

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

Gets the percentage of samples that have more power than the mean power.

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 percentage of samples that have more power than the mean 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_measured_samples_count(selector_string)

Gets the total number of samples measured. The total number of samples includes only the samples above the threshold, when you set the THRESHOLD_ENABLED attribute to True.

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 (int):

Returns the total number of samples measured. The total number of samples includes only the samples above the threshold, when you set the THRESHOLD_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_one_hundredth_percent_power(selector_string)

Gets the power above the mean power, over which 0.01% of the total samples in the signal are present. 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 the power above the mean power, over which 0.01% of the total samples in the signal are present. 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_one_percent_power(selector_string)

Gets the power above the mean power, over which 1% of the total samples in the signal are present. 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 the power above the mean power, over which 1% of the total samples in the signal are present. 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_one_ten_thousandth_percent_power(selector_string)

Gets the power above the mean power, over which 0.0001% of the total samples in the signal are present. 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 the power above the mean power, over which 0.0001% of the total samples in the signal are present. 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_one_tenth_percent_power(selector_string)

Gets the power above the mean power, over which 0.1% of the total samples in the signal are present. 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 the power above the mean power, over which 0.1% of the total samples in the signal are present. 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_one_thousandth_percent_power(selector_string)

Gets the power above the mean power, over which 0.001% of the total samples in the signal are present. 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 the power above the mean power, over which 0.001% of the total samples in the signal are present. 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_peak_power(selector_string)

Gets the peak power of the acquired signal, relative to the mean power.

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):

Returns the peak power of the acquired signal, relative to the mean 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_ten_percent_power(selector_string)

Gets the power above the mean power, over which 10% of the total samples in the signal are present. 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 the power above the mean power, over which 10% of the total samples in the signal are present. 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)

read(selector_string, timeout)

Configures hardware for acquisition, performs measurement on acquired data, and returns complementary cumulative distribution function (CCDF) measurement results.

Parameters:

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

• 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. The default value is 10.

Returns:

mean_power (float):

This parameter returns the average power, in dBm, of all the samples. If you set the THRESHOLD_ENABLED attribute to True, samples above the threshold are measured.

mean_power_percentile (float):

This parameter returns the percentage of samples that have more power than the mean power.

peak_power (float):

This parameter returns the peak power of the acquired signal, relative to the mean power.

measured_samples_count (int):

This parameter returns the total number of samples measured.

error_code (int):

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

Return type:

Tuple (mean_power, mean_power_percentile, peak_power, measured_samples_count, error_code)