SIDX 7
SIDXAcquire.h
Go to the documentation of this file.
1 
6 #include "SIDXConstants.h"
7 
8 #ifndef SIDXXOPAcquire_H
9 #define SIDXXOPAcquire_H
10 
11 
19 SIDXAcquireAbort(integer SIDXacquire, integer status);
20 
29 SIDXAcquireArchiveIsWriting(integer SIDXacquire, integer writing, integer status);
30 
31 
47  integer SIDXacquire,
48  string path,
49  string data_type,
50  integer overwrite,
51  integer SIDXarchive,
52  integer status);
64  (integer SIDXacquire, integer image_index, integer image_count, integer status);
74 SIDXAcquireClose(integer SIDXacquire, integer status);
75 
85 SIDXAcquireGetBufferCount(integer SIDXacquire, integer count, integer status);
86 
95 SIDXAcquireGetGapInterval(integer SIDXacquire, double interval, integer status);
110 SIDXAcquireGetImageInterval(integer SIDXacquire, double interval, integer status);
111 
122 SIDXAcquireGetPollingInterval(integer SIDXacquire, double interval, integer status);
131 SIDXAcquireGetReadoutInterval(integer SIDXacquire, double interval, integer status);
132 
143 SIDXAcquireGetStatus(integer SIDXacquire, integer acquiring, integer status);
144 
153 SIDXAcquireImageGetCount(integer SIDXacquire, integer count, integer status);
171  (integer SIDXacquire, integer image_index, double start_time, double exposure_duration, integer status);
172 
183  integer SIDXacquire,
184  integer image_count,
185  string image_data,
186  integer status);
187 
196 SIDXAcquireReadGetPosition(integer SIDXacquire, integer position, integer status);
197 
206 SIDXAcquireReadoutExists(integer SIDXacquire, integer available, integer status);
207 
226  integer SIDXacquire,
227  integer image_count,
228  wave image_wave,
229  integer start_layer,
230  integer status);
231 
240 SIDXAcquireReadSetPosition(integer SIDXacquire, integer image_index, integer status);
241 
251 SIDXAcquireSpacingGetSize(integer SIDXacquire, integer size, integer status);
252 
260 SIDXAcquireStart(integer SIDXacquire, integer status);
269 SIDXAcquireStop(integer SIDXacquire, integer status);
270 
276 SIDXAcquireGetLastError(integer SIDXacquire, string message);
277 
278 
287 SIDXGeometryChannelGetDepth(integer SIDXacquire, integer depth, integer status);
297 SIDXGeometryImageGetSize(integer SIDXacquire, integer size, integer status);
305 SIDXGeometryImageGetType(integer SIDXacquire, integer type, integer status);
314 SIDXGeometryPixelGetCount(integer SIDXacquire, integer x, integer y, integer status);
325 SIDXGeometryPixelSpacingGet(integer SIDXacquire, double x, double y, integer status);
326 
327 
328 #endif
SIDXAcquireAbort(integer SIDXacquire, integer status)
Interrupt and terminate image Acquire.
SIDXAcquireGetImageInterval(integer SIDXacquire, double interval, integer status)
Obtain the time interval between successive images.
SIDXAcquireArchiveOpenNew(integer SIDXacquire, string path, string data_type, integer overwrite, integer SIDXarchive, integer status)
Create an file as an image archive.
SIDXAcquireReadoutExists(integer SIDXacquire, integer available, integer status)
Determine whether readout interval information is available.
SIDXGeometryImageGetType(integer SIDXacquire, integer type, integer status)
Obtain the image type of the source image.
SIDXAcquireReadReplace(integer SIDXacquire, integer image_count, wave image_wave, integer start_layer, integer status)
This function reads 'image_count' images acquired images, starting from the current read position...
File containing SIDX constants for reference.
SIDXAcquireStop(integer SIDXacquire, integer status)
Stop Acquire.
SIDXAcquireGetGapInterval(integer SIDXacquire, double interval, integer status)
Obtain the minimum time interval from the end of an exposure to the start of the next exposure...
SIDXAcquireGetBufferCount(integer SIDXacquire, integer count, integer status)
Obtain the image buffer count used, that is, the number of images that can be stored in the image buf...
SIDXGeometryPixelGetCount(integer SIDXacquire, integer x, integer y, integer status)
Obtain the x and y pixel count for images.
SIDXAcquireGetPollingInterval(integer SIDXacquire, double interval, integer status)
Obtain the maximum interval between successive calls to the Acquire 'GetStatus' call during image Acq...
SIDXAcquireReadGetPosition(integer SIDXacquire, integer position, integer status)
Obtain the current read position.
SIDXGeometryImageGetSize(integer SIDXacquire, integer size, integer status)
Obtain the data size of an image.
SIDXAcquireGetStatus(integer SIDXacquire, integer acquiring, integer status)
Update the Acquire status.
SIDXGeometryChannelGetDepth(integer SIDXacquire, integer depth, integer status)
Obtain the pixel depth of one channel from the image data.
SIDXAcquireGetReadoutInterval(integer SIDXacquire, double interval, integer status)
Obtain the readout interval of an exposed image in seconds.
SIDXAcquireRead(integer SIDXacquire, integer image_count, string image_data, integer status)
Read images starting from the current read position.
SIDXGeometryPixelSpacingGet(integer SIDXacquire, double x, double y, integer status)
Obtain the pixel size in x and y.
SIDXAcquireReadSetPosition(integer SIDXacquire, integer image_index, integer status)
Set the read position to the specific image.
SIDXAcquireArchiveWrite(integer SIDXacquire, integer image_index, integer image_count, integer status)
Archive the specified images.
SIDXAcquireGetLastError(integer SIDXacquire, string message)
The function translates the error code into a text string.
SIDXAcquireImageGetDescription(integer SIDXacquire, integer image_index, double start_time, double exposure_duration, integer status)
Obtains the exposure duration and start time for a specified image.
SIDXAcquireStart(integer SIDXacquire, integer status)
Start Acquire.
SIDXAcquireSpacingGetSize(integer SIDXacquire, integer size, integer status)
Obtain the size of an image.
SIDXAcquireArchiveIsWriting(integer SIDXacquire, integer writing, integer status)
Determine if issued writing to file operations are being completed.
SIDXAcquireImageGetCount(integer SIDXacquire, integer count, integer status)
Obtain the total number of acquired images since last call to Acquire Start.
SIDXAcquireClose(integer SIDXacquire, integer status)
Close the Acquire.