PavtResults

Provides methods to fetch and read the Pavt measurement results.

class nirfmxspecan.pavt_results.PavtResults(signal_obj)

Bases: object

Provides methods to fetch and read the Pavt measurement results.

fetch_amplitude_trace(selector_string, timeout, trace_index, amplitude)

Fetches the amplitude trace for the 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 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.

• trace_index (int) – Specifies the index of the trace to fetch. The traceIndex can range from 0 to (Number of carriers + 2*Number of offsets).

• amplitude (numpy.float32) – This parameter returns the amplitude values of the complex baseband samples, in dBm.

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

Fetches the mean values of phase and amplitude of the segment.

Use “segment<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 segment number.

  Example:

  ”segment0”

  ”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:

mean_relative_phase (float):

This parameter returns the mean phase of the segment, relative to the phase of the reference segment. This value is expressed in degrees.

mean_relative_amplitude (float):

This parameter returns the mean amplitude of the segment, relative to the amplitude of the reference segment. This value is expressed in dB.

mean_absolute_phase (float):

This parameter returns the mean absolute phase of the segment. This value is expressed in degrees.

mean_absolute_amplitude (float):

This parameter returns the mean absolute amplitude of the 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 (mean_relative_phase, mean_relative_amplitude, mean_absolute_phase, mean_absolute_amplitude, error_code)

fetch_phase_and_amplitude_array(selector_string, timeout)

Fetches an array of mean values of phase and amplitude of the segments.

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

This parameter returns an array of the mean phase of the segment relative to the first segment of the measurement. This value is expressed in degrees.

mean_relative_amplitude (float):

This parameter returns an array of the mean amplitude of the segment relative to the first segment of the measurement. This value is expressed in dB.

mean_absolute_phase (float):

This parameter returns an array of the mean absolute phase of the segment. This value is expressed in degrees.

mean_absolute_amplitude (float):

This parameter returns an array of the mean absolute amplitude of the 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 (mean_relative_phase, mean_relative_amplitude, mean_absolute_phase, mean_absolute_amplitude, error_code)

fetch_phase_trace(selector_string, timeout, trace_index, phase)

Fetches the phase trace for the 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 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.

• trace_index (int) – Specifies the index of the trace to fetch. The traceIndex can range from 0 to (Number of carriers + 2*Number of offsets).

• phase (numpy.float32) – This parameter returns the phase values of the complex baseband samples, in degrees.

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)

get_frequency_error_mean(selector_string)

Gets the mean frequency error of the segment. This value is expressed in Hz

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 frequency error of the segment. This value is expressed in Hz

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

Gets the mean absolute amplitude of the 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 mean absolute amplitude of the 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_mean_absolute_phase(selector_string)

Gets the mean absolute phase of the segment. This value is expressed in degrees.

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 absolute phase of the segment. 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)

get_mean_relative_amplitude(selector_string)

Gets the mean amplitude of the segment, relative to the amplitude of the reference segment. This value is expressed in dB.

Mean Relative Amplitude = a_i- a_r

a_iis the absolute amplitude of the segment i, expressed in dBm

a_ris the absolute amplitude of the reference segment r, expressed in dBm

where, r = 1, if Segment0 is configured as Frequency Error Measurement segment r = 0, otherwise

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 amplitude of the segment, relative to the amplitude of the reference 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_mean_relative_phase(selector_string)

Gets the mean phase of the segment, relative to the phase of the reference segment. This value is expressed in degrees.

Mean Relative Phase = Q_i- Q_r

Q_iis the absolute phase of the segment i, expressed in degrees

Q_ris the absolute phase of the reference segment r, expressed in degrees

where, r = 1, if Segment0 is configured as Frequency Error Measurement segment r = 0, otherwise

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 phase of the segment, relative to the phase of the reference segment. 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)