Teledyne Princeton Instruments PICam 5.x, Руководство программиста

Страница: 185 / 357

Chapter 6 Data Acquisition APIs 185
6.4 Programmers’ Reference for Acquisition Control APIs
This section provides programming information for the following acquisition control
APIs:
• Picam_Acquire() ;
• Picam_StartAcquisition() ;
• Picam_StopAcquisition() ;
• Picam_IsAcquisitionRunning() ;
• Picam_WaitForAcquisitionUpdate() .
6.4.1
Picam_Acquire()
Description
Picam_Acquire()
performs a specified number of data readouts (specified by
readout_count
) and returns once the acquisition has been completed.
NOTE:
This function cannot be called when hardware is configured
for non-destructive readout. This is because the number of
readouts acquired is no longer guaranteed to be fixed. As an
example, changing the exposure time online will change the
number of non-destructive readouts and therefore the total
number of readouts acquired.
NOTE:
Parameters must be committed prior to initiating data
acquisition. Refer to
Section 5.4.6.2,
Picam_CommitParameters() , on page 179 for additional
information.
Data acquisition is successful when:
• The delay between successive readouts does not exceed readout_time_out ,
and
• No errors have occurred.
Data acquisition is immediately halted when:
• The delay between successive readouts exceeds that specified by
readout_time_out .
The error message
PicamError_TimeOutOccurred
is returned.
• Any other error conditions are detected.
Associated error messages are stored in the
errors parameter.
Syntax
The syntax for Picam_Acquire() is:
PICAM_API Picam_Acquire(
PicamHandle camera,
pi64s readout_count,
piint readout_time_out,
PicamAvailableData* available,
PicamAcquisitionErrorsMask* errors);
continued on next page