IviSpecAn_ConfigureSignalTrackEnabled
IviSpecAnMarker Capability Group
C Function Prototype
ViStatus IviSpecAn_ConfigureSignalTrackEnabled (ViSession vi, ViBoolean signalTrackEnabled);
Purpose
This function enables signal-tracking. When signal tracking is turned on, the spectrum analyzer centers the signal on which the active marker resides after each sweep. There are two prevalent methods of signal tracking in the industry.
1. A search for the largest signal on screen is made, and the spectrum analyzer center frequency is tuned to this signal.
2. The marker is placed on a signal (anywhere on screen) and when marker track is enabled, the frequency of the peak of the selected signal is used for tuning the spectrum analyzer. This does not need to be the largest signal on screen, and this method tracks the specified signal in the presence of a larger signal.
This function implements the first method of signal tracking. This INVALIDATES the IVISPECAN_ATTR_FREQUENCY_START and IVISPECAN_ATTR_FREQUENCY_STOP attribute values.
Note: Signal track can only be enabled on one marker at a time. The driver shall check all other markers to see if this function is already enabled on any marker other than the active and turn this off on the other marker before enabling this on the active marker.
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 |
signalTrackEnabled | ViBoolean | Specifies whether signal tracking is enabled. The driver uses this value to set the IVISPECAN_ATTR_SIGNAL_TRACK_ENABLED attribute. Valid Values: VI_TRUE; VI_FALSE Default Value: VI_FALSE |