MarkerResults

Provides methods to fetch and read the Marker measurement results.

class nirfmxvna.marker_results.MarkerResults(signal_obj)[source]

Bases: object

Provides methods to fetch and read the Marker measurement results.

fetch_x(selector_string)[source]

Returns the X value of the marker. X value of the Delta marker is relative to its reference marker.

Parameters:

selector_string (string) – Specifies a selector string. Pass an empty string.

Returns:

marker_x (float):

This parameter returns the marker X value.

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

fetch_y(selector_string)[source]

Returns the Y value of the marker. Y value of a Delta marker is relative to its reference marker.

Y value can be a real or a complex number depending on format of the selected measurement for the configured data source. Y is a complex number for Complex, Smith and Polar formats. For all other formats, Y is a real number. If Y value is a complex number, Marker Y1 and Marker Y2 return its real and imaginary components respectively. If Y value is a real number, Marker Y1 returns the Y location and Marker Y2 returns 0.

Parameters:

selector_string (string) – Specifies a selector string. Pass an empty string.

Returns:

marker_y1 (float):

This parameter returns the Y1 component of marker’s Y value.

marker_y2 (float):

This parameter returns the Y2 component of marker’s Y value.

Y value is always returned as two components (Y1,Y2). The format of the Y value depends on the format of the selected measurement.

If the format is Complex, Smith or Polar (Y1,Y2) are (Real, Imaginary).

For all other formats (Y1,Y2) are (Value,0).

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_y1, marker_y2, error_code)

Performs the marker search operation that you specify using Search Mode.

Note

Marker search operation is performed on real-valued data only. No search operation is performed on complex-valued data.

Parameters:

  • selector_string (string) – Specifies a selector string. Pass an empty string.

  • search_mode (enums.MarkerSearchMode, int) –

    This parameter specifies the search-target. If search is successful, RFmx updates the marker X and Y values to the location at which search-target is found.

    Name (Value)

    Description

    None (0)

    No search operation is performed.

    Max (1)

    Moves the marker to the highest measured value on the configured data source.

    Min (2)

    Moves the marker to the lowest measured value on the configured data source.

    Peak (3)

    Moves the marker to the highest peak that satisfies peak threshold and peak excursion criteria.

    Next Peak (4)

    Moves the marker to the next peak that satisfies peak threshold and peak excursion criteria.

    Next Left Peak (5)

    Moves the marker to the next left peak that satisfies peak threshold and peak excursion criteria.

    Next Right Peak (6)

    Moves the marker to the next right peak that satisfies peak threshold and peak excursion criteria.

    Target (7)

    Moves the marker to the first right target encountered from the current marker position, wraps around if no target found. If marker mode is Discrete,marker moves to the data point closest to the first right target.

    Next Left Target (8)

    Moves the marker to the next left target encountered from the current marker position. If marker mode is Discrete,marker moves to the data point closest to the next left target.

    Next Right Target (9)

    Moves the marker to the next right target encountered from the current marker position. If marker mode is Discrete,marker moves to the data point closest to the next right target.

Returns:

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

Return type:

int