MarkerResults

Provides methods to fetch and read the Marker measurement results.

class nirfmxspecan.marker_results.MarkerResults(signal_obj)

Bases: object

Provides methods to fetch and read the Marker measurement results.

fetch_function_value(selector_string)

Returns the function value of the selected marker function type.

Parameters:

selector_string (string) –

This parameter specifies a Selector String comprising of result name, and marker number.

Example:

”marker0”

”result::r1/marker0”

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

Returns:

function_value (float):

This parameter returns the value of the selected marker function.

error_code (int):

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

Return type:

Tuple (function_value, error_code)

fetch_xy(selector_string)

Returns the X and Y locations of the marker.

Parameters:

selector_string (string) –

This parameter specifies a Selector String comprising of result name, and marker number.

Example:

”marker0”

”result::r1/marker0”

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

Returns:

marker_x_location (float):

This parameter returns the marker X location.

marker_y_location (float):

This parameter returns the marker Y location.

error_code (int):

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

Return type:

Tuple (marker_x_location, marker_y_location, error_code)

next_peak(selector_string, next_peak)

Moves the marker to the next highest or next left or next right peak above the threshold on the configured trace. Use “marker<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 marker number.

  Example:

  ”marker0”

  ”result::r1/marker0”

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

• next_peak (enums.MarkerNextPeak, int) –

  This parameter specifies the next peak on the trace. The default value is Next Highest.

  Name (Value)	Description
  Next Highest (0)	Moves the marker to the next highest peak above the threshold on the configured trace.
  Next Left (1)	Moves the marker to the next peak to the left of the configured trace.
  Next Right (2)	Moves the marker to the next peak to the right of the configured trace.

Returns:

next_peak_found (bool):

This parameter indicates whether the method has found the next peak on the trace.

error_code (int):

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

Return type:

Tuple (next_peak_found, error_code)

peak_search(selector_string)

Moves the marker to the highest peak that satisfies peak threshold and peak excursion criteria. Use “marker<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 marker number.

Example:

”marker0”

”result::r1/marker0”

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

Returns:

number_of_peaks (int):

This parameter returns the total number of peaks above the threshold, when you set the enable the marker threshold.

error_code (int):

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

Return type:

Tuple (number_of_peaks, error_code)