AcpResults

Provides methods to fetch and read the Acp measurement results.

class nirfmxlte.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.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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.

• 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 power measured in each channel. The carrier power is reported in dBm when you set the ACP_POWER_UNITS attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/Hz.

Returns:

x0 (float):

This parameter returns the start frequency of the channel. 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_offset_measurement(selector_string, timeout)

Returns the absolute and relative power of the lower and upper offset channel. The relative power is relative to subblock power.

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

Refer to the 3GPP TS 36.521 specification for more information about the applicability of an offset channel. Refer to the LTE Uplink Adjacent Channel Power and LTE Downlink Adjacent Channel Power topics for more information.

Parameters:

• selector_string (string) –

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

  Example:

  ”subblock0/offset0”

  ”result::r1/subblock0/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 power in lower (negative) offset channel relative to value returned by the ACP_RESULTS_TOTAL_AGGREGATED_POWER attribute. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned.

upper_relative_power (float):

This parameter returns the power in upper (positive) offset channel relative to the value returned by the ACP Results Total Aggregated Pwr attribute. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned.

lower_absolute_power (float):

This parameter returns the lower offset channel power. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned. The offset channel power is reported in dBm when you set the ACP_POWER_UNITS attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/Hz.

upper_absolute_power (float):

This parameter returns the upper offset channel power. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned. The offset channel power is reported in dBm when you set the ACP Pwr Units attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/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 (lower_relative_power, upper_relative_power, lower_absolute_power, upper_absolute_power, error_code)

fetch_offset_measurement_array(selector_string, timeout)

Returns an array of absolute and relative powers of the lower and upper offset channels. The relative power is relative to subblock power. The order of the offsets in the result array is universal terrestrial radio access (UTRA) (1, 2, …m) and evolved universal terrestrial radio access (E-UTRA) (1, …, n), where m and n are the number of UTRA offsets and the number of EUTRA offsets respectively.

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

Refer to the 3GPP TS 36.521 specification for more information about the applicability of an offset channel. Refer to the LTE Uplink Adjacent Channel Power and LTE Downlink Adjacent Channel Power topics for more information

Parameters:

• selector_string (string) –

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

  Example:

  ”subblock0”

  ”result::r1/subblock0”

  You can use the build_subblock_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 power in lower (negative) offset channel relative to the value returned by the ACP_RESULTS_TOTAL_AGGREGATED_POWER attribute. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned.

upper_relative_power (float):

This parameter returns the array of powers in upper (positive) offset channel relative to the value returned by the ACP Results Total Aggregated Pwr attribute. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned.

lower_absolute_power (float):

This parameter returns the array of lower offset channel power. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned. The offset channel power is reported in dBm when you set the ACP_POWER_UNITS attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/Hz.

upper_absolute_power (float):

This parameter returns the array of upper offset channel powers. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned. The offset channel power is reported in dBm when you set the ACP Pwr Units attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/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 (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 ACP measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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.

• 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 relative power measured in each channel relative to total aggregated power. This value is expressed in dB.

Returns:

x0 (float):

This parameter returns the start frequency of the channel. 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 the 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.

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

Returns:

x0 (float):

This parameter returns the start frequency of the channel. 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_subblock_measurement(selector_string, timeout)

Returns the power, integration bandwidth, and center frequency of the subblock.

Use “subblock<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 subblock number.

  Example:

  ”subblock0”

  ”result::r1/subblock0”

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

subblock_power (float):

This parameter returns the sum of powers of all the frequency bins over the integration bandwidth of the subblock. When you set the ACP_POWER_UNITS attribute to dBm, the parameter returns the total subblock power in dBm of all the active carriers measured over the subblock. When you set the ACP Pwr Units attribute to dBm/Hz, the parameter returns the power spectral density in dBm/Hz based on the power in all the active carriers measured over the subblock.

integration_bandwidth (float):

This parameter returns the integration bandwidth used in calculating the power of the subblock. Integration bandwidth is the span from left edge of the leftmost carrier to the right edge of the rightmost carrier within a subblock. This value is expressed in Hz.

frequency (float):

This parameter returns the absolute center frequency of the subblock. This value is the center of the subblock integration bandwidth. 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 (subblock_power, integration_bandwidth, frequency, error_code)

fetch_total_aggregated_power(selector_string, timeout)

Fetches the sum of powers in all the subblocks.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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:

total_aggregated_power (float):

This parameter returns the sum of powers of all the frequency bins over the integration bandwidth of subblock. This value includes the power in the inter-carrier gaps within a subblock, but it does not include the power in the subblock gaps.

When you set the ACP_POWER_UNITS attribute to dBm, the parameter returns the total integrated power in dBm of all the active carriers measured. When you set the ACP Pwr Units attribute to dBm/Hz, the parameter returns the power spectral density in dBm/Hz based on the power in all the active carriers 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 (total_aggregated_power, error_code)

get_lower_offset_absolute_power(selector_string)

Gets the lower (negative) offset channel power. If this offset is not applicable for the intra-band non-contiguous type of carrier aggregation, a NaN is returned. The offset channel power is reported in dBm when you set the ACP_POWER_UNITS attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/Hz.

Refer to the 3GPP 36.521 specification for more information about the applicability of an offset channel. Refer to the LTE Uplink Adjacent Channel Power and LTE Downlink Adjacent Channel Power topics for more information.

Use “offset<k>” or “subblock<n>/offset<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the lower (negative) offset channel power. If this offset is not applicable for the intra-band non-contiguous type of carrier aggregation, a NaN is returned. The offset channel power is reported in dBm when you set the ACP_POWER_UNITS attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/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_lower_offset_relative_power(selector_string)

Gets the power in lower (negative) offset channel relative to the total aggregated power. This value is expressed in dB. If this offset is not applicable for the intra-band non-contiguous type of carrier aggregation, a NaN is returned.

Refer to the 3GPP TS 36.521 specification for more information about the applicability of the offset channel. Refer to the LTE Uplink Adjacent Channel Power and LTE Downlink Adjacent Channel Power topics for more information.

Use “offset<k>” or “subblock<n>/offset<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power in lower (negative) offset channel relative to the total aggregated power. This value is expressed in dB. If this offset is not applicable for the intra-band non-contiguous type of carrier aggregation, a NaN is returned.

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

Gets the absolute center frequency of the subblock, which is the center of the subblock integration bandwidth. This value is expressed in Hz. Integration bandwidth is the span from the left edge of the leftmost carrier to the right edge of the rightmost carrier within the subblock.

Use “subblock<n>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the absolute center frequency of the subblock, which is the center of the subblock integration bandwidth. This value is expressed in Hz. Integration bandwidth is the span from the left edge of the leftmost carrier to the right edge of the rightmost carrier within the subblock.

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

Gets the integration bandwidth used in calculating the power of the subblock. This value is expressed in Hz. Integration bandwidth is the span from left edge of the leftmost carrier to the right edge of the rightmost carrier within the subblock.

Use “subblock<n>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the integration bandwidth used in calculating the power of the subblock. This value is expressed in Hz. Integration bandwidth is the span from left edge of the leftmost carrier to the right edge of the rightmost carrier within the subblock.

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

Gets the sum of powers of all the frequency bins over the integration bandwidth of the subblock.

When you set the ACP_POWER_UNITS attribute to dBm, the attribute returns the total subblock power in dBm of all the active carriers measured over the subblock. When you set the ACP Pwr Units attribute to dBm/Hz, the attribute returns the power spectral density in dBm/Hz based on the power in all the active carriers measured over the subblock.

Use “subblock<n>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the sum of powers of all the frequency bins over the integration bandwidth of the subblock.

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

Gets the sum of powers of all the frequency bins over the integration bandwidths of all subblocks. The sum includes the power in inter-carrier gaps within a subblock but it does not include the power in subblock gaps.

When you set the ACP_POWER_UNITS attribute to dBm, the attribute returns the total integrated power in dBm of all the active carriers measured. When you set the ACP Pwr Units attribute to dBm/Hz, the attribute returns the power spectral density in dBm/Hz based on the power in all the active carriers measured.

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 sum of powers of all the frequency bins over the integration bandwidths of all subblocks. The sum includes the power in inter-carrier gaps within a subblock but it does not include the power in subblock gaps.

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 (positive) offset channel power. If this offset is not applicable for the intra-band non-contiguous type of carrier aggregation, a NaN is returned. The offset channel power is reported in dBm when you set the ACP_POWER_UNITS attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/Hz.

Refer to the 3GPP TS 36.521 specification for more information about the applicability of offset channel. Refer to the LTE Uplink Adjacent Channel Power and LTE Downlink Adjacent Channel Power topics for more information about ACP offsets.

Use “offset<k>” or “subblock<n>/offset<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the upper (positive) offset channel power. If this offset is not applicable for the intra-band non-contiguous type of carrier aggregation, a NaN is returned. The offset channel power is reported in dBm when you set the ACP_POWER_UNITS attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/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_upper_offset_relative_power(selector_string)

Gets the power in the upper (positive) offset channel relative to the total aggregated power. This value is expressed in dB. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned.. Refer to the 3GPP TS 36.521 specification for more information about the applicability of the offset channel.

Refer to the LTE Uplink Adjacent Channel Power and LTE Downlink Adjacent Channel Power topics for more information about ACP offsets.

Use “offset<k>” or “subblock<n>/offset<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power in the upper (positive) offset channel relative to the total aggregated power. This value is expressed in dB. If this offset is not applicable for the intra band non contagious type of carrier aggregation, a Nan is returned.. Refer to the 3GPP TS 36.521 specification for more information about the applicability of the offset channel.

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)