MarkerConfiguration

Provides methods to configure the Marker measurement.

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

Bases: object

Provides methods to configure the Marker measurement.

configure_band_span(selector_string, span)[source]

Configures the band span of the selected marker. Use “marker<n>” as the selector string to configure this method.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of marker number.

    Example:

    ”marker0”

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

  • span (float) – This parameter specifies the width of the span for the selected marker. This attribute selects the trace data within the specified span to perform specified marker function.

Returns:

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

Return type:

int

configure_function_type(selector_string, function_type)[source]

Configures the marker function type.

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

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of marker number.

    Example:

    ”marker0”

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

  • function_type (enums.MarkerFunctionType, int) –

    This parameter specifies the function type for the selected marker. The default value is Off.

    Name (Value)

    Description

    Off (0)

    The marker function is disabled.

    Band Power (1)

    Band Power is computed within the specified span.

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. The default value is 12.

Returns:

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

Return type:

int

configure_peak_excursion(selector_string, peak_excursion_enabled, peak_excursion)[source]

Configures the peak excursion.

Parameters:

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

  • peak_excursion_enabled (enums.MarkerPeakExcursionEnabled, int) –

    This parameter specifies whether to enable the peak excursion check for the trace while finding the peaks. The default value is False.

    Name (Value)

    Description

    False (0)

    Disables the peak excursion check for the trace while finding the peaks.

    True (1)

    Enables the peak excursion check for the trace while finding the peaks.

  • peak_excursion (float) – This parameter specifies the peak excursion value for finding the peaks on trace when you set the Peak Excursion Enabled parameter to True. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered as a peak. The default value is 6.

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 the reference marker to a delta marker.

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

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of marker number.

    Example:

    ”marker0”

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

  • reference_marker (int) – This parameter specifies the marker to be used as reference marker when you set the Marker Type attribute to Delta. This parameter is not used when you set the Marker Type attribute to Normal or Fixed.

Returns:

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

Return type:

int

configure_threshold(selector_string, threshold_enabled, threshold)[source]

Configures the threshold to use for peak search.

Parameters:

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

  • threshold_enabled (enums.MarkerThresholdEnabled, int) –

    This parameter specifies whether to enable the threshold for the trace while finding the peaks. The default value is False.

    Name (Value)

    Description

    False (0)

    Disables the threshold for the trace while finding the peaks

    True (1)

    Enables the threshold for the trace while finding the peaks

  • threshold (float) – This parameter specifies the threshold for finding the peaks on the trace. The default value is -90.

Returns:

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

Return type:

int

configure_trace(selector_string, trace)[source]

Configures the measurement trace to be used by the marker. Use “marker<n>” as the selector string to configure this method.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of marker number.

    Example:

    ”marker0”

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

  • trace (enums.MarkerTrace, int) –

    This parameter specifies the trace. The default value is Spectrum.

    Name (Value)

    Description

    ACP Spectrum (0)

    The marker uses the ACP spectrum trace.

    CCDF Gaussian Probabilities Trace (1)

    The marker uses the CCDF Gaussian probabilities trace.

    CCDF Probabilities Trace (2)

    The marker uses the CCDF probabilities trace.

    CHP Spectrum (3)

    The marker uses the CHP spectrum trace.

    FCnt Power Trace (4)

    The marker uses the FCnt power trace.

    OBW Spectrum (5)

    The marker uses the OBW spectrum trace.

    SEM Spectrum (6)

    The marker uses the SEM spectrum trace.

    Spectrum (7)

    The marker uses the Spectrum trace.

    TXP Power Trace (8)

    The marker uses the TXP power trace.

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) –

    This parameter specifies a Selector String comprising of marker number.

    Example:

    ”marker0”

    You can use the build_marker_string() method to build the selector 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_location(selector_string, marker_x_location)[source]

Configures the X location of the marker. You must configure the reference marker X location or perform peak search on the reference marker before configuring the X location for the Delta marker. Use “marker<n>” as the selector string to configure this method.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of marker number.

    Example:

    ”marker0”

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

  • marker_x_location (float) – This parameter specifies the X location of the marker on the trace when you set the Marker Type parameter to Normal or Fixed. The X location is relative to the value of the reference marker when you set the Marker Type parameter 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_location(selector_string, marker_y_location)[source]

Configures the Y location of the marker. You must configure the reference marker Y location or perform peak search on the reference marker before configuring the X location for the Delta marker.

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

Note

You can configure the Y location of the marker only if you set the Marker Type parameter to Fixed.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of marker number.

    Example:

    ”marker0”

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

  • marker_y_location (float) – This parameter specifies the Y location of the marker when you set the Marker Type parameter to Fixed.

Returns:

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

Return type:

int