Go to the documentation of this file.
6 #include "SIDXCConstants.h"
8 #ifndef SIDXCAcquire_H
9 #define SIDXCAcquire_H
19 __declspec(dllexport) int SIDXAcquireAbort(void* SIDXacquire);
29 int SIDXAcquireArchiveIsWriting(void* SIDXacquire, bool& writing);
46 __declspec(dllexport) int SIDXAcquireArchiveOpenNew(
47  void* SIDXacquire,
48  const wchar_t* path,
49  const wchar_t* data_type,
50  bool overwrite,
51  void*& SIDXarchive
52 );
63 __declspec(dllexport) int SIDXAcquireArchiveWrite
64  (void* SIDXacquire, int64_t image_index, int64_t image_count);
74 __declspec(dllexport) int SIDXAcquireClose(void* SIDXacquire);
85 __declspec(dllexport) int SIDXAcquireGetBufferCount(void* SIDXacquire, int& count);
95 __declspec(dllexport) int SIDXAcquireGetGapInterval(void* SIDXacquire, double& interval);
110 __declspec(dllexport) int SIDXAcquireGetImageInterval(void* SIDXacquire, double& interval);
122 __declspec(dllexport) int SIDXAcquireGetPollingInterval(void* SIDXacquire, double& interval);
131 __declspec(dllexport) int SIDXAcquireGetReadoutInterval(void* SIDXacquire, double& interval);
143 __declspec(dllexport) int SIDXAcquireGetStatus(void* SIDXacquire, bool& acquiring);
153 __declspec(dllexport) int SIDXAcquireImageGetCount(void* SIDXacquire, int64_t& count);
170 __declspec(dllexport) int SIDXAcquireImageGetDescription
171  (void* SIDXacquire, int64_t image_index, double& start_time, double& exposure_duration);
183 __declspec(dllexport) int SIDXAcquireRead(
184  void* SIDXacquire,
185  int64_t image_count,
186  short* image_data,
187  size_t length
188 );
197 __declspec(dllexport) int SIDXAcquireReadGetPosition(void* SIDXacquire, int64_t& position);
207 __declspec(dllexport) int SIDXAcquireReadoutExists(void* SIDXacquire, bool& available);
217 __declspec(dllexport) int SIDXAcquireReadSetPosition(void* SIDXacquire, int64_t image_index);
228 __declspec(dllexport) int SIDXAcquireSpacingGetSize(void* SIDXacquire, size_t& size);
237 __declspec(dllexport) int SIDXAcquireStart(void* SIDXacquire);
246 __declspec(dllexport) int SIDXAcquireStop(void* SIDXacquire);
255 __declspec(dllexport) void SIDXAcquireGetLastError
256  (void* SIDXacquire, wchar_t* message, size_t length);
267 __declspec(dllexport) int SIDXGeometryChannelGetDepth(void* SIDXacquire, int& depth);
277 __declspec(dllexport) int SIDXGeometryImageGetSize(void* SIDXacquire, size_t& size);
285 __declspec(dllexport) int SIDXGeometryImageGetType(void* SIDXacquire, SIDXImageType& type);
294 __declspec(dllexport) int SIDXGeometryPixelGetCount(void* SIDXacquire, int& x, int& y);
305 __declspec(dllexport) int SIDXGeometryPixelSpacingGet(void* SIDXacquire, double& x, double& y);
308 #endif
int SIDXGeometryChannelGetDepth(void *SIDXacquire, int &depth)
Obtain the pixel depth of one channel from the image data.
int SIDXAcquireImageGetCount(void *SIDXacquire, int64_t &count)
Obtain the total number of acquired images since last call to Acquire Start.
int SIDXAcquireSpacingGetSize(void *SIDXacquire, size_t &size)
Obtain the size of an image.
File containing SIDX constants for reference.
int SIDXAcquireStop(void *SIDXacquire)
Stop Acquire.
int SIDXAcquireImageGetDescription(void *SIDXacquire, int64_t image_index, double &start_time, double &exposure_duration)
Obtains the exposure duration and start time for a specified image.
int SIDXAcquireGetReadoutInterval(void *SIDXacquire, double &interval)
Obtain the readout interval of an exposed image in seconds.
int SIDXGeometryPixelSpacingGet(void *SIDXacquire, double &x, double &y)
Obtain the pixel size in x and y.
int SIDXAcquireStart(void *SIDXacquire)
Start Acquire.
int SIDXAcquireClose(void *SIDXacquire)
Close the Acquire.
int SIDXGeometryImageGetType(void *SIDXacquire, SIDXImageType &type)
Obtain the image type of the source image.
int SIDXAcquireGetImageInterval(void *SIDXacquire, double &interval)
Obtain the time interval between successive images.
int SIDXAcquireArchiveWrite(void *SIDXacquire, int64_t image_index, int64_t image_count)
Archive the specified images.
int SIDXAcquireGetPollingInterval(void *SIDXacquire, double &interval)
Obtain the maximum interval between successive calls to the Acquire 'GetStatus' call during image Acq...
void SIDXAcquireGetLastError(void *SIDXacquire, wchar_t *message, size_t length)
The function translates the error code into a text string.
int SIDXAcquireReadGetPosition(void *SIDXacquire, int64_t &position)
Obtain the current read position.
int SIDXAcquireRead(void *SIDXacquire, int64_t image_count, short *image_data, size_t length)
Read images starting from the current read position.
int SIDXAcquireGetStatus(void *SIDXacquire, bool &acquiring)
Update the Acquire status.
int SIDXAcquireGetBufferCount(void *SIDXacquire, int &count)
Obtain the image buffer count used, that is, the number of images that can be stored in the image buf...
int SIDXGeometryImageGetSize(void *SIDXacquire, size_t &size)
Obtain the data size of an image.
int SIDXGeometryPixelGetCount(void *SIDXacquire, int &x, int &y)
Obtain the x and y pixel count for images.
int SIDXAcquireAbort(void *SIDXacquire)
Interrupt and terminate image Acquire.
int SIDXAcquireArchiveIsWriting(void *SIDXacquire, bool &writing)
Determine if issued writing to file operations are being completed.
int SIDXAcquireReadSetPosition(void *SIDXacquire, int64_t image_index)
Set the read position to the specific image.
int SIDXAcquireReadoutExists(void *SIDXacquire, bool &available)
Determine whether readout interval information is available.
int SIDXAcquireArchiveOpenNew(void *SIDXacquire, const wchar_t *path, const wchar_t *data_type, bool overwrite, void *&SIDXarchive)
Create an file as an image archive.
A value of this type represents either a source image type or a target image type.
Definition: SIDXCConstants.h:142
int SIDXAcquireGetGapInterval(void *SIDXacquire, double &interval)
Obtain the minimum time interval from the end of an exposure to the start of the next exposure...