IviSpecAn_ConfigureAcquisition
IviSpecAnBase Capability Group
C Function Prototype
ViStatus IviSpecAn_ConfigureAcquisition (ViSession vi, ViBoolean sweepModeContinuous, ViInt32 numberOfSweeps, ViBoolean detectorTypeAuto, ViInt32 detectorType, ViInt32 verticalScale);
Purpose
This function configures the acquisition 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 |
sweepModeContinuous | ViBoolean | Turns on/off continuous sweeping. The driver uses this value to set the IVISPECAN_ATTR_SWEEP_MODE_CONTINUOUS attribute. Valid Values: VI_TRUE - Sweep mode is continuous. VI_FALSE - Sweep mode is not continuous. Default Value: VI_FALSE |
numberOfSweeps | ViInt32 | The number of sweeps to take. The driver sets the IVISPECAN_ATTR_NUMBER_OF_SWEEPS attribute to this value. Default Value: 1 |
detectorTypeAuto | ViBoolean | Enables the auto detector. The driver uses this value to set the IVISPECAN_ATTR_DETECTOR_TYPE_AUTO attribute. Note: When the IVISPECAN_ATTR_DETECTOR_TYPE_AUTO attribute is set to True,the relationship between the IVISPECAN_ATTR_TRACE_TYPE attribute and the IVISPECAN_ATTR_DETECTOR_TYPE attributeis is not defined. Valid Values: VI_TRUE - Detector type is automatically selected. VI_FALSE - Detector type is manually selected. Default Value: VI_FALSE |
detectorType | ViInt32 | Specifies the method of capturing and processing signal data. The driver uses this value to set the IVISPECAN_ATTR_DETECTOR_TYPE attribute. Valid Values: - IVISPECAN_VAL_DETECTOR_TYPE_AUTO_PEAK - Allows the detector to capture better readings by using both positive and negative peak values when noise is present. - IVISPECAN_VAL_DETECTOR_TYPE_AVERAGE - Average value of samples taken within the bin for a dedicated point on the display. - IVISPECAN_VAL_DETECTOR_TYPE_MAX_PEAK - Obtains the maximum video signal between the last display point and the present display point. - IVISPECAN_VAL_DETECTOR_TYPE_MIN_PEAK - Obtains the minimum video signal between the last display point and the present display point. - IVISPECAN_VAL_DETECTOR_TYPE_SAMPLE - Pick one point within a bin. - IVISPECAN_VAL_DETECTOR_TYPE_RMS - RMS value of samples taken within the bin for a dedicated point on the display. Default Values: IVISPECAN_VAL_DETECTOR_TYPE_AVERAGE |
verticalScale | ViInt32 | Pass the vertical scale of the measurement hardware that you want the spectrum analyzer to use (use of log amplifiers or linear amplifiers). The driver sets the IVISPECAN_ATTR_VERTICAL_SCALE attribute to this value. Defined Values: IVISPECAN_VAL_VERTICAL_SCALE_LINEAR - Linear IVISPECAN_VAL_VERTICAL_SCALE_LOGARITHMIC - Logarithmic Default Value: IVISPECAN_VAL_VERTICAL_SCALE_LOGARITHMIC |