AcpResults

Provides methods to fetch and read the Acp measurement results.

class nirfmxtdscdma.acp_results.AcpResults(signal_obj)

Bases: object

Provides methods to fetch and read the Acp measurement results.

fetch_absolute_powers_trace(selector_string, timeout, trace_index, absolute_powers_trace)

Fetches the absolute powers trace for ACP measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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.

• trace_index (int) – Specifies the index of the trace to fetch. The traceIndex can range from 0 to (Number of carriers + 2*Number of offsets).

• absolute_powers_trace (numpy.float32) – This parameter returns the trace of measured integrated power. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the start frequency of the trace. This value is expressed in Hz.

dx (float):

This parameter returns the frequency bin spacing of the trace. 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 (x0, dx, error_code)

fetch_carrier_absolute_power(selector_string, timeout)

Returns the absolute carrier power.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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_absolute_power (float):

This parameter returns the absolute measured carrier power. 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_absolute_power, error_code)

fetch_offset_measurement(selector_string, timeout)

Returns the absolute and relative powers measured in the offset channel. The relative powers are measured relative to the integrated power of the power reference carrier.

Use “offset<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and offset number. Examples:

  ”offset0”

  ”signal::sig1/offset0”

  ”result::r1/offset0”

  ”signal::sig1/result::r1/offset0”

  You can use the build_offset_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:

lower_relative_power (float):

This parameter returns the lower offset channel power measured relative to the integrated power of the carrier. This value is expressed in dB.

upper_relative_power (float):

This parameter returns the upper offset channel power measured relative to the integrated power of the carrier. This value is expressed in dB.

lower_absolute_power (float):

This parameter returns the lower offset channel absolute power. This value is expressed in dBm.

upper_absolute_power (float):

This parameter returns the upper offset channel absolute power. 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 (lower_relative_power, upper_relative_power, lower_absolute_power, upper_absolute_power, error_code)

fetch_offset_measurement_array(selector_string, timeout)

Returns the absolute and relative powers measured in the offset channel. The relative powers are measured relative to the integrated power of the power reference carrier.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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:

lower_relative_power (float):

This parameter returns the array of lower offset channel powers measured relative to the integrated power of the carrier. This value is expressed in dB.

upper_relative_power (float):

This parameter returns the array of upper offset channel powers measured relative to the integrated power of the carrier. This value is expressed in dB.

lower_absolute_power (float):

This parameter returns the array of lower offset channel powers. This value is expressed in dBm.

upper_absolute_power (float):

This parameter returns the array of upper offset channel powers. 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 (lower_relative_power, upper_relative_power, lower_absolute_power, upper_absolute_power, error_code)

fetch_relative_powers_trace(selector_string, timeout, trace_index, relative_powers_trace)

Fetches the relative powers trace for the ACP measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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.

• trace_index (int) – Specifies the index of the trace to fetch. The traceIndex can range from 0 to (Number of carriers + 2*Number of offsets).

• relative_powers_trace (numpy.float32) – This parameter returns the trace of power levels representing the absolute mask in the spectral domain.

Returns:

x0 (float):

This parameter returns the start frequency of the trace. This value is expressed in Hz.

dx (float):

This parameter returns the frequency bin spacing. 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 (x0, dx, error_code)

fetch_spectrum(selector_string, timeout, spectrum)

Fetches the spectrum used for the ACP measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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.

• spectrum (numpy.float32) – This parameter returns the averaged power measured at each frequency bin. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the start frequency. This value is expressed in Hz.

dx (float):

This parameter returns the frequency bin spacing. 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 (x0, dx, error_code)

get_carrier_absolute_power(selector_string)

Gets the absolute measured carrier power. This value is expressed in dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 absolute measured carrier power. 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 (attr_val, error_code)

get_lower_offset_absolute_power(selector_string)

Gets the absolute measured lower offset channel power. This value is expressed in dBm.

Use “offset*<n>*” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the absolute measured lower offset channel power. 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 (attr_val, error_code)

get_lower_offset_relative_power(selector_string)

Gets the lower offset channel power measured relative to the integrated power of the power reference carrier. This value is expressed in dB.

Use “offset*<n>*” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the lower offset channel power measured relative to the integrated power of the power reference carrier. 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_upper_offset_absolute_power(selector_string)

Gets the absolute measured upper offset channel power. This value is expressed in dBm.

Use “offset*<n>*” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the absolute measured upper offset channel power. 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 (attr_val, error_code)

get_upper_offset_relative_power(selector_string)

Gets the upper offset channel power measured relative to the integrated power of the power reference carrier. This value is expressed in dB.

Use “offset*<n>*” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the upper offset channel power measured relative to the integrated power of the power reference carrier. 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)