ChpComponentCarrierResults

class nirfmxnr.chp_component_carrier_results.ChpComponentCarrierResults(signal_obj)

Bases: object

fetch_measurement(selector_string, timeout)

Returns the absolute and relative powers measured in the component carriers.

Use “carrier<k>” or “subblock<n>” 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_power (float):

This parameter returns the power measured over the integration bandwidth of the component carrier. This value is expressed in dBm.

relative_power (float):

This parameter returns 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 (absolute_power, relative_power, error_code)

fetch_measurement_array(selector_string, timeout)

Returns an array of the absolute and relative powers measured in the component carriers.

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_power (float):

This parameter returns an array of the power measured over the integration bandwidth of the component carrier. This value is expressed in dBm.

relative_power (float):

This parameter returns an array 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 (absolute_power, relative_power, error_code)

get_absolute_power(selector_string)

Gets the power measured over the integration bandwidth of the component carrier. This value is expressed in dBm.

Use “carrier<k>” or “subblock<n>” 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 power measured over the integration bandwidth of 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_relative_power(selector_string)

Gets the component carrier power relative to its subblock power. This value is expressed in dB.

Use “carrier<k>” or “subblock<n>” 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 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)