MarkerConfiguration

Provides methods to configure the Marker measurement.

class nirfmxvna.marker_configuration.MarkerConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Marker measurement.

configure_data_source(selector_string, data_source)[source]

Configures the data source on which marker operations are performed. Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • data_source (string) – This parameter specifies the measurement or memory data on which markers are placed. If you want to place markers on SParams measurement data, then specify this parameter as “sparam<n>”. If you want to place markers on SParams measurement memory data, then specify this parameter as “sparam<n>/measmem::<measMemoryName>”. Similarly, if you want to place markers on Wave measurement data, then specify this parameter as “wave<n>”.

Returns:

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

Return type:

int

configure_mode(selector_string, marker_mode)[source]

Configures the marker mode. Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • marker_mode (enums.MarkerMode, int) –

    This parameter specifies the mode for placing the marker.

    Name (Value)

    Description

    Continuous (0)

    Marker can be placed at any point and its response value is obtained by interpolation of actual measured data points.

    Discrete (1)

    Marker can be placed only at actual measured data points.

Returns:

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

Return type:

int

configure_number_of_markers(selector_string, number_of_markers)[source]

Configures the number of markers.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • number_of_markers (int) – This parameter specifies the number of markers. If you increase number of markers from N to N+K, then existing N markers are not affected but K new markers are added. If you reduce number of markers from N to N-K, then last K markers are deleted without affecting the remaining N-K markers.

Returns:

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

Return type:

int

configure_peak_search_excursion(selector_string, peak_excursion_enabled, peak_excursion)[source]

Configures the peak-search excursion. When peak-excursion is enabled, peak search using Marker Search method finds a peak such that the data value rises and falls around the peak by at least the specified peak excursion value.

Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • peak_excursion_enabled (enums.MarkerPeakSearchExcursionEnabled, int) –

    This parameter specifies whether marker_search() finds a peak such that the data value rises and falls around the peak by atleast the specified peak excursion value or finds a peak without considering any peak excursion constraint.

    Name (Value)

    Description

    False (0)

    Disables the peak excursion.

    True (1)

    Enables the peak excursion.

  • peak_excursion (float) – This parameter specifies the peak excursion value that marker_search() uses to find a peak such that the data value rises and falls around the peak by atleast the specified peak excursion value. The threshold is expressed in the same units as the source data.

Returns:

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

Return type:

int

configure_peak_search_threshold(selector_string, threshold_enabled, threshold)[source]

Configures the peak-search threshold. When peak-thresholding is enabled, Marker Search method in peak search mode finds the peaks that exceed this value and discards all other peaks.

Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • threshold_enabled (enums.MarkerPeakSearchThresholdEnabled, int) –

    This parameter specifies whether marker_search() finds a peak above specified Threshold or finds a peak without considering any Threshold constraint.

    Name (Value)

    Description

    False (0)

    Disables peak-thresholding.

    True (1)

    Enables peak-thresholding.

  • threshold (float) – This parameter specifies the threshold value that a valid peak must exceed when you use marker_search() to find peaks. The threshold is expressed in the same units as the source data.

Returns:

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

Return type:

int

configure_reference_marker(selector_string, reference_marker)[source]

Configures an associated reference marker for a delta marker. Markers with Marker Type attribute set to Delta must be associated with a reference marker. You cannot associate a reference marker for other markers whose Marker Type is not Delta.

Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • reference_marker (int) – This parameter specifies the marker index to be used as reference for the specified delta marker. All types of markers including Normal, Delta and Fixed can be used as a reference marker.

Returns:

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

Return type:

int

configure_target_value(selector_string, target_value)[source]

Configures the target value for the specified marker when performing Target search using Marker Search method.

Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • target_value (float) – This parameter specifies the target value for target search. The target value is expressed in the same units as the source data.

Returns:

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

Return type:

int

configure_type(selector_string, marker_type)[source]

Configures the marker type. Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • marker_type (enums.MarkerType, int) –

    This parameter specifies whether the marker is disabled (Off) or is enabled (On) as a normal marker, delta marker or a fixed marker. The default value is Off.

    Name (Value)

    Description

    Off (0)

    The marker is disabled.

    Normal (1)

    The marker is enabled as a normal marker.

    Delta (3)

    The marker is enabled as a delta marker.

    Fixed (4)

    The marker is enabled as a fixed marker.

Returns:

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

Return type:

int

configure_x(selector_string, marker_x)[source]

Configures the X value of the marker. You must configure the X value of reference marker or perform any marker search operation on the reference marker before configuring the X value for the Delta marker.

Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • marker_x (float) – This parameter specifies the X value of the marker on the trace when you set the Marker Type to Normal or Fixed. The X value of the delta marker is relative to the X value of the reference marker when you set the Marker Type to Delta.

Returns:

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

Return type:

int

configure_y(selector_string, marker_y1, marker_y2)[source]

Configures the Y value of the marker. You can configure the Y location of Fixed markers only. 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, use Marker Y1 and Marker Y2 to set its real and imaginary components respectively. If Y value is a real number, use Marker Y1 to set the Y location and set Marker Y2 to 0.

When you want to use a Fixed marker as a reference marker for a Delta marker, then you must configure the Y value of the Fixed reference marker by calling this method or by performing any marker search operation on the reference marker before configuring the X value of the Delta marker.

Use “marker<n>” as the selector string to configure this method.

Parameters:

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

  • marker_y1 (float) – This parameter specifies the Y1 component of the (Fixed) marker’s Y value.

  • marker_y2 (float) – This parameter specifies the Y2 component of the (Fixed) marker’s Y value..

Returns:

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

Return type:

int