PvtResults

Provides methods to fetch and read the Pvt measurement results.

class nirfmxtdscdma.pvt_results.PvtResults(signal_obj)

Bases: object

Provides methods to fetch and read the Pvt measurement results.

fetch_measurement_status(selector_string, timeout)

Fetches the overall status of the power versus time (PVT) measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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 returns the overall status of the PVT measurement.

Name (value)	Description
Fail (0)	Indicates that the test has failed, and the measured power in at least one measurement segment violates the limit.
Pass (1)	Indicates that the test has passed and the measured power in all defined segments does not violate the 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_powers(selector_string, timeout)

Fetches the values of the Mean Absolute ON Power and Mean Absolute OFF Power parameters.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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:

mean_absolute_on_power (float):

This parameter returns the mean on power of the measured burst, or the averaged bursts. This value is expressed in dBm.

mean_absolute_off_power (float):

This parameter returns the mean off power of the measured burst, or the averaged bursts. 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 (mean_absolute_on_power, mean_absolute_off_power, error_code)

fetch_segment_measurement(selector_string, timeout)

Returns the status of a specific power versus time (PVT) measurement segment along with the measured segment powers.

Use “segment<n>” as the Selector String to read this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and segment number. Examples:

  ”segment0”

  ”signal::sig1/segment0”

  ”result::r1/segment0”

  ”signal::sig1/result::r1/segment0”

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

segment_status (enums.PvtSegmentStatus):

This parameter returns the measurement status for an individual PVT measurement segment.

Name (value)	Description
Fail (0)	Indicates that the test has failed, and the measured power in at least one measurement segment violates the limit.
Pass (1)	Indicates that the test has passed and the measured power in all defined segments does not violate the limits.

segment_margin (float):

This parameter returns the power margin for an individual PVT measurement segment, which is the minimum power distance to the power limit measured within the PVT measurement segment. This value is expressed in dB.

segment_margin_time (float):

This parameter returns the position in time corresponding to the Segment Margin parameter. This value is expressed in seconds.

segment_mean_absolute_power (float):

This parameter returns the mean measured power corresponding to the Segment Margin parameter. This value is expressed in dBm.

segment_maximum_absolute_power (float):

This parameter returns the maximum measured power of an individual PVT measurement segment. This value is expressed in dBm.

segment_minimum_absolute_power (float):

This parameter returns the minimum measured power of an individual PVT measurement 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 (segment_status, segment_margin, segment_margin_time, segment_mean_absolute_power, segment_maximum_absolute_power, segment_minimum_absolute_power, error_code)

fetch_segment_measurement_array(selector_string, timeout)

Fetches the status and measured powers for all the power versus time (PVT) measurement segments.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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:

segment_status (enums.PvtSegmentStatus):

This parameter returns an array of the measurement status values for an individual PVT measurement segment.

Name (value)	Description
Fail (0)	Indicates that the test has failed, and the measured power in at least one measurement segment violates the limit.
Pass (1)	Indicates that the test has passed and the measured power in all defined segments does not violate the limits.

segment_margin (float):

This parameter returns an array of the power margins for an individual PVT measurement segment, which is the minimum power distance to the power limit measured within the PVT measurement segment. This value is expressed in dB.

segment_margin_time (float):

This parameter returns an array of the positions in time corresponding to the Segment Margin parameter. This value is expressed in seconds.

segment_mean_absolute_power (float):

This parameter returns an array of the mean measured powers corresponding to the Segment Margin parameter. This value is expressed in dBm.

segment_maximum_absolute_power (float):

This parameter returns an array of the maximum measured powers of an individual PVT measurement segment. This value is expressed in dBm.

segment_minimum_absolute_power (float):

This parameter returns an array of the minimum measured powers of an individual PVT measurement 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 (segment_status, segment_margin, segment_margin_time, segment_mean_absolute_power, segment_maximum_absolute_power, segment_minimum_absolute_power, error_code)

fetch_signal_power_trace(selector_string, timeout, signal_power, absolute_limit)

