SlotPhaseResults

Provides methods to fetch and read the SlotPhase measurement results.

class nirfmxwcdma.slotphase_results.SlotPhaseResults(signal_obj)

Bases: object

Provides methods to fetch and read the SlotPhase measurement results.

fetch_chip_phase_error_linear_fit_trace(selector_string, timeout, chip_phase_error_linear_fit)

Fetches the chip phase error linear fit trace for the SlotPhase measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the time 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. The default value is 10.

• chip_phase_error_linear_fit (numpy.float32) – This parameter returns the linear-fit chip phase error values. This value is expressed in degrees.

Returns:

x0 (float):

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

dx (float):

This parameter returns the chip duration. 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_chip_phase_error_trace(selector_string, timeout, chip_phase_error)

Fetches the chip phase error trace for the SlotPhase measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the time 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. The default value is 10.

• chip_phase_error (numpy.float32) – This parameter returns an array of phase error values. This value is expressed in degrees.

Returns:

x0 (float):

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

dx (float):

This parameter returns the chip duration. 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_measurement(selector_string, timeout)

Fetches the maximum phase discontinuity, discontinuity count greater than Limit 1, discontinuity count greater than Limit 2, and discontinuity minimum distance results.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the signal name and result name.

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the time 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. The default value is 10.

Returns:

maximum_phase_discontinuity (float):

This parameter returns the maximum of all the measured phase discontinuity values at the slot boundaries.

This value is expressed in degrees.

discontinuity_count_greater_than_limit1 (int):

This parameter returns the number of times the phase discontinuity values exceed the Limit 1 value for the acquired signal. Limit 1 is fixed at 36 degrees.

discontinuity_count_greater_than_limit2 (int):

This parameter returns the number of times the phase discontinuity values exceed the Limit 2 value for the acquired signal. Limit 2 is fixed at 66 degrees.

discontinuity_minimum_distance (int):

This parameter returns the minimum distance between two phase discontinuity measurements exceeding the Limit 1 value. Limit 1 is fixed at 36 degrees. This value is expressed in slots.

If there are no phase discontinuity values greater than Limit 1, or if there is only one phase discontinuity value greater than Limit 1, this result is not valid. In such a case, -1 is reported as the result.

error_code (int):

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

Return type:

Tuple (maximum_phase_discontinuity, discontinuity_count_greater_than_limit1, discontinuity_count_greater_than_limit2, discontinuity_minimum_distance, error_code)

fetch_phase_discontinuities(selector_string, timeout)

Fetches the phase discontinuity values for the slot phase measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the signal name and result name.

  Example:

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the time 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. The default value is 10.

Returns:

slot_phase_discontinuity (float):

This parameter returns the difference between the first extrapolated linear chip phase of the current slot and the last extrapolated linear chip phase of the preceding slot. The extrapolation is for the exclusion period of 25us on either side of the slot boundary. If you set the SLOTPHASE_TRANSIENT_REMOVAL_ENABLED attribute to False, this parameter returns the difference between the first and last linear chip phase, at each slot boundary. This value is expressed in degrees.

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

get_discontinuity_count_greater_than_limit1(selector_string)

Gets the number of times the phase discontinuity values exceed the Limit 1 value for the acquired signal. Limit 1 is fixed at 36 degrees.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the number of times the phase discontinuity values exceed the Limit 1 value for the acquired signal. Limit 1 is fixed at 36 degrees.

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

Gets the number of times the phase discontinuity values exceed the Limit 2 value for the acquired signal. Limit 2 is fixed at 66 degrees.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the number of times the phase discontinuity values exceed the Limit 2 value for the acquired signal. Limit 2 is fixed at 66 degrees.

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

Gets the minimum distance between two phase discontinuity measurements exceeding the Limit 1 value. Limit 1 is fixed at 36 degrees. This value is expressed in slots.

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

If there are no phase discontinuity values greater than Limit 1, or if there is only one phase discontinuity value greater than Limit 1, this result is not valid. In such a case, -1 is reported as the result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the minimum distance between two phase discontinuity measurements exceeding the Limit 1 value. Limit 1 is fixed at 36 degrees. This value is expressed in slots.

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

Gets the maximum of all the measured phase discontinuity values at the slot boundaries.

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

This value is expressed in degrees.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum of all the measured phase discontinuity values at the slot boundaries.

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)