SlotPhaseResults

Provides methods to fetch and read the SlotPhase measurement results.

class nirfmxlte.slotphase_results.SlotPhaseResults(signal_obj)

Bases: object

Provides methods to fetch and read the SlotPhase measurement results.

fetch_maximum_phase_discontinuity(selector_string, timeout)

Fetches the maximum value of phase differences at slot boundaries within the measurement interval.

Use “carrier<k>” or “subblock<n>/carrier<k>” as the selector string to read results 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 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 value of phase difference at the slot boundaries within the SLOTPHASE_MEASUREMENT_LENGTH.

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

Fetches the array of maximum values of phase differences at slot boundaries within the measurement interval.

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:

maximum_phase_discontinuity (float):

This parameter returns the array of maximum values of phase difference at the slot boundaries within the SLOTPHASE_MEASUREMENT_LENGTH.

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 array of phase differences at slot boundaries within measurement interval.

Parameters:

• selector_string (string) –

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

  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_phase_discontinuity (float):

This parameter returns the array of phase differences at the slot boundaries within the SLOTPHASE_MEASUREMENT_LENGTH. 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)

fetch_sample_phase_error(selector_string, timeout, sample_phase_error)

Fetches the sample phase error trace for the SlotPhase measurement. At each sample, this is the phase difference between received signal and locally generated reference signal.

Parameters:

• selector_string (string) –

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

  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.

• sample_phase_error (numpy.float32) – This parameter returns the array of sample phase error traces.

Returns:

x0 (float):

This parameter returns the start sample phase error linear fit trace value.

dx (float):

This parameter returns the spacing between the sample phase error linear fit trace values.

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

Fetches the sample phase error linear fit trace for the SlotPhase measurement. The linear fit is over the array of phase differences at each sample between the received signal and the locally generated reference signal.

Parameters:

• selector_string (string) –

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

  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.

• sample_phase_error_linear_fit (numpy.float32) – This parameter returns the array of sample phase error linear fit traces.

Returns:

x0 (float):

This parameter returns the start sample phase error linear fit trace value. This value is expressed in degrees.

dx (float):

This parameter returns the spacing between the sample phase error linear fit trace values.

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

Gets the maximum value of phase difference at the slot boundaries within the SLOTPHASE_MEASUREMENT_LENGTH. This values is expressed in degrees.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum value of phase difference at the slot boundaries within the SLOTPHASE_MEASUREMENT_LENGTH. This values 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)