SemComponentCarrierResults

class nirfmxlte.sem_component_carrier_results.SemComponentCarrierResults(signal_obj)

Bases: object

fetch_measurement(selector_string, timeout)

Returns the absolute power and relative power measured in the component carrier. The relative power is relative to subblock power.

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

Parameters:

• selector_string (string) –

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

  Example:

  ”subblock0/carrier0”

  ”result::r1/subblock0/carrier0”

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

absolute_integrated_power (float):

This parameter returns the power measured over the integration bandwidth of the carrier. 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.

relative_integrated_power (float):

This parameter returns the component carrier power relative to its subblock 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 (absolute_integrated_power, relative_integrated_power, error_code)

fetch_measurement_array(selector_string, timeout)

Returns an array of the absolute powers and relative powers measured in the component carriers. The relative power is relative to subblock power.

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:

absolute_integrated_power (float):

This parameter returns the array of power measured in the subblock. 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.

relative_integrated_power (float):

This parameter returns the array of the sum of powers of all the frequency bins over the integration bandwidth of the component carrier power relative to its subblock 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 (absolute_integrated_power, relative_integrated_power, error_code)

get_absolute_integrated_power(selector_string)

Gets the sum of powers of all the frequency bins over the integration bandwidth of the carrier. This value is expressed in dBm.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 carrier. 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_absolute_peak_power(selector_string)

Gets the peak power in the component carrier. This value is expressed in dBm.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power in the component carrier. 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_peak_frequency(selector_string)

Gets the frequency at which the peak power occurs in the component carrier. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency at which the peak power occurs in the component carrier. 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 (attr_val, error_code)

get_relative_integrated_power(selector_string)

Gets the sum of powers of all the frequency bins over the integration bandwidth of the component carrier power relative to its subblock power. This value is expressed in dB.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 component carrier power relative to its subblock 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 (attr_val, error_code)