SIDX 7
SIDXCCamera.h
Go to the documentation of this file.
1 
6 #include "SIDXCConstants.h"
7 
8 #ifndef SIDXCCamera_H
9 #define SIDXCCamera_H
10 
19 __declspec(dllexport) int SIDXCameraAcquireImageGetLimit(void* SIDXcamera, int64_t& maximum_count);
32 __declspec(dllexport) int SIDXCameraAcquireImageSetLimit(void* SIDXcamera, int64_t maximum_count);
42 __declspec(dllexport) int SIDXCameraAcquireOpen(void* SIDXcamera, void*& SIDXacquire);
43 
52 __declspec(dllexport) int SIDXCameraBinningGet(void* SIDXcamera, int& x, int& y);
64 __declspec(dllexport) int SIDXCameraBinningGetType(void* SIDXcamera, SIDXSettingType& type);
72 __declspec(dllexport) int SIDXCameraBinningItemGet(void* SIDXcamera, int& index);
85 __declspec(dllexport) int SIDXCameraBinningItemGetCount(void* SIDXcamera, int& count);
94 __declspec(dllexport) int SIDXCameraBinningItemGetEntry(void* SIDXcamera, int index, int& x, int& y);
104 __declspec(dllexport) int SIDXCameraBinningItemGetLocal
105  (void* SIDXcamera, int index, wchar_t* description, size_t length);
112 __declspec(dllexport) int SIDXCameraBinningItemSet(void* SIDXcamera, int index);
126 __declspec(dllexport) int SIDXCameraBinningSet(void* SIDXcamera, int x, int y);
127 
137 __declspec(dllexport) int SIDXCameraBinningXGetLimit(void* SIDXcamera, int& maximum);
148 __declspec(dllexport) int SIDXCameraBinningXGetType(void* SIDXcamera, SIDXSettingType& type);
158 __declspec(dllexport) int SIDXCameraBinningXItemGetCount(void* SIDXcamera, int& count);
170 __declspec(dllexport) int SIDXCameraBinningXItemGetEntry(void* SIDXcamera, int index, int& binning);
183 __declspec(dllexport) int SIDXCameraBinningXItemGetLocal
184  (void* SIDXcamera, int index, wchar_t* description, size_t length);
185 
197 __declspec(dllexport) int SIDXCameraBinningYGetLimit(void* SIDXcamera, int& maximum);
198 
207 __declspec(dllexport) int SIDXCameraBufferCountGet(void* SIDXcamera, int& count);
216 __declspec(dllexport) int SIDXCameraBufferCountSet(void* SIDXcamera, int count);
217 
224 __declspec(dllexport) int SIDXCameraClose(void* SIDXcamera);
225 
226 
235 __declspec(dllexport) int SIDXCameraCoolingGet(void* SIDXcamera, double& temperature);
243 __declspec(dllexport) int SIDXCameraCoolingGetControl(void* SIDXcamera, SIDXCoolingControl& control);
254 __declspec(dllexport) int SIDXCameraCoolingGetRange(void* SIDXcamera, double& minimum, double& maximum);
263 __declspec(dllexport) int SIDXCameraCoolingGetValue(void* SIDXcamera, double& temperature);
273 __declspec(dllexport) int SIDXCameraCoolingSet(void* SIDXcamera, double temperature);
274 
283 __declspec(dllexport) int SIDXCameraEMGainGet(void* SIDXcamera, int& gain);
293 __declspec(dllexport) int SIDXCameraEMGainGetLabel(void* SIDXcamera, wchar_t* label, size_t length);
302 __declspec(dllexport) int SIDXCameraEMGainGetRange(void* SIDXcamera, int& minimum, int& maximum);
311 __declspec(dllexport) int SIDXCameraEMGainGetType(void* SIDXcamera, SIDXSettingType& type);
321 __declspec(dllexport) int SIDXCameraEMGainGetUnit(void* SIDXcamera, wchar_t* unit, size_t length);
330 __declspec(dllexport) int SIDXCameraEMGainGetValue(void* SIDXcamera, int& gain);
338 __declspec(dllexport) int SIDXCameraEMGainItemGet(void* SIDXcamera, int& index);
347 __declspec(dllexport) int SIDXCameraEMGainItemGetCount(void* SIDXcamera, int& count);
359 __declspec(dllexport) int SIDXCameraEMGainItemGetEntry(void* SIDXcamera, int index, int& gain);
372 __declspec(dllexport) int SIDXCameraEMGainItemGetLocal
373  (void* SIDXcamera, int index, wchar_t* description, size_t length);
383 __declspec(dllexport) int SIDXCameraEMGainItemSet(void* SIDXcamera, int index);
394 __declspec(dllexport) int SIDXCameraEMGainSet(void* SIDXcamera, int gain);
395 
404 __declspec(dllexport) int SIDXCameraExposeGet(void* SIDXcamera, double& exposure);
414 __declspec(dllexport) int SIDXCameraExposeGetRange(void* SIDXcamera, double& minimum, double& maximum);
423 __declspec(dllexport) int SIDXCameraExposeGetValue(void* SIDXcamera, double& exposure);
434 __declspec(dllexport) int SIDXCameraExposeSet(void* SIDXcamera, double exposure);
435 
446 __declspec(dllexport) int SIDXCameraExternalDelayGet(void* SIDXcamera, double& interval);
455 __declspec(dllexport) int SIDXCameraExternalDelaySet(void* SIDXcamera, double interval);
456 
465 __declspec(dllexport) int SIDXCameraFanControlExists(void* SIDXcamera, bool& available);
474 __declspec(dllexport) int SIDXCameraFanControlGet(void* SIDXcamera, bool& enable);
484 __declspec(dllexport) int SIDXCameraFanControlSet(void* SIDXcamera, bool enable);
485 
495 __declspec(dllexport) int SIDXCameraGainGet(void* SIDXcamera, double& gain);
506 __declspec(dllexport) int SIDXCameraGainGetLabel(void* SIDXcamera, wchar_t* label, size_t length);
515 __declspec(dllexport) int SIDXCameraGainGetRange(void* SIDXcamera, double& minimum, double& maximum);
524 __declspec(dllexport) int SIDXCameraGainGetType(void* SIDXcamera, SIDXSettingType& type);
535 __declspec(dllexport) int SIDXCameraGainGetUnit(void* SIDXcamera, wchar_t* unit, size_t length);
545 __declspec(dllexport) int SIDXCameraGainGetValue(void* SIDXcamera, double& gain);
554 __declspec(dllexport) int SIDXCameraGainItemGet(void* SIDXcamera, int& index);
562 __declspec(dllexport) int SIDXCameraGainItemGetCount(void* SIDXcamera, int& count);
574 __declspec(dllexport) int SIDXCameraGainItemGetEntry(void* SIDXcamera, int index, double& gain);
587 __declspec(dllexport) int SIDXCameraGainItemGetLocal(void* SIDXcamera, int index, wchar_t* description, size_t length);
597 __declspec(dllexport) int SIDXCameraGainItemSet(void* SIDXcamera, int index);
606 __declspec(dllexport) int SIDXCameraGainSet(void* SIDXcamera, double gain);
607 
615 __declspec(dllexport) void SIDXCameraGetLastError
616  (void* SIDXcamera, wchar_t* message, size_t length);
617 
625 __declspec(dllexport) int SIDXCameraIntensifierGet(void* SIDXcamera, double& gain);
635 __declspec(dllexport) int SIDXCameraIntensifierGetLabel(void* SIDXcamera, wchar_t* label, size_t length);
644 __declspec(dllexport) int SIDXCameraIntensifierGetRange(void* SIDXcamera, double& minimum, double& maximum);
653 __declspec(dllexport) int SIDXCameraIntensifierGetType(void* SIDXcamera, SIDXSettingType& type);
664 __declspec(dllexport) int SIDXCameraIntensifierGetUnit(void* SIDXcamera, wchar_t* unit, size_t length);
672 __declspec(dllexport) int SIDXCameraIntensifierGetValue(void* SIDXcamera, double& gain);
681 __declspec(dllexport) int SIDXCameraIntensifierSet(void* SIDXcamera, double gain);
682 
694 __declspec(dllexport) int SIDXCameraOperateGet(void* SIDXcamera, wchar_t* value, size_t length);
702 __declspec(dllexport) int SIDXCameraOperateItemGet(void* SIDXcamera, int& index);
712 __declspec(dllexport) int SIDXCameraOperateItemGetCount(void* SIDXcamera, int& count);
724 __declspec(dllexport) int SIDXCameraOperateItemGetLocal(void* SIDXcamera, int index, wchar_t* description, size_t length);
733 __declspec(dllexport) int SIDXCameraOperateItemSet(void* SIDXcamera, int index);
745 __declspec(dllexport) int SIDXCameraOperateSet(void* SIDXcamera, const wchar_t* value);
746 
755 __declspec(dllexport) int SIDXCameraPollingGet(void* SIDXcamera, double& interval);
766 __declspec(dllexport) int SIDXCameraPollingSet(void* SIDXcamera, double interval);
767 
780 __declspec(dllexport) int SIDXCameraReadoutGet(void* SIDXcamera, wchar_t* value, size_t length);
793 __declspec(dllexport) int SIDXCameraReadoutGetValue(void* SIDXcamera, double& pixel_rate, int& pixel_depth);
801 __declspec(dllexport) int SIDXCameraReadoutItemGet(void* SIDXcamera, int& index);
812 __declspec(dllexport) int SIDXCameraReadoutItemGetCount(void* SIDXcamera, int& count);
827 __declspec(dllexport) int SIDXCameraReadoutItemGetEntry
828  (void* SIDXcamera, int index, double& pixel_rate, int& pixel_depth);
840 __declspec(dllexport) int SIDXCameraReadoutItemGetLocal
841  (void* SIDXcamera, int index, wchar_t* description, size_t length);
849 __declspec(dllexport) int SIDXCameraReadoutItemSet(void* SIDXcamera, int index);
860 __declspec(dllexport) int SIDXCameraReadoutSet(void* SIDXcamera, const wchar_t* value);
861 
868 __declspec(dllexport) int SIDXCameraROIClear(void* SIDXcamera);
883 __declspec(dllexport) int SIDXCameraROIGet(void* SIDXcamera, int& x1, int& y1, int& x2, int& y2);
900 __declspec(dllexport) int SIDXCameraROIGetValue(void* SIDXcamera, int& x1, int& y1, int& x2, int& y2);
917 __declspec(dllexport) int SIDXCameraROISet(void* SIDXcamera, int x1, int y1, int x2, int y2);
918 
926 __declspec(dllexport) int SIDXCameraRotateClear(void* SIDXcamera);
937 __declspec(dllexport) int SIDXCameraRotateMirrorX(void* SIDXcamera);
948 __declspec(dllexport) int SIDXCameraRotateMirrorY(void* SIDXcamera);
960 __declspec(dllexport) int SIDXCameraRotateSet(void* SIDXcamera, int count);
961 
971 __declspec(dllexport) int SIDXCameraShutterExists(void* SIDXcamera, SIDXShutterMode mode, bool& available);
979 __declspec(dllexport) int SIDXCameraShutterGet(void* SIDXcamera, SIDXShutterMode& mode);
987 __declspec(dllexport) int SIDXCameraShutterSet(void* SIDXcamera, SIDXShutterMode mode);
988 
997 __declspec(dllexport) int SIDXCameraTemperatureExists(void* SIDXcamera, bool& available);
1006 __declspec(dllexport) int SIDXCameraTemperatureGet(void* SIDXcamera, double& temperature);
1007 
1008 
1017 __declspec(dllexport) int SIDXCameraTransferRateGet(void* SIDXcamera, double& transfer_rate);
1027 __declspec(dllexport) int SIDXCameraTransferRateSet(void* SIDXcamera, double transfer_rate);
1028 
1038 __declspec(dllexport) int SIDXCameraTriggerModeExists(void* SIDXcamera, SIDXTriggerInMode mode, bool& available);
1046 __declspec(dllexport) int SIDXCameraTriggerModeGet(void* SIDXcamera, SIDXTriggerInMode& mode);
1054 __declspec(dllexport) int SIDXCameraTriggerModeSet(void* SIDXcamera, SIDXTriggerInMode mode);
1055 
1065 __declspec(dllexport) int SIDXCameraTriggerSignalExists(void* SIDXcamera, SIDXSignalActiveMode mode, bool& available);
1073 __declspec(dllexport) int SIDXCameraTriggerSignalGet(void* SIDXcamera, SIDXSignalActiveMode& mode);
1081 __declspec(dllexport) int SIDXCameraTriggerSignalSet(void* SIDXcamera, SIDXSignalActiveMode mode);
1082 
1083 #ifdef DOXYGEN
1084 
1092 int SIDXGeometryChannelGetDepth(void* SIDXcamera, int& depth);
1102 int SIDXGeometryImageGetSize(void* SIDXcamera, size_t& size);
1110 int SIDXGeometryImageGetType(void* SIDXcamera, SIDXImageType& type);
1119 int SIDXGeometryPixelGetCount(void* SIDXcamera, int& x, int& y);
1130 int SIDXGeometryPixelSpacingGet(void* SIDXcamera, double& x, double& y);
1131 
1132 #endif
1133 
1134 #endif
SIDXCameraBinningXGetType
int SIDXCameraBinningXGetType(void *SIDXcamera, SIDXSettingType &type)
Obtain the type of binning selection available for the x axis.
SIDXCameraTemperatureExists
int SIDXCameraTemperatureExists(void *SIDXcamera, bool &available)
Determine whether the camera sensor temperature is available.
SIDXCameraReadoutItemSet
int SIDXCameraReadoutItemSet(void *SIDXcamera, int index)
Set the Readout to the specified index.
SIDXCameraGainSet
int SIDXCameraGainSet(void *SIDXcamera, double gain)
Set the camera analog gain to the specified value.
SIDXCameraIntensifierGetType
int SIDXCameraIntensifierGetType(void *SIDXcamera, SIDXSettingType &type)
Obtain the type of intensifier setting.
SIDXCameraBinningItemGetCount
int SIDXCameraBinningItemGetCount(void *SIDXcamera, int &count)
Obtain the total number of available (x,y) binning combinations.
SIDXCameraPollingSet
int SIDXCameraPollingSet(void *SIDXcamera, double interval)
Set the service interval during Acquire.
SIDXCameraEMGainItemGetEntry
int SIDXCameraEMGainItemGetEntry(void *SIDXcamera, int index, int &gain)
Obtain the EM gain value corresponding to an index within the list.
SIDXSettingType
SIDXSettingType
A value of this type represents a setting type.
Definition: SIDXCConstants.h:48
SIDXCConstants.h
File containing SIDX constants for reference.
SIDXCameraIntensifierSet
int SIDXCameraIntensifierSet(void *SIDXcamera, double gain)
Set the intensifier.
SIDXCameraGainItemSet
int SIDXCameraGainItemSet(void *SIDXcamera, int index)
Set the analog gain according to the specified gain list index.
SIDXCameraOperateItemGet
int SIDXCameraOperateItemGet(void *SIDXcamera, int &index)
Obtain the current operating mode setting.
SIDXCameraBinningItemGet
int SIDXCameraBinningItemGet(void *SIDXcamera, int &index)
Obtain the item of the current binning selection within the binning list.
SIDXCameraRotateMirrorY
int SIDXCameraRotateMirrorY(void *SIDXcamera)
Mirror the image in y.
SIDXCameraIntensifierGet
int SIDXCameraIntensifierGet(void *SIDXcamera, double &gain)
Obtain the current intensifier setting.
SIDXCameraReadoutGetValue
int SIDXCameraReadoutGetValue(void *SIDXcamera, double &pixel_rate, int &pixel_depth)
Obtain the pixel depth and pixel rate of images acquired using the Readout, with the current settings...
SIDXCameraOperateSet
int SIDXCameraOperateSet(void *SIDXcamera, const wchar_t *value)
Set the current operating mode setting, using a camera-specific text string.
SIDXCameraCoolingGetControl
int SIDXCameraCoolingGetControl(void *SIDXcamera, SIDXCoolingControl &control)
Obtain the type of image sensor temperature control and monitoring available.
SIDXCameraRotateSet
int SIDXCameraRotateSet(void *SIDXcamera, int count)
Set the image rotation as a count of 90 degree clockwise rotations.
SIDXGeometryPixelGetCount
int SIDXGeometryPixelGetCount(void *SIDXcamera, int &x, int &y)
Obtain the x and y pixel count for images.
SIDXCameraRotateMirrorX
int SIDXCameraRotateMirrorX(void *SIDXcamera)
Mirror the image in x.
SIDXCameraIntensifierGetLabel
int SIDXCameraIntensifierGetLabel(void *SIDXcamera, wchar_t *label, size_t length)
Obtain the label for the intensifier setting.
SIDXCameraEMGainItemGetLocal
int SIDXCameraEMGainItemGetLocal(void *SIDXcamera, int index, wchar_t *description, size_t length)
Obtain a text string description of the EM gain value corresponding to the specified index...
SIDXCameraEMGainGet
int SIDXCameraEMGainGet(void *SIDXcamera, int &gain)
Obtain the current EM gain setting.
SIDXCameraShutterExists
int SIDXCameraShutterExists(void *SIDXcamera, SIDXShutterMode mode, bool &available)
Determine whether a given shutter control mode is available.
SIDXCameraBinningItemGetEntry
int SIDXCameraBinningItemGetEntry(void *SIDXcamera, int index, int &x, int &y)
Given the index of a binning selection within the list, returns the x and y axis binning factor...
SIDXCameraROISet
int SIDXCameraROISet(void *SIDXcamera, int x1, int y1, int x2, int y2)
Set the ROI (region of interest) for imaging.
SIDXCameraTriggerModeSet
int SIDXCameraTriggerModeSet(void *SIDXcamera, SIDXTriggerInMode mode)
Set the trigger input control to the specified value.
SIDXCoolingControl
SIDXCoolingControl
A value of this type represents a temperature control capability.
Definition: SIDXCConstants.h:116
SIDXCameraIntensifierGetRange
int SIDXCameraIntensifierGetRange(void *SIDXcamera, double &minimum, double &maximum)
Obtain the minimum and maximum intensifier value.
SIDXCameraGainGetUnit
int SIDXCameraGainGetUnit(void *SIDXcamera, wchar_t *unit, size_t length)
Obtain the camera analog gain unit as a text string.
SIDXCameraGainGetValue
int SIDXCameraGainGetValue(void *SIDXcamera, double &gain)
Obtain the current readout analog gain value used by the camera.
SIDXCameraFanControlGet
int SIDXCameraFanControlGet(void *SIDXcamera, bool &enable)
Obtain whether or not fan control is enabled.
SIDXCameraEMGainItemGetCount
int SIDXCameraEMGainItemGetCount(void *SIDXcamera, int &count)
Obtain the count of available EM gain settings.
SIDXCameraClose
int SIDXCameraClose(void *SIDXcamera)
Close the camera.
SIDXCameraCoolingGetValue
int SIDXCameraCoolingGetValue(void *SIDXcamera, double &temperature)
Obtain the image sensor temperature.
SIDXCameraAcquireImageSetLimit
int SIDXCameraAcquireImageSetLimit(void *SIDXcamera, int64_t maximum_count)
Set the maximum number of images acquired following each call to SIDXAcquireStart.
SIDXCameraBufferCountGet
int SIDXCameraBufferCountGet(void *SIDXcamera, int &count)
Obtain the image buffer count setting.
SIDXCameraROIGet
int SIDXCameraROIGet(void *SIDXcamera, int &x1, int &y1, int &x2, int &y2)
Obtain the ROI setting.
SIDXCameraEMGainGetValue
int SIDXCameraEMGainGetValue(void *SIDXcamera, int &gain)
Obtain the current EM gain value.
SIDXCameraOperateGet
int SIDXCameraOperateGet(void *SIDXcamera, wchar_t *value, size_t length)
Obtain the current operating mode setting as a camera-specific text string.
SIDXCameraEMGainGetLabel
int SIDXCameraEMGainGetLabel(void *SIDXcamera, wchar_t *label, size_t length)
Obtain the label of the EM gain as a text string.
SIDXCameraBinningYGetLimit
int SIDXCameraBinningYGetLimit(void *SIDXcamera, int &maximum)
Obtain the maximum y axis binning ratio.
SIDXCameraCoolingGetRange
int SIDXCameraCoolingGetRange(void *SIDXcamera, double &minimum, double &maximum)
Obtain the minimum and maximum temperature setting.
SIDXCameraExposeSet
int SIDXCameraExposeSet(void *SIDXcamera, double exposure)
Set the exposure time.
SIDXCameraFanControlExists
int SIDXCameraFanControlExists(void *SIDXcamera, bool &available)
Determine if fan control is available.
SIDXCameraTemperatureGet
int SIDXCameraTemperatureGet(void *SIDXcamera, double &temperature)
Obtain the current measured sensor temperature.
SIDXCameraGainItemGet
int SIDXCameraGainItemGet(void *SIDXcamera, int &index)
Obtain the index of the gain within the gain list.
SIDXCameraReadoutItemGetCount
int SIDXCameraReadoutItemGetCount(void *SIDXcamera, int &count)
Obtain the count of available Readout settings.
SIDXCameraTriggerModeExists
int SIDXCameraTriggerModeExists(void *SIDXcamera, SIDXTriggerInMode mode, bool &available)
Determine whether a given trigger input control mode is available.
SIDXCameraEMGainGetUnit
int SIDXCameraEMGainGetUnit(void *SIDXcamera, wchar_t *unit, size_t length)
Obtain the unit of the EM gain as a text string.
SIDXCameraBinningXGetLimit
int SIDXCameraBinningXGetLimit(void *SIDXcamera, int &maximum)
Obtain the largest x axis binning ratio.
SIDXCameraEMGainGetRange
int SIDXCameraEMGainGetRange(void *SIDXcamera, int &minimum, int &maximum)
Obtain the minimum and maximum EM gain value.
SIDXCameraAcquireOpen
int SIDXCameraAcquireOpen(void *SIDXcamera, void *&SIDXacquire)
Prepare acquisition.
SIDXCameraBinningXItemGetEntry
int SIDXCameraBinningXItemGetEntry(void *SIDXcamera, int index, int &binning)
Obtain the x axis binning ratio for the specified list index.
SIDXCameraCoolingSet
int SIDXCameraCoolingSet(void *SIDXcamera, double temperature)
Set the image sensor target temperature.
SIDXGeometryChannelGetDepth
int SIDXGeometryChannelGetDepth(void *SIDXcamera, int &depth)
Obtain the pixel depth of one channel from the image data.
SIDXCameraBinningItemSet
int SIDXCameraBinningItemSet(void *SIDXcamera, int index)
Set the binning to the specified index within the binning list.
SIDXCameraEMGainItemGet
int SIDXCameraEMGainItemGet(void *SIDXcamera, int &index)
Obtain the index of the EM gain within the gain list.
SIDXCameraROIClear
int SIDXCameraROIClear(void *SIDXcamera)
Clear the ROI (region of interest), so the entire image is acquired.
SIDXCameraIntensifierGetValue
int SIDXCameraIntensifierGetValue(void *SIDXcamera, double &gain)
Obtain the current intensifier value.
SIDXCameraGainGetRange
int SIDXCameraGainGetRange(void *SIDXcamera, double &minimum, double &maximum)
Obtain the analog gain minimum and maximum value.
SIDXCameraBinningXItemGetLocal
int SIDXCameraBinningXItemGetLocal(void *SIDXcamera, int index, wchar_t *description, size_t length)
Obtain a text description of the x axis binning ratio for the specified list index.
SIDXCameraTransferRateGet
int SIDXCameraTransferRateGet(void *SIDXcamera, double &transfer_rate)
Obtain the transfer rate in bytes per second.
SIDXCameraEMGainSet
int SIDXCameraEMGainSet(void *SIDXcamera, int gain)
Sets the EM gain.
SIDXCameraOperateItemGetCount
int SIDXCameraOperateItemGetCount(void *SIDXcamera, int &count)
Obtain the count of available camera operating modes.
SIDXCameraBinningGet
int SIDXCameraBinningGet(void *SIDXcamera, int &x, int &y)
Obtain the x and y axis binning.
SIDXCameraAcquireImageGetLimit
int SIDXCameraAcquireImageGetLimit(void *SIDXcamera, int64_t &maximum_count)
Obtain the maximum number of images that was set by ImageSetLimit.
SIDXGeometryImageGetSize
int SIDXGeometryImageGetSize(void *SIDXcamera, size_t &size)
Obtain the data size of an image.
SIDXCameraShutterGet
int SIDXCameraShutterGet(void *SIDXcamera, SIDXShutterMode &mode)
Obtain the current shutter control setting.
SIDXShutterMode
SIDXShutterMode
A value of this type represents a shutter control mode.
Definition: SIDXCConstants.h:65
SIDXCameraExposeGetValue
int SIDXCameraExposeGetValue(void *SIDXcamera, double &exposure)
Obtain the exposure time (duration) value used by the camera.
SIDXCameraExternalDelaySet
int SIDXCameraExternalDelaySet(void *SIDXcamera, double interval)
Set the time interval in seconds between the end of an exposure and the start of the next exposure re...
SIDXCameraGainItemGetLocal
int SIDXCameraGainItemGetLocal(void *SIDXcamera, int index, wchar_t *description, size_t length)
Obtain a text description of the specified gain list index.
SIDXCameraReadoutItemGetLocal
int SIDXCameraReadoutItemGetLocal(void *SIDXcamera, int index, wchar_t *description, size_t length)
Obtain a text string description of the Readout corresponding to the specified index.
SIDXTriggerInMode
SIDXTriggerInMode
A value of this type represents the trigger input control mode for acquisition.
Definition: SIDXCConstants.h:85
SIDXCameraIntensifierGetUnit
int SIDXCameraIntensifierGetUnit(void *SIDXcamera, wchar_t *unit, size_t length)
Obtain the intensifier gain unit as a text string.
SIDXCameraGainItemGetEntry
int SIDXCameraGainItemGetEntry(void *SIDXcamera, int index, double &gain)
Obtain the gain value corresponding to a specified gain list index.
SIDXCameraTransferRateSet
int SIDXCameraTransferRateSet(void *SIDXcamera, double transfer_rate)
Set the transfer rate in bytes per second.
SIDXCameraExposeGet
int SIDXCameraExposeGet(void *SIDXcamera, double &exposure)
Obtain the exposure time (duration) setting.
SIDXCameraOperateItemGetLocal
int SIDXCameraOperateItemGetLocal(void *SIDXcamera, int index, wchar_t *description, size_t length)
Obtain a text string description of the operating mode corresponding to the specified index...
SIDXCameraRotateClear
int SIDXCameraRotateClear(void *SIDXcamera)
Clear the rotation and mirroring settings, so acquired images are not transformed.
SIDXCameraExternalDelayGet
int SIDXCameraExternalDelayGet(void *SIDXcamera, double &interval)
Obtain the time interval in seconds required by the external device between the end of an exposure an...
SIDXCameraGainItemGetCount
int SIDXCameraGainItemGetCount(void *SIDXcamera, int &count)
Obtain the count of available gain settings.
SIDXGeometryImageGetType
int SIDXGeometryImageGetType(void *SIDXcamera, SIDXImageType &type)
Obtain the image type of the source image.
SIDXCameraBinningSet
int SIDXCameraBinningSet(void *SIDXcamera, int x, int y)
Set the binning as binning x and y factors.
SIDXCameraReadoutSet
int SIDXCameraReadoutSet(void *SIDXcamera, const wchar_t *value)
Set the current Readout setting, using a camera-specific value.
SIDXCameraGainGetType
int SIDXCameraGainGetType(void *SIDXcamera, SIDXSettingType &type)
Obtain the type of analog gain setting.
SIDXCameraShutterSet
int SIDXCameraShutterSet(void *SIDXcamera, SIDXShutterMode mode)
Set the shutter control to the specified value.
SIDXCameraTriggerSignalGet
int SIDXCameraTriggerSignalGet(void *SIDXcamera, SIDXSignalActiveMode &mode)
Obtain the current trigger input signal setting.
SIDXCameraGetLastError
void SIDXCameraGetLastError(void *SIDXcamera, wchar_t *message, size_t length)
The function translates the error code into a text string.
SIDXSignalActiveMode
SIDXSignalActiveMode
A value of this type represents the trigger signal mode for acquisition.
Definition: SIDXCConstants.h:104
SIDXCameraTriggerModeGet
int SIDXCameraTriggerModeGet(void *SIDXcamera, SIDXTriggerInMode &mode)
Obtain the current trigger input control setting.
SIDXCameraEMGainItemSet
int SIDXCameraEMGainItemSet(void *SIDXcamera, int index)
Set the EM gain to a value corresponding to an index within the list.
SIDXCameraBinningXItemGetCount
int SIDXCameraBinningXItemGetCount(void *SIDXcamera, int &count)
Obtain the count of available x axis binning settings.
SIDXCameraGainGet
int SIDXCameraGainGet(void *SIDXcamera, double &gain)
Obtain the current readout analog gain setting.
SIDXCameraBinningItemGetLocal
int SIDXCameraBinningItemGetLocal(void *SIDXcamera, int index, wchar_t *description, size_t length)
Obtain a text string description of the specified binning setting.
SIDXCameraOperateItemSet
int SIDXCameraOperateItemSet(void *SIDXcamera, int index)
Set the operating mode to the specified index.
SIDXCameraBufferCountSet
int SIDXCameraBufferCountSet(void *SIDXcamera, int count)
Set the minimum number of sensor images to buffer during Acquire.
SIDXCameraReadoutGet
int SIDXCameraReadoutGet(void *SIDXcamera, wchar_t *value, size_t length)
Obtain the current Readout setting as a camera-specific value.
SIDXCameraCoolingGet
int SIDXCameraCoolingGet(void *SIDXcamera, double &temperature)
Obtain the image sensor target temperature.
SIDXCameraBinningGetType
int SIDXCameraBinningGetType(void *SIDXcamera, SIDXSettingType &type)
Obtain the type of binning for the camera.
SIDXCameraPollingGet
int SIDXCameraPollingGet(void *SIDXcamera, double &interval)
Obtain the service interval (polling interval) setting.
SIDXCameraFanControlSet
int SIDXCameraFanControlSet(void *SIDXcamera, bool enable)
Set the fan control.
SIDXImageType
SIDXImageType
A value of this type represents either a source image type or a target image type.
Definition: SIDXCConstants.h:142
SIDXCameraROIGetValue
int SIDXCameraROIGetValue(void *SIDXcamera, int &x1, int &y1, int &x2, int &y2)
Obtain the ROI used.
SIDXGeometryPixelSpacingGet
int SIDXGeometryPixelSpacingGet(void *SIDXcamera, double &x, double &y)
Obtain the pixel size in x and y.
SIDXCameraTriggerSignalExists
int SIDXCameraTriggerSignalExists(void *SIDXcamera, SIDXSignalActiveMode mode, bool &available)
Determine whether a given trigger input signal mode is available.
SIDXCameraExposeGetRange
int SIDXCameraExposeGetRange(void *SIDXcamera, double &minimum, double &maximum)
Obtain the minimum and maximum exposure time duration.
SIDXCameraEMGainGetType
int SIDXCameraEMGainGetType(void *SIDXcamera, SIDXSettingType &type)
Obtain the type of EM gain setting.
SIDXCameraTriggerSignalSet
int SIDXCameraTriggerSignalSet(void *SIDXcamera, SIDXSignalActiveMode mode)
Set the trigger input signal to the specified value.
SIDXCameraReadoutItemGet
int SIDXCameraReadoutItemGet(void *SIDXcamera, int &index)
Obtain the current Readout setting.
SIDXCameraReadoutItemGetEntry
int SIDXCameraReadoutItemGetEntry(void *SIDXcamera, int index, double &pixel_rate, int &pixel_depth)
Obtain the pixel depth and pixel rate of images acquired using the Readout corresponding to the speci...
SIDXCameraGainGetLabel
int SIDXCameraGainGetLabel(void *SIDXcamera, wchar_t *label, size_t length)
Obtain the camera analog gain label as a text string.
Generated on Mon Jul 20 2015 10:23:36 for SIDX 7 by   doxygen 1.8.9