IviSpecAn_ConfigureMarkerSearch
IviSpecAnMarker Capability Group
C Function Prototype
ViStatus IviSpecAn_ConfigureMarkerSearch (ViSession vi, ViReal64 peakExcursion, ViReal64 markerThreshold);
Purpose
This function configures the marker peak excursion and marker threshold values. The marker peak excursion specifies the minimum amplitude variation that can be recognized as a peak or minimum by the marker. The marker threshold specifies a lower bound for ALL marker search functions.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviSpecAn_init or IviSpecAn_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| peakExcursion | ViReal64 | Specifies the minimum amplitude variation of the signal in dB that the IviSpecAn_MarkerSearch function identifies as a peak. The driver uses this value to set the IVISPECAN_ATTR_PEAK_EXCURSION attribute. Units: dB Default Value: 10.0 dB |
| markerThreshold | ViReal64 | Specifies the lower limit of the search domain vertical range for the IviSpecAn_MarkerSearch function. The driver uses this value to set the IVISPECAN_ATTR_MARKER_THRESHOLD attribute. Units: Amplitude Units Default Value: 0.0 |