IviSpecAn_ConfigureSweepCoupling

CVI/LabWindows IVI Class Driver

IviSpecAn_ConfigureSweepCoupling

IviSpecAnBase Capability Group

C Function Prototype

ViStatus IviSpecAn_ConfigureSweepCoupling (ViSession vi, ViBoolean resolutionBandwidthAuto, ViReal64 resolutionBandwidth, ViBoolean videoBandwidthAuto, ViReal64 videoBandwidth, ViBoolean sweepTimeAuto, ViReal64 sweepTime);

Purpose

This function configures the coupling and sweeping attributes of the spectrum analyzer.

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

resolutionBandwidthAuto ViBoolean Enables resolution bandwidth auto coupling. The driver uses this value to set the IVISPECAN_ATTR_RESOLUTION_BANDWIDTH_AUTO attribute.

Valid Values:

VI_TRUE - Resolution bandwidth is automatically selected.
VI_FALSE - Resolution bandwidth is manually selected.

Default Value: VI_FALSE

resolutionBandwidth ViReal64 Specifies the measurement resolution bandwidth. The driver uses this value to set the IVISPECAN_ATTR_RESOLUTION_BANDWIDTH attribute.

Units: Hertz

Default Value: 1.0 MHz

Note:

This value is ignored when the Resolution Bandwidth Auto parameter or the IVISPECAN_ATTR_RESOLUTION_BANDWIDTH_AUTO is set to VI_TRUE

videoBandwidthAuto ViBoolean Enables video bandwidth auto coupling. The driver uses this value to set the IVISPECAN_ATTR_VIDEO_BANDWIDTH_AUTO attribute.

Valid Values:

VI_TRUE - Video bandwidth is automatically selected
VI_FALSE - Video bandwidth is manually selected

Default Value: VI_FALSE

videoBandwidth ViReal64 Specifies the video bandwidth of the post-detection filter. The driver uses this value to set the IVISPECAN_ATTR_VIDEO_BANDWIDTH attribute.

Units: Hertz

Default Value: 1.0 MHz

Note:

This value is ignored when the Video Bandwidth Auto parameter or the IVISPECAN_ATTR_VIDEO_BANDWIDTH_AUTO is set to VI_TRUE.

sweepTimeAuto ViBoolean Enables sweep time auto. The driver uses this value to set the IVISPECAN_ATTR_SWEEP_TIME_AUTO attribute.

Valid Values:
VI_TRUE - Sweep time is automatically selected
VI_FALSE - Sweep time is manually selected

Default Value: VI_FALSE

sweepTime ViReal64 The length of time to complete one sweep. The driver uses this value to set the IVISPECAN_ATTR_SWEEP_TIME attribute.

Units: seconds

Default Value: 1.0

Note:

This value is ignored when the Sweep Time Auto parameter or the IVISPECAN_ATTR_SWEEP_TIME_AUTO is set to VI_TRUE.

Return Values