Configures the peak excursion.

Syntax

Namespace: NationalInstruments.RFmx.SpecAnMX

public int ConfigurePeakExcursion(string selectorString, RFmxSpecAnMXMarkerPeakExcursionEnabled peakExcursionEnabled, double peakExcursion)

Remarks

This method maps to the RFmxSpecAn_MarkerCfgPeakExcursion() function in C.

Parameters

NameTypeDescription
selectorStringstring

Pass an empty string. The signal name that is passed when creating the signal configuration is used.

peakExcursionEnabledRFmxSpecAnMXMarkerPeakExcursionEnabled

Specifies whether to enable the peak excursion check for the trace while finding the peaks.

peakExcursiondouble

Specifies the peak excursion value for finding the peaks on trace when you set the peakExcursionEnabled parameter to True. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered a peak.

Returns

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