Fetches the signal power trace and the absolute limit trace. The limit trace is defined by the transmit ON/off time mask measurement in the 3GPP TS 34.122 specification.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/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.

• signal_power (numpy.float32) – This parameter returns an array of values for the signal power trace. These values are expressed in dBm.

• absolute_limit (numpy.float32) – This parameter returns an array of values for the signal power trace. These values are expressed in dBm.

Returns:

x0 (float):

This parameter returns the start time of the trace relative to the start of the analyzed burst.

dx (float):

This parameter returns the time difference between successive trace samples.

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 time interval between the time positions where the signal amplitude has reached 90 percent of the full amplitude. This value is expressed in seconds.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the time interval between the time positions where the signal amplitude has reached 90 percent of the full amplitude. 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_maximum_absolute_power(selector_string)

Gets the maximum power of the measured burst, or the averaged bursts. This value is expressed in dBm.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum power of the measured burst, or the averaged bursts. 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_off_power(selector_string)

Gets the mean OFF power of the measured burst, or the averaged bursts. This value is expressed in dBm.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean OFF power of the measured burst, or the averaged bursts. 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 mean ON power of the measured burst, or the averaged bursts. This value is expressed in dBm.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean ON power of the measured burst, or the averaged bursts. 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_measurement_status(selector_string)

Gets the overall status of the power versus time (PVT) measurement.

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.

Name (Value)	Description
Fail (0)	Indicates that the test has failed, and the measured power in at least one measurement segment violates the limit.
Pass (1)	Indicates that the test has passed and the measured power in all defined segments does not violate the limits.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtMeasurementStatus):

Returns the overall status of the power versus time (PVT) measurement.

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

Gets the midamble code used for slot synchronization.

You do not need to use a selector string to read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the midamble code used for slot synchronization.

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

Gets the midamble code shift used for slot synchronization. This value is expressed in chips.

You do not need to use a selector string to read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the midamble code shift used for slot synchronization. This value is expressed in chips.

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

Gets the minimum observed power of the measured burst, or the averaged bursts. This value is expressed in dBm.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the minimum observed power of the measured burst, or the averaged bursts. 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_segment_margin(selector_string)

Gets the power margin for an individual power versus time (PVT) measurement segment, which is the minimum power distance to the power limit measured within the PVT measurement segment. This value is expressed in dB.

Use “segment<n>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the power margin for an individual power versus time (PVT) measurement segment, which is the minimum power distance to the power limit measured within the PVT measurement segment. 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_segment_margin_time(selector_string)

Gets the position in time corresponding to the PVT_RESULTS_SEGMENT_MARGIN attribute. This value is expressed in seconds.

Use “segment<n>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the position in time corresponding to the PVT_RESULTS_SEGMENT_MARGIN attribute. 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_segment_maximum_absolute_power(selector_string)

Gets the maximum measured power of an individual power versus time (PVT) measurement segment. This value is expressed in dBm.

Use “segment<n>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum measured power of an individual power versus time (PVT) measurement 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_segment_mean_absolute_power(selector_string)

Gets the mean measured power corresponding to the PVT_RESULTS_SEGMENT_MARGIN attribute. This value is expressed in dBm.

Use “segment<n>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean measured power corresponding to the PVT_RESULTS_SEGMENT_MARGIN attribute. 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_segment_minimum_absolute_power(selector_string)

Gets the minimum measured power of an individual power versus time (PVT) measurement segment. This value is expressed in dBm.

Use “segment<n>” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the minimum measured power of an individual power versus time (PVT) measurement 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_segment_status(selector_string)

Gets the measurement status for an individual power versus time (PVT) measurement segment.

Use “segment<n>” as the Selector String to read this result.

Name (Value)	Description
Fail (0)	Indicates that the test has failed and the measured power in at least one measurement segment violates the limit.
Pass (1)	Indicates that the test has passed and the measured power in all defined segments does not violate the limits.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtSegmentStatus):

Returns the measurement status for an individual power versus time (PVT) measurement segment.

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)