PvtResults

Provides methods to fetch and read the Pvt measurement results.

class nirfmxnr.pvt_results.PvtResults(signal_obj)

Bases: object

Provides methods to fetch and read the Pvt measurement results.

fetch_measurement(selector_string, timeout)

Fetches PVT ON and OFF powers along with measurement status and burst width.

Use “carrier<k>” or “subblock<n>/carrier<k>” as the selector string to read 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 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.

Returns:

measurement_status (enums.PvtMeasurementStatus):

This parameter returns the measurement status indicating whether the off power before and after 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.

absolute_off_power_before (float):

This parameter returns the OFF power in the segment before the captured burst. The segment is defined as one slot prior to a short transient segment and the burst. This value is expressed in dBm.

absolute_off_power_after (float):

This parameter returns the OFF power in the segment after the captured burst. The segment is defined as one slot after the burst and a short transient segment. This value is expressed in dBm.

absolute_on_power (float):

This parameter returns the power of the subframes within the captured burst. This value is expressed in dBm.

burst_width (float):

This parameter 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 (measurement_status, absolute_off_power_before, absolute_off_power_after, absolute_on_power, burst_width, error_code)

fetch_measurement_array(selector_string, timeout)

Fetches an array of PVT ON and OFF powers along with measurement status and burst width.

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:

measurement_status (enums.PvtMeasurementStatus):

This parameter returns the measurement status indicating whether the off power before and after 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.

absolute_off_power_before (float):

This parameter returns the OFF power in the segment before the captured burst. The segment is defined as one slot prior to a short transient segment and the burst. This value is expressed in dBm.

absolute_off_power_after (float):

This parameter returns the OFF power in the segment after the captured burst. The segment is defined as one slot after the burst and a short transient segment. This value is expressed in dBm.

absolute_on_power (float):

This parameter returns the power of the subframes within the captured burst. This value is expressed in dBm.

burst_width (float):

This parameter 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 (measurement_status, absolute_off_power_before, absolute_off_power_after, absolute_on_power, burst_width, error_code)

fetch_signal_power_trace(selector_string, timeout, signal_power, absolute_limit)

Fetches an instantanous signal power trace along with the absolute limit for each segment in the trace. For uplink, the power unit of the returned traces is dBm, while for downlink, the power unit of the returned traces is dBm/MHz.

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

• 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)

fetch_windowed_signal_power_trace(selector_string, timeout, windowed_signal_power)

Fetches the 70/N us windowed power trace in dBm/MHz for Downlink, while an empty trace is returned for Uplink.

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

• windowed_signal_power (numpy.float32) – This parameter returns the 70/N us windowed power trace in dBm/MHz for Downlink, while an empty trace is returned for Uplink.

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

Gets the OFF power in the segment after the captured burst for the uplink direction, while it returns NaN in the segment after the captured burst for the downlink direction. The segment is defined as one slot after the burst and a short transient segment. 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.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the OFF power in the segment after the captured burst for the uplink direction, while it returns NaN in the segment after the captured burst for the downlink direction. The segment is defined as one slot after the burst and a short transient segment. 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_off_power_before(selector_string)

Gets the OFF power in the segment before the captured burst for the uplink direction, while it returns NaN in the segment after the captured burst for the downlink direction. The segment is defined as one slot prior to a short transient segment and the burst.

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.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the OFF power in the segment before the captured burst for the uplink direction, while it returns NaN in the segment after the captured burst for the downlink direction. The segment is defined as one slot prior to a short transient segment and the 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 (attr_val, error_code)

get_absolute_on_power(selector_string)

Gets the average ON power within the measurement interval. 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.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average ON power within the measurement interval. 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_burst_width(selector_string)

Gets the width of the captured burst for the uplink direction, while it returns NaN of the captured burst for the downlink direction. This value is expressed in seconds.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the width of the captured burst for the uplink direction, while it returns NaN of the captured burst for the downlink direction. 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_measurement_status(selector_string)

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

Use “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>” as the Selector String to read this attribute.

The default value is 0.

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 off power before and after 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)

get_peak_windowed_off_power(selector_string)

Gets the NaN for the uplink direction, while it returns the peak power value of 70/N us windowed power during all OFF regions in the measurement interval. This value is expressed in dBm/MHz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the NaN for the uplink direction, while it returns the peak power value of 70/N us windowed power during all OFF regions in the measurement interval. This value is expressed in dBm/MHz.

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

Gets the NaN for the uplink direction, while it returns the PVT_RESULTS_PEAK_WINDOWED_OFF_POWER to the 3GPP limit. 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 NaN for the uplink direction, while it returns the PVT_RESULTS_PEAK_WINDOWED_OFF_POWER to the 3GPP limit. 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)

get_peak_windowed_off_power_time(selector_string)

Gets the NaN for the uplink direction, while it returns the time offset of the PVT_RESULTS_PEAK_WINDOWED_OFF_POWER. This value is expressed in seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the NaN for the uplink direction, while it returns the time offset of the PVT_RESULTS_PEAK_WINDOWED_OFF_POWER. 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)