© 2016 Thorlabs Scientific Imaging282
DCx Camera Functional Description and SDK Manual
4.3.63 is_InitImageQueue
Syntax
INT is_InitImageQueue (HIDS hCam, INT nMode)
Description
is_InitImageQueue() enables the queue mode for existing image memory sequences. New
images will be added to the end of the queue on arrival (FIFO principle). The image memory
sequence has to be created with is_AddToSequence() prior to calling is_InitImageQueue(). With
is_WaitForNextImage() you can query the pointer and sequence ID of the first (i.e. oldest) image
in the sequence.
Note
Image memory sequences can also be used without queue mode. In this case the current image
memory has to be queried with is_GetActSeqBuf() on every frame event. Disadvantage of this
proceeding is that at very high frame rates it may happen that additional images arrive between the
frame event and accessing/locking the memory. The images arriving in this period will be skipped
when you query the current image.
When the queue mode is used (is_InitImageQueue()), however, you can be sure to always
receive the oldest image which has not yet been queried. In addition, image memories are
automatically locked immediately after receiving the image. This prevents images from being
overwritten when very high frame rates and few image memories are used.
Input parameters
Queue mode. Currently only nMode = 0 is
supported.
Return values
One of the submitted parameters is outside the
valid range or is not supported for this sensor or
is not available in this mode.
Function executed successfully
Related functions
is_ExitImageQueue()
is_WaitForNextImage()
is_AddToSequence()
Example
// A previously initialized camera continuously captures images
// until a timeout or transfer error occurs.
// Note: image memories have to be allocated before this