PvtResults

Provides methods to fetch and read the Pvt measurement results.

class nirfmxlte.pvt_results.PvtResults(signal_obj)

Bases: object

Provides methods to fetch and read the Pvt measurement results.

fetch_measurement(selector_string, timeout)

Returns the measurement.

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

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:

measurement_status (enums.PvtMeasurementStatus):

This parameter returns the measurement status indicating whether the power before and after the burst is within the standard defined limit.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

mean_absolute_off_power_before (float):

This parameter returns the mean power in the segment before the captured burst. The segment is defined as one subframe prior to the burst for the FDD mode and 10 SCFDMA symbols prior to the burst for the TDD mode. This value is expressed in dBm.

mean_absolute_off_power_after (float):

This parameter returns the mean power in the segment after the captured burst. This value is expressed in dBm.

The segment is defined as one subframe long excluding a transient period of 20 μs at the beginning. This value is expressed in dBm.

mean_absolute_on_power (float):

This parameter returns the average power of the subframes within the captured burst, excluding a transient period of 20 μs at the beginning. This value is expressed in dBm.

burst_width (float):

This parameter returns the width of the captured burst.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (measurement_status, mean_absolute_off_power_before, mean_absolute_off_power_after, mean_absolute_on_power, burst_width, error_code)

fetch_measurement_array(selector_string, timeout)

Returns the measurement array.

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

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:

measurement_status (enums.PvtMeasurementStatus):

This parameter returns the array of the measurement status indicating whether the power before and after the burst is within the standard defined limit.

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

mean_absolute_off_power_before (float):

This parameter returns the array of the mean power in the segment before the captured burst. The segment is defined as one subframe prior to the burst for the FDD mode and 10 SCFDMA symbols prior to the burst for the TDD mode. This value is expressed in dBm.

mean_absolute_off_power_after (float):

This parameter returns the array of the mean power in the segment after the captured burst. This value is expressed in dBm.

The segment is defined as one subframe long excluding a transient period of 20 μs at the beginning.

mean_absolute_on_power (float):

This parameter returns the array of the average power of the subframes within the captured burst, excluding a transient period of 20 μs at the beginning. This value is expressed in dBm.

burst_width (float):

This parameter returns the array of the width of the captured burst.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (measurement_status, mean_absolute_off_power_before, mean_absolute_off_power_after, mean_absolute_on_power, burst_width, error_code)

fetch_signal_power_trace(selector_string, timeout, signal_power, absolute_limit)

Returns the instantaneous signal power trace along with absolute limit for each segment in the trace as specified by section 6.5.2.4.5 of the 3GPP 36.521. 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) –

  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.

• signal_power (numpy.float32) – This parameter returns the instantaneous signal power trace. This value is expressed in dBm.

• absolute_limit (numpy.float32) – This parameter returns the instantaneous signal power trace. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns start time of the signal. This value is expressed in seconds.

dx (float):

This parameter returns the time bin spacing. This value is expressed in seconds.

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

Gets the width of the captured burst. This value is expressed in seconds.

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 width of the captured burst. This value is expressed in seconds.

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

Gets the mean power in the segment after the captured burst. This value is expressed in dBm. The segment is defined as one subframe long, excluding a transient period of 20 micro seconds at the beginning.

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

Refer to the LTE PVT (Power Vs Time) Measurement topic for more information about OFF Power.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean power in the segment after the captured burst. This value is expressed in dBm. The segment is defined as one subframe long, excluding a transient period of 20 micro seconds at the beginning.

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

Gets the mean power in the segment before the captured burst. The segment is defined as one subframe prior to the burst for the FDD mode and 10 SC-FDMA symbols prior to the burst for the TDD mode. This value is expressed in dBm.

Refer to the LTE PVT (Power Vs Time) Measurement topic for more information about OFF Power.

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 mean power in the segment before the captured burst. The segment is defined as one subframe prior to the burst for the FDD mode and 10 SC-FDMA symbols prior to the burst for the TDD mode. 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_mean_absolute_on_power(selector_string)

Gets the average power of the subframes within the captured burst. This value is expressed in dBm. The average power excludes the transient period of 20 micro seconds at the beginning.

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 average power of the subframes within the captured burst. This value is expressed in dBm. The average power excludes the transient period of 20 micro seconds at the beginning.

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

Gets the measurement status indicating whether the power before and after the burst is within the standard defined limit.

Refer to the LTE PVT (Power Vs Time) Measurement topic for more information about measurement status.

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

Name (Value)	Description
Fail (0)	Indicates that the measurement has failed.
Pass (1)	Indicates that the measurement has passed.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtMeasurementStatus):

Returns the measurement status indicating whether the power before and after the burst is within the standard defined limit.

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)