IviSpecAn_MakeMarkerDelta

CVI/LabWindows IVI Class Driver

IviSpecAn_MakeMarkerDelta

IviSpecAnDeltaMarker Capability Group

C Function Prototype

ViStatus IviSpecAn_MakeMarkerDelta (ViSession vi, ViBoolean deltaMarker);

Purpose

This function specifies whether the active marker is a delta marker.

When this function is called with DeltaMarker true, the current active marker is changed to a delta marker and the associated reference marker is moved to the current position of the active marker. The current position becomes the reference point for marker values. The marker readout indicates the relative frequency (or time) separation and amplitude difference between the reference and active marker.

When this Delta Marker is set to false, the current marker is changed to a normal marker. The reference marker is determined by calling the IviSpecAn_QueryReferenceMarker function.

Notes:

(1) If the current active marker is not enabled then this function enables 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

deltaMarker ViBoolean Specifies whether marker Delta is True or False. Depending on this value, the driver will set the marker to IVISPECAN_VAL_MARKER_TYPE_NORMAL or IVISPECAN_VAL_MARKER_TYPE_DELTA (see the function help for more details).

Valid Values: VI_TRUE; VI_FALSE

Default Value: VI_FALSE

Return Values