User`s guide

SPECIAL GUIDES
SDK SECTION 9
Page 69
Retrieving Image Data
Depending on the image settings there may be more than one image available after each notification. It is
important to ensure that all of the new images are retrieved if they are required. The recommended functions
for retrieving image data are as follows:
•
GetOldestImage
• GetMostRecentImage
• GetImages
• GetAcquiredData
GetOldestImage, GetMostRecentImage, and GetImages are used to retrieve data from an internal 48MB
circular buffer that is written to by all acquisition modes. They are particularly useful for retrieving data while
an acquisition is taking place especially during run till abort mode but can also be used when the acquisition
is complete. For all acquisition modes (except Run Till Abort) the GetAcquiredData function can be used to
retrieve all the acquired data once the acquisition is complete.
NOTE: All functions mentioned here refer to retrieving 32-bit data but there are also 16-bit versions of
these functions available.
GetOldestImage will retrieve the oldest available image from the circular buffer. Once the oldest image has
been retrieved it is no longer available and calling GetOldestImage again will retrieve the next image. This is
a useful function for retrieving a number of images. For example if there are 5 new images available, calling
GetOldestImage 5 times will retrieve them all. GetMostRecentImage will retrieve the most recent image from
the circular buffer. This provides a method for displaying the most recent image on screen while the
acquisition is in progress (should be used in conjunction with the GetNumberNewImages function).
The GetNumberNewImages function returns the start and end index of the images that are available in the
circular buffer. These indexes should be used along with the GetImages function to retrieve all of the
available data. This provides an effective way of retrieving a number of new images in one function call.
GetAcquiredData should be used once the acquisition is complete to retrieve all the data from the series.
This could be a single scan or an entire kinetic series.