SlotPhaseResults

Provides methods to fetch and read the SlotPhase measurement results.

class nirfmxcdma2k.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 trace linear fit trace for the SlotPhase measurement. The linear fit is obtained from the chip phase error on a slot basis. If a transient duration greater than zero is configured, the linear fit computation ignores the data of the transient duration on either side of the slot boundary and extrapolates the phase error to the slot boundaries.

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.

• chip_phase_error_linear_fit (numpy.float32) – This parameter returns the array of chip phase error for the SlotPhase measurement.

Returns:

x0 (float):

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

dx (float):

This parameter returns the delta parameter.

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. The chip phase error is the phase error between the received waveform and the reference waveform.

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.

• chip_phase_error (numpy.float32) – This parameter returns the array of chip phase error for the SlotPhase measurement.

Returns:

x0 (float):

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

dx (float):

This parameter returns the delta parameter.

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_maximum_phase_discontinuity(selector_string, timeout)

Fetches the maximum phase discontinuity value observed in the measurement interval.

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:

maximum_phase_discontinuity (float):

This parameter returns the maximum slot phase discontinuity value observed in the measurement interval. 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 (maximum_phase_discontinuity, error_code)

fetch_phase_discontinuities(selector_string, timeout)

Fetches the phase discontinuity values for the slot boundaries in the measurement interval.

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:

slot_phase_discontinuity (float):

This parameter returns the array of phase discontinuity values for the slot boundaries in the measurement interval. 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_maximum_phase_discontinuity(selector_string)

Gets the maximum slot phase discontinuity value observed in the measurement interval. This value is expressed in degrees.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum slot phase discontinuity value observed in the measurement interval. 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 (attr_val, error_code)