PvtResults

Provides methods to fetch and read the Pvt measurement results.

class nirfmxgsm.pvt_results.PvtResults(signal_obj)

Bases: object

Provides methods to fetch and read the Pvt measurement results.

fetch_maximum_power_trace(selector_string, timeout, maximum_signal_power)

Fetches the maximum signal power trace.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. The default is “” (empty string).

  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.

• maximum_signal_power (numpy.float32) – This parameter returns an array of signal power values measured at each time instance.

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, 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_measurement_status(selector_string, timeout)

Fetches the overall PVT measurement status based on the standard defined measurement limits.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. The default is “” (empty string).

  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:

measurement_status (enums.PvtMeasurementStatus):

This parameter indicates the overall measurement status based on standard-defined limits.

Name (Value)	Description
Fail (0)	The measurement failed because the average power of at least one slot is outside the standard-defined limits.
Pass (1)	The measurement passed because the average power of all slots is within the standard-defined limits.

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, error_code)

fetch_minimum_power_trace(selector_string, timeout, minimum_signal_power)

Fetches the minimum signal power trace.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. The default is “” (empty string).

  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.

• minimum_signal_power (numpy.float32) – This parameter returns an array of signal power values measured at each time instance.

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, 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_power_trace(selector_string, timeout, upper_mask, signal_power, lower_mask)

Fetches the upper mask, signal power, and lower mask trace.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. The default is “” (empty string).

  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.

• upper_mask (numpy.float32) – This parameter returns an array of upper mask values measured at each time instance.

• signal_power (numpy.float32) – This parameter returns an array of upper mask values measured at each time instance.

• lower_mask (numpy.float32) – This parameter returns an array of upper mask values measured at each time instance.

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, 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_slot_measurement(selector_string, timeout)

Fetches the measurement results for a single-slot PVT measurement.

Use “slot<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 slot number. The default is “” (empty string).

  Example:

  ”slot0”

  ”result::r1/slot0”

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

slot_average_power (float):

This parameter returns the mean power of the signal, averaged over corresponding slots of each acquisition. This value is expressed in dBm.

slot_burst_width (float):

This parameter returns the burst width of the slot where the -3 dB transition points occur. This value is expressed in seconds.

slot_measurement_status (enums.PvtSlotMeasurementStatus):

This parameter indicates the PVT measurement status for a particular slot.

Name (Value)	Description
Fail (0)	The signal power is outside the standard-defined upper or lower mask
Pass (1)	The signal power is within the standard-defined upper and lower mask.

slot_maximum_power (float):

This parameter returns the maximum power of the signal, averaged over corresponding slots of each acquisition. This value is expressed in dBm.

slot_minimum_power (float):

This parameter returns the minimum power of the signal, averaged over corresponding slots of each acquisition. This value is expressed in dBm.

slot_burst_threshold (float):

This parameter returns the threshold that the PVT measurement uses to determine the burst validity. 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 (slot_average_power, slot_burst_width, slot_measurement_status, slot_maximum_power, slot_minimum_power, slot_burst_threshold, error_code)

fetch_slot_measurement_array(selector_string, timeout)

Fetches the PVT measurement results for each slot.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. The default is “” (empty string).

  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:

slot_average_power (float):

This parameter returns an array of mean powers of the signal, averaged over corresponding slots of each acquisition. This value is expressed in dBm.

slot_burst_width (float):

This parameter returns an array of burst widths for the slots where the -3 dB transition points occur. This value is expressed in seconds.

slot_measurement_status (enums.PvtSlotMeasurementStatus):

This parameter indicates an array of PVT measurement statuses for multiple slots.

Name (Value)	Description
Fail (0)	The signal power is outside the standard-defined upper or lower mask
Pass (1)	The signal power is within the standard-defined upper and lower mask.

slot_maximum_power (float):

This parameter returns an array of maximum powers of the signal, averaged over corresponding slots of each acquisition. This value is expressed in dBm.

slot_minimum_power (float):

This parameter returns an array of minimum powers of the signal, averaged over corresponding slots of each acquisition. This value is expressed in dBm.

slot_burst_threshold (float):

This parameter returns an array of thresholds that the PVT measurement uses to determine the burst validity. 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 (slot_average_power, slot_burst_width, slot_measurement_status, slot_maximum_power, slot_minimum_power, slot_burst_threshold, error_code)

get_measurement_status(selector_string)

Indicates the overall measurement status based on standard-defined limits.

You do not need to use a Selector String to read this result for the default signal and result instances. Refer to the Selector String topic for information about the string syntax for named signals and named results.

Name (Value)	Description
Fail (0)	The measurement failed because the average power of at least one slot is outside the standard-defined limits.
Pass (1)	The measurement passed because the average power of all slots is within the standard-defined limits.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtMeasurementStatus):

Indicates the overall measurement status based on standard-defined limits.

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

Gets the mean power of the signal, averaged over the corresponding slots of each acquisition. This value is expressed in dBm.

Use “slot<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean power of the signal, averaged over the corresponding slots of each acquisition. 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_slot_burst_threshold(selector_string)

Gets the threshold that the power versus time (PVT) measurement uses to determine the burst validity. This value is expressed in dBm.

Use “slot<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the threshold that the power versus time (PVT) measurement uses to determine the burst validity. 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_slot_burst_width(selector_string)

Gets the burst width for the slot where the -3 dB transition points occur. This value is expressed in seconds.

Use “slot<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the burst width for the slot where the -3 dB transition points occur. 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_slot_maximum_power(selector_string)

Gets the maximum power of the signal, averaged over the corresponding slots of each acquisition. This value is expressed in dBm.

Use “slot<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum power of the signal, averaged over the corresponding slots of each acquisition. 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_slot_measurement_status(selector_string)

Indicates the power versus time (PVT) measurement status for a particular slot.

Use “slot<n>” as the selector string to read this attribute.

Name (Value)	Description
Fail (0)	The average power for at least one slot is outside the standard-defined limits.
Pass (1)	The average power for each slot is within the standard-defined limits.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtSlotMeasurementStatus):

Indicates the power versus time (PVT) measurement status for a particular slot.

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

Gets the minimum power of the signal, averaged over the corresponding slots of each acquisition. This value is expressed in dBm.

Use “slot<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the minimum power of the signal, averaged over the corresponding slots of each acquisition. 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)