AcpResults

Provides methods to fetch and read the Acp measurement results.

class nirfmxwcdma.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 the ACP 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 time for which the method waits for the measurement to complete. This value is expressed in seconds. 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 the measured integrated power in each channel.

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)

fetch_carrier_measurement(selector_string, timeout)

Fetches the absolute and relative powers of the carrier. The relative power is relative to the total carrier power.

Use “carrier<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

  You can use the build_carrier_string() method to build the selector string.

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

absolute_power (float):

This parameter returns the carrier power. The carrier power is the integrated power of the RRC-filtered signal. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22. The carrier is centered at a frequency determined by the CENTER_FREQUENCY and CARRIER_FREQUENCY attributes. This value is expressed in dBm.

relative_power (float):

This parameter returns the carrier power relative to the total carrier power. 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 (absolute_power, relative_power, error_code)

fetch_carrier_measurement_array(selector_string, timeout)

Returns the array of absolute powers and the array of relative powers for the ACP measurement. The relative powers are relative to the ACP_RESULTS_TOTAL_CARRIER_POWER attribute.

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 time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

absolute_power (float):

This parameter returns an array of carrier power values. The carrier power is the integrated power of the RRC-filtered signal. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22. The carrier is centered at a frequency determined by the CENTER_FREQUENCY and CARRIER_FREQUENCY attributes. This value is expressed in dBm.

relative_power (float):

This parameter returns an array of carrier power values relative to the total active carrier power. 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 (absolute_power, relative_power, error_code)

fetch_offset_measurement(selector_string, timeout)

Fetches the absolute and relative powers measured in the offset channel for the ACP measurement. The relative powers are measured relative to the power reference carrier.

Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

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

  Example:

  ”offset0”

  ”result::r1/offset0”

  You can use the build_offset_string() method to build the selector string.

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. 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 offset channel power measured relative to the power of the carrier(s) that you specify in the ACP_OFFSET_POWER_REFERENCE_CARRIER attribute.

This value is expressed in dB.

upper_relative_power (float):

This parameter returns the upper offset channel power measured relative to the power of the carrier(s) that you specify in the ACP_OFFSET_POWER_REFERENCE_CARRIER attribute. This value is expressed in dB.

lower_absolute_power (float):

This parameter returns the lower offset channel power.

The lower offset channel power is the integrated power of the RRC-filtered signal at the lower offset frequency. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22.

upper_absolute_power (float):

This parameter returns the upper offset channel power.

The upper offset channel power is the integrated power of the RRC-filtered signal at the upper offset frequency. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22.

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)

Fetches an array of absolute powers and an array of relative powers measured in the offset channels for the ACP measurement. The relative powers are measured with reference to the ACP_OFFSET_POWER_REFERENCE_CARRIER attribute.

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 time for which the method waits for the measurement to complete. This value is expressed in seconds. 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 an array of lower offset channel power values measured relative to the power of the carrier(s) that you specify in the ACP_OFFSET_POWER_REFERENCE_CARRIER attribute. This value is expressed in dB.

upper_relative_power (float):

This parameter returns an array of upper offset channel power values measured relative to the power of the carrier(s) that you specify in the ACP_OFFSET_POWER_REFERENCE_CARRIER attribute. This value is expressed in dB.

lower_absolute_power (float):

This parameter returns an array of lower offset channel power values.

The lower offset channel power is the integrated power of the RRC-filtered signal at the lower offset frequency. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22.

upper_absolute_power (float):

This parameter returns an array of upper offset channel power values.

The upper offset channel power is the integrated power of the RRC-filtered signal at the upper offset frequency. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22.

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.

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. 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 relative power values measured in each channel relative to the power reference carrier. This value is expressed in dB.

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)

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.

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. 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 at each frequency bin. The 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)

fetch_total_carrier_power(selector_string, timeout)

Fetches the total carrier power for the ACP 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 time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

total_carrier_power (float):

This parameter returns the sum of all active carrier powers, where each carrier power corresponds to the value of the ACP_RESULTS_CARRIER_ABSOLUTE_POWER attribute. This value is expressed in dBm. For a single-carrier measurement, total carrier power is the same as carrier absolute 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 (total_carrier_power, error_code)

get_carrier_absolute_power(selector_string)

Gets the carrier power.

This value is expressed in dBm.

The carrier power is the integrated power of the RRC-filtered signal. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22. The carrier is centered at a frequency determined by the CENTER_FREQUENCY and CARRIER_FREQUENCY attributes.

Use “carrier<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

Gets the carrier power relative to the ACP_RESULTS_TOTAL_CARRIER_POWER.

This value is expressed in dB.

Use “carrier<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the carrier power relative to the ACP_RESULTS_TOTAL_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_lower_offset_absolute_power(selector_string)

Gets the lower offset channel power.

This value is expressed in dBm.

The lower offset channel power is the integrated power of the RRC-filtered signal at the lower offset frequency. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22.

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.

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 relative to the power of the carrier(s) that you specify in the ACP_OFFSET_POWER_REFERENCE_CARRIER attribute.

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 relative to the power of the carrier(s) that you specify in the ACP_OFFSET_POWER_REFERENCE_CARRIER 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_total_carrier_power(selector_string)

Gets the sum of all active carrier powers, where each carrier power corresponds to the value of the ACP_RESULTS_CARRIER_ABSOLUTE_POWER attribute. For a single-carrier measurement, total carrier power is the same as carrier absolute 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 and named results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the sum of all active carrier powers, where each carrier power corresponds to the value of the ACP_RESULTS_CARRIER_ABSOLUTE_POWER attribute. For a single-carrier measurement, total carrier power is the same as carrier absolute 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_upper_offset_absolute_power(selector_string)

Gets the upper offset channel power.

This value is expressed in dBm.

The upper offset channel power is the integrated power of the RRC-filtered signal at the value of the upper offset frequency. The RRC filter uses a bandwidth of 3.84 MHz with a roll-off factor of 0.22.

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.

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 relative to the power of the carrier(s) that you specify in the ACP_OFFSET_POWER_REFERENCE_CARRIER attribute.

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 relative to the power of the carrier(s) that you specify in the ACP_OFFSET_POWER_REFERENCE_CARRIER 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)