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.

Syntax

Namespace: NationalInstruments.RFmx.VnaMX

public int ConfigurePeakSearchExcursion(string selectorString, RFmxVnaMXMarkerPeakSearchExcursionEnabled peakExcursionEnabled, double peakExcursion)

Parameters

NameTypeDescription
selectorStringstring

Specifies a selector string comprising of marker number.
Example:
"marker0"
You can use the BuildMarkerString(string, int) method to build the selector string.

peakExcursionEnabledRFmxVnaMXMarkerPeakSearchExcursionEnabled

Specifies whether Marker Search method 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.

peakExcursiondouble

Specifies the peak excursion value that Marker Search method 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.