SIDX 7
SIDXCamera.h
Go to the documentation of this file.
1 
6 #include "SIDXConstants.h"
7 
8 #ifndef SIDXXOPCamera_H
9 #define SIDXXOPCamera_H
10 
19 SIDXCameraAcquireImageGetLimit(integer SIDXcamera, integer maximum_count, integer status);
32 SIDXCameraAcquireImageSetLimit(integer SIDXcamera, integer maximum_count, integer status);
42 SIDXCameraAcquireOpen(integer SIDXcamera, integer SIDXacquire, integer status);
43 
52 SIDXCameraBinningGet(integer SIDXcamera, integer x, integer y, integer status);
64 SIDXCameraBinningGetType(integer SIDXcamera, integer type, integer status);
72 SIDXCameraBinningItemGet(integer SIDXcamera, integer index, integer status);
85 SIDXCameraBinningItemGetCount(integer SIDXcamera, integer count, integer status);
94 SIDXCameraBinningItemGetEntry(integer SIDXcamera, integer index, integer x, integer y, integer status);
103  (integer SIDXcamera, integer index, string description, integer status);
110 SIDXCameraBinningItemSet(integer SIDXcamera, integer index, integer status);
124 SIDXCameraBinningSet(integer SIDXcamera, integer x, integer y, integer status);
125 
135 SIDXCameraBinningXGetLimit(integer SIDXcamera, integer maximum, integer status);
146 SIDXCameraBinningXGetType(integer SIDXcamera, integer type, integer status);
156 SIDXCameraBinningXItemGetCount(integer SIDXcamera, integer count, integer status);
168 SIDXCameraBinningXItemGetEntry(integer SIDXcamera, integer index, integer binning, integer status);
180  (integer SIDXcamera, integer index, string description, integer status);
181 
193 SIDXCameraBinningYGetLimit(integer SIDXcamera, integer maximum, integer status);
194 
203 SIDXCameraBufferCountGet(integer SIDXcamera, integer count, integer status);
212 SIDXCameraBufferCountSet(integer SIDXcamera, integer count, integer status);
213 
220 SIDXCameraClose(integer SIDXcamera, integer status);
221 
222 
231 SIDXCameraCoolingGet(integer SIDXcamera, double temperature, integer status);
239 SIDXCameraCoolingGetControl(integer SIDXcamera, integer control, integer status);
250 SIDXCameraCoolingGetRange(integer SIDXcamera, double minimum, double maximum, integer status);
259 SIDXCameraCoolingGetValue(integer SIDXcamera, double temperature, integer status);
269 SIDXCameraCoolingSet(integer SIDXcamera, double temperature, integer status);
270 
279 SIDXCameraEMGainGet(integer SIDXcamera, integer gain, integer status);
287 SIDXCameraEMGainGetLabel(integer SIDXcamera, string label, integer status);
296 SIDXCameraEMGainGetRange(integer SIDXcamera, integer minimum, integer maximum, integer status);
305 SIDXCameraEMGainGetType(integer SIDXcamera, integer type, integer status);
313 SIDXCameraEMGainGetUnit(integer SIDXcamera, string unit, integer status);
322 SIDXCameraEMGainGetValue(integer SIDXcamera, integer gain, integer status);
330 SIDXCameraEMGainItemGet(integer SIDXcamera, integer index, integer status);
339 SIDXCameraEMGainItemGetCount(integer SIDXcamera, integer count, integer status);
351 SIDXCameraEMGainItemGetEntry(integer SIDXcamera, integer index, integer gain, integer status);
363  (integer SIDXcamera, integer index, string description, integer status);
373 SIDXCameraEMGainItemSet(integer SIDXcamera, integer index, integer status);
384 SIDXCameraEMGainSet(integer SIDXcamera, integer gain, integer status);
385 
394 SIDXCameraExposeGet(integer SIDXcamera, double exposure, integer status);
404 SIDXCameraExposeGetRange(integer SIDXcamera, double minimum, double maximum, integer status);
413 SIDXCameraExposeGetValue(integer SIDXcamera, double exposure, integer status);
424 SIDXCameraExposeSet(integer SIDXcamera, double exposure, integer status);
425 
436 SIDXCameraExternalDelayGet(integer SIDXcamera, double interval, integer status);
445 SIDXCameraExternalDelaySet(integer SIDXcamera, double interval, integer status);
446 
455 SIDXCameraFanControlExists(integer SIDXcamera, integer available, integer status);
464 SIDXCameraFanControlGet(integer SIDXcamera, integer enable, integer status);
474 SIDXCameraFanControlSet(integer SIDXcamera, integer enable, integer status);
475 
485 SIDXCameraGainGet(integer SIDXcamera, double gain, integer status);
494 SIDXCameraGainGetLabel(integer SIDXcamera, string label, integer status);
503 SIDXCameraGainGetRange(integer SIDXcamera, double minimum, double maximum, integer status);
512 SIDXCameraGainGetType(integer SIDXcamera, integer type, integer status);
521 SIDXCameraGainGetUnit(integer SIDXcamera, string unit, integer status);
531 SIDXCameraGainGetValue(integer SIDXcamera, double gain, integer status);
540 SIDXCameraGainItemGet(integer SIDXcamera, integer index, integer status);
548 SIDXCameraGainItemGetCount(integer SIDXcamera, integer count, integer status);
560 SIDXCameraGainItemGetEntry(integer SIDXcamera, integer index, double gain, integer status);
571 SIDXCameraGainItemGetLocal(integer SIDXcamera, integer index, string description, integer status);
581 SIDXCameraGainItemSet(integer SIDXcamera, integer index, integer status);
590 SIDXCameraGainSet(integer SIDXcamera, double gain, integer status);
591 
597 SIDXCameraGetLastError(integer SIDXcamera, string message);
598 
606 SIDXCameraIntensifierGet(integer SIDXcamera, double gain, integer status);
614 SIDXCameraIntensifierGetLabel(integer SIDXcamera, string label, integer status);
623 SIDXCameraIntensifierGetRange(integer SIDXcamera, double minimum, double maximum, integer status);
632 SIDXCameraIntensifierGetType(integer SIDXcamera, integer type, integer status);
641 SIDXCameraIntensifierGetUnit(integer SIDXcamera, string unit, integer status);
649 SIDXCameraIntensifierGetValue(integer SIDXcamera, double gain, integer status);
658 SIDXCameraIntensifierSet(integer SIDXcamera, double gain, integer status);
659 
669 SIDXCameraOperateGet(integer SIDXcamera, string value, integer status);
677 SIDXCameraOperateItemGet(integer SIDXcamera, integer index, integer status);
687 SIDXCameraOperateItemGetCount(integer SIDXcamera, integer count, integer status);
697 SIDXCameraOperateItemGetLocal(integer SIDXcamera, integer index, string description, integer status);
706 SIDXCameraOperateItemSet(integer SIDXcamera, integer index, integer status);
718 SIDXCameraOperateSet(integer SIDXcamera, string value, integer status);
719 
728 SIDXCameraPollingGet(integer SIDXcamera, double interval, integer status);
739 SIDXCameraPollingSet(integer SIDXcamera, double interval, integer status);
740 
751 SIDXCameraReadoutGet(integer SIDXcamera, string value, integer status);
764 SIDXCameraReadoutGetValue(integer SIDXcamera, double pixel_rate, integer pixel_depth, integer status);
772 SIDXCameraReadoutItemGet(integer SIDXcamera, integer index, integer status);
783 SIDXCameraReadoutItemGetCount(integer SIDXcamera, integer count, integer status);
799  (integer SIDXcamera, integer index, double pixel_rate, integer pixel_depth, integer status);
810  (integer SIDXcamera, integer index, string description, integer status);
818 SIDXCameraReadoutItemSet(integer SIDXcamera, integer index, integer status);
829 SIDXCameraReadoutSet(integer SIDXcamera, string value, integer status);
830 
837 SIDXCameraROIClear(integer SIDXcamera, integer status);
852 SIDXCameraROIGet(integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status);
869 SIDXCameraROIGetValue(integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status);
886 SIDXCameraROISet(integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status);
887 
895 SIDXCameraRotateClear(integer SIDXcamera, integer status);
906 SIDXCameraRotateMirrorX(integer SIDXcamera, integer status);
917 SIDXCameraRotateMirrorY(integer SIDXcamera, integer status);
929 SIDXCameraRotateSet(integer SIDXcamera, integer count, integer status);
930 
940 SIDXCameraShutterExists(integer SIDXcamera, integer mode, integer available, integer status);
948 SIDXCameraShutterGet(integer SIDXcamera, integer mode, integer status);
956 SIDXCameraShutterSet(integer SIDXcamera, integer mode, integer status);
957 
966 SIDXCameraTemperatureExists(integer SIDXcamera, integer available, integer status);
975 SIDXCameraTemperatureGet(integer SIDXcamera, double temperature, integer status);
976 
977 
986 SIDXCameraTransferRateGet(integer SIDXcamera, double transfer_rate, integer status);
996 SIDXCameraTransferRateSet(integer SIDXcamera, double transfer_rate, integer status);
997 
1007 SIDXCameraTriggerModeExists(integer SIDXcamera, integer mode, integer available, integer status);
1015 SIDXCameraTriggerModeGet(integer SIDXcamera, integer mode, integer status);
1023 SIDXCameraTriggerModeSet(integer SIDXcamera, integer mode, integer status);
1024 
1034 SIDXCameraTriggerSignalExists(integer SIDXcamera, integer mode, integer available, integer status);
1042 SIDXCameraTriggerSignalGet(integer SIDXcamera, integer mode, integer status);
1050 SIDXCameraTriggerSignalSet(integer SIDXcamera, integer mode, integer status);
1051 
1052 #ifdef DOXYGEN
1053 
1061 SIDXGeometryChannelGetDepth(integer SIDXcamera, integer depth, integer status);
1071 SIDXGeometryImageGetSize(integer SIDXcamera, integer size, integer status);
1079 SIDXGeometryImageGetType(integer SIDXcamera, integer type, integer status);
1088 SIDXGeometryPixelGetCount(integer SIDXcamera, integer x, integer y, integer status);
1099 SIDXGeometryPixelSpacingGet(integer SIDXcamera, double x, double y, integer status);
1100 
1101 #endif
1102 
1103 #endif
SIDXCameraFanControlExists(integer SIDXcamera, integer available, integer status)
Determine if fan control is available.
SIDXCameraTransferRateSet(integer SIDXcamera, double transfer_rate, integer status)
Set the transfer rate in bytes per second.
SIDXCameraCoolingSet(integer SIDXcamera, double temperature, integer status)
Set the image sensor target temperature.
SIDXCameraOperateItemSet(integer SIDXcamera, integer index, integer status)
Set the operating mode to the specified index.
SIDXCameraShutterSet(integer SIDXcamera, integer mode, integer status)
Set the shutter control to the specified value.
SIDXCameraExternalDelayGet(integer SIDXcamera, double interval, integer status)
Obtain the time interval in seconds required by the external device between the end of an exposure an...
SIDXCameraEMGainGetRange(integer SIDXcamera, integer minimum, integer maximum, integer status)
Obtain the minimum and maximum EM gain value.
SIDXCameraTransferRateGet(integer SIDXcamera, double transfer_rate, integer status)
Obtain the transfer rate in bytes per second.
SIDXCameraReadoutItemGetEntry(integer SIDXcamera, integer index, double pixel_rate, integer pixel_depth, integer status)
Obtain the pixel depth and pixel rate of images acquired using the Readout corresponding to the speci...
SIDXCameraIntensifierGetLabel(integer SIDXcamera, string label, integer status)
Obtain the label for the intensifier setting.
SIDXCameraBinningXGetLimit(integer SIDXcamera, integer maximum, integer status)
Obtain the largest x axis binning ratio.
SIDXCameraROIGetValue(integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status)
Obtain the ROI used.
SIDXCameraTriggerSignalSet(integer SIDXcamera, integer mode, integer status)
Set the trigger input signal to the specified value.
SIDXCameraPollingGet(integer SIDXcamera, double interval, integer status)
Obtain the service interval (polling interval) setting.
SIDXCameraCoolingGetValue(integer SIDXcamera, double temperature, integer status)
Obtain the image sensor temperature.
SIDXCameraGainGetRange(integer SIDXcamera, double minimum, double maximum, integer status)
Obtain the analog gain minimum and maximum value.
SIDXCameraIntensifierGetType(integer SIDXcamera, integer type, integer status)
Obtain the type of intensifier setting.
SIDXCameraEMGainGetType(integer SIDXcamera, integer type, integer status)
Obtain the type of EM gain setting.
SIDXCameraAcquireOpen(integer SIDXcamera, integer SIDXacquire, integer status)
Prepare acquisition.
SIDXCameraFanControlSet(integer SIDXcamera, integer enable, integer status)
Set the fan control.
SIDXCameraGainGetType(integer SIDXcamera, integer type, integer status)
Obtain the type of analog gain setting.
SIDXCameraGainGetValue(integer SIDXcamera, double gain, integer status)
Obtain the current readout analog gain value used by the camera.
SIDXCameraAcquireImageSetLimit(integer SIDXcamera, integer maximum_count, integer status)
Set the maximum number of images acquired following each call to SIDXAcquireStart.
SIDXCameraOperateItemGetLocal(integer SIDXcamera, integer index, string description, integer status)
Obtain a text string description of the operating mode corresponding to the specified index...
SIDXCameraExposeGetValue(integer SIDXcamera, double exposure, integer status)
Obtain the exposure time (duration) value used by the camera.
SIDXCameraEMGainItemGetCount(integer SIDXcamera, integer count, integer status)
Obtain the count of available EM gain settings.
SIDXCameraGetLastError(integer SIDXcamera, string message)
The function translates the error code into a text string.
File containing SIDX constants for reference.
SIDXCameraOperateGet(integer SIDXcamera, string value, integer status)
Obtain the current operating mode setting as a camera-specific text string.
SIDXCameraGainItemGetEntry(integer SIDXcamera, integer index, double gain, integer status)
Obtain the gain value corresponding to a specified gain list index.
SIDXCameraExposeGetRange(integer SIDXcamera, double minimum, double maximum, integer status)
Obtain the minimum and maximum exposure time duration.
SIDXCameraReadoutGet(integer SIDXcamera, string value, integer status)
Obtain the current Readout setting as a camera-specific value.
SIDXCameraEMGainItemGetLocal(integer SIDXcamera, integer index, string description, integer status)
Obtain a text string description of the EM gain value corresponding to the specified index...
SIDXCameraRotateMirrorX(integer SIDXcamera, integer status)
Mirror the image in x.
SIDXCameraIntensifierGetValue(integer SIDXcamera, double gain, integer status)
Obtain the current intensifier value.
SIDXGeometryImageGetType(integer SIDXcamera, integer type, integer status)
Obtain the image type of the source image.
SIDXCameraBinningGet(integer SIDXcamera, integer x, integer y, integer status)
Obtain the x and y axis binning.
SIDXCameraEMGainItemSet(integer SIDXcamera, integer index, integer status)
Set the EM gain to a value corresponding to an index within the list.
SIDXCameraTriggerModeGet(integer SIDXcamera, integer mode, integer status)
Obtain the current trigger input control setting.
SIDXCameraBinningSet(integer SIDXcamera, integer x, integer y, integer status)
Set the binning as binning x and y factors.
SIDXCameraReadoutItemGetCount(integer SIDXcamera, integer count, integer status)
Obtain the count of available Readout settings.
SIDXCameraRotateClear(integer SIDXcamera, integer status)
Clear the rotation and mirroring settings, so acquired images are not transformed.
SIDXCameraROISet(integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status)
Set the ROI (region of interest) for imaging.
SIDXCameraGainGet(integer SIDXcamera, double gain, integer status)
Obtain the current readout analog gain setting.
SIDXCameraROIClear(integer SIDXcamera, integer status)
Clear the ROI (region of interest), so the entire image is acquired.
SIDXCameraRotateSet(integer SIDXcamera, integer count, integer status)
Set the image rotation as a count of 90 degree clockwise rotations.
SIDXGeometryImageGetSize(integer SIDXcamera, integer size, integer status)
Obtain the data size of an image.
SIDXGeometryPixelGetCount(integer SIDXcamera, integer x, integer y, integer status)
Obtain the x and y pixel count for images.
SIDXCameraCoolingGet(integer SIDXcamera, double temperature, integer status)
Obtain the image sensor target temperature.
SIDXCameraOperateItemGet(integer SIDXcamera, integer index, integer status)
Obtain the current operating mode setting.
SIDXCameraIntensifierGet(integer SIDXcamera, double gain, integer status)
Obtain the current intensifier setting.
SIDXCameraClose(integer SIDXcamera, integer status)
Close the camera.
SIDXCameraIntensifierSet(integer SIDXcamera, double gain, integer status)
Set the intensifier.
SIDXCameraBinningXItemGetCount(integer SIDXcamera, integer count, integer status)
Obtain the count of available x axis binning settings.
SIDXCameraGainItemSet(integer SIDXcamera, integer index, integer status)
Set the analog gain according to the specified gain list index.
SIDXCameraGainSet(integer SIDXcamera, double gain, integer status)
Set the camera analog gain to the specified value.
SIDXCameraEMGainGetLabel(integer SIDXcamera, string label, integer status)
Obtain the label of the EM gain as a text string.
SIDXCameraBinningItemGetEntry(integer SIDXcamera, integer index, integer x, integer y, integer status)
Given the index of a binning selection within the list, returns the x and y axis binning factor...
SIDXGeometryPixelSpacingGet(integer SIDXcamera, double x, double y, integer status)
Obtain the pixel size in x and y.
SIDXCameraBinningYGetLimit(integer SIDXcamera, integer maximum, integer status)
Obtain the maximum y axis binning ratio.
SIDXCameraPollingSet(integer SIDXcamera, double interval, integer status)
Set the service interval during Acquire.
SIDXCameraGainItemGetCount(integer SIDXcamera, integer count, integer status)
Obtain the count of available gain settings.
SIDXCameraReadoutGetValue(integer SIDXcamera, double pixel_rate, integer pixel_depth, integer status)
Obtain the pixel depth and pixel rate of images acquired using the Readout, with the current settings...
SIDXCameraBinningXItemGetEntry(integer SIDXcamera, integer index, integer binning, integer status)
Obtain the x axis binning ratio for the specified list index.
SIDXCameraCoolingGetRange(integer SIDXcamera, double minimum, double maximum, integer status)
Obtain the minimum and maximum temperature setting.
SIDXCameraEMGainGet(integer SIDXcamera, integer gain, integer status)
Obtain the current EM gain setting.
SIDXCameraGainItemGetLocal(integer SIDXcamera, integer index, string description, integer status)
Obtain a text description of the specified gain list index.
SIDXCameraFanControlGet(integer SIDXcamera, integer enable, integer status)
Obtain whether or not fan control is enabled.
SIDXCameraBinningGetType(integer SIDXcamera, integer type, integer status)
Obtain the type of binning for the camera.
SIDXCameraBinningItemGetLocal(integer SIDXcamera, integer index, string description, integer status)
Obtain a text string description of the specified binning setting.
SIDXCameraExposeGet(integer SIDXcamera, double exposure, integer status)
Obtain the exposure time (duration) setting.
SIDXCameraGainGetUnit(integer SIDXcamera, string unit, integer status)
Obtain the camera analog gain unit as a text string.
SIDXCameraReadoutSet(integer SIDXcamera, string value, integer status)
Set the current Readout setting, using a camera-specific value.
SIDXCameraTriggerSignalExists(integer SIDXcamera, integer mode, integer available, integer status)
Determine whether a given trigger input signal mode is available.
SIDXCameraTriggerModeSet(integer SIDXcamera, integer mode, integer status)
Set the trigger input control to the specified value.
SIDXCameraCoolingGetControl(integer SIDXcamera, integer control, integer status)
Obtain the type of image sensor temperature control and monitoring available.
SIDXCameraTemperatureGet(integer SIDXcamera, double temperature, integer status)
Obtain the current measured sensor temperature.
SIDXCameraEMGainItemGetEntry(integer SIDXcamera, integer index, integer gain, integer status)
Obtain the EM gain value corresponding to an index within the list.
SIDXCameraShutterExists(integer SIDXcamera, integer mode, integer available, integer status)
Determine whether a given shutter control mode is available.
SIDXCameraTriggerModeExists(integer SIDXcamera, integer mode, integer available, integer status)
Determine whether a given trigger input control mode is available.
SIDXCameraBinningItemSet(integer SIDXcamera, integer index, integer status)
Set the binning to the specified index within the binning list.
SIDXCameraBinningItemGet(integer SIDXcamera, integer index, integer status)
Obtain the item of the current binning selection within the binning list.
SIDXCameraGainGetLabel(integer SIDXcamera, string label, integer status)
Obtain the camera analog gain label as a text string.
SIDXCameraRotateMirrorY(integer SIDXcamera, integer status)
Mirror the image in y.
SIDXCameraROIGet(integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status)
Obtain the ROI setting.
SIDXCameraEMGainSet(integer SIDXcamera, integer gain, integer status)
Sets the EM gain.
SIDXGeometryChannelGetDepth(integer SIDXcamera, integer depth, integer status)
Obtain the pixel depth of one channel from the image data.
SIDXCameraShutterGet(integer SIDXcamera, integer mode, integer status)
Obtain the current shutter control setting.
SIDXCameraEMGainItemGet(integer SIDXcamera, integer index, integer status)
Obtain the index of the EM gain within the gain list.
SIDXCameraBinningXGetType(integer SIDXcamera, integer type, integer status)
Obtain the type of binning selection available for the x axis.
SIDXCameraGainItemGet(integer SIDXcamera, integer index, integer status)
Obtain the index of the gain within the gain list.
SIDXCameraBufferCountGet(integer SIDXcamera, integer count, integer status)
Obtain the image buffer count setting.
SIDXCameraExposeSet(integer SIDXcamera, double exposure, integer status)
Set the exposure time.
SIDXCameraBinningXItemGetLocal(integer SIDXcamera, integer index, string description, integer status)
Obtain a text description of the x axis binning ratio for the specified list index.
SIDXCameraReadoutItemSet(integer SIDXcamera, integer index, integer status)
Set the Readout to the specified index.
SIDXCameraTriggerSignalGet(integer SIDXcamera, integer mode, integer status)
Obtain the current trigger input signal setting.
SIDXCameraIntensifierGetRange(integer SIDXcamera, double minimum, double maximum, integer status)
Obtain the minimum and maximum intensifier value.
SIDXCameraReadoutItemGetLocal(integer SIDXcamera, integer index, string description, integer status)
Obtain a text string description of the Readout corresponding to the specified index.
SIDXCameraEMGainGetValue(integer SIDXcamera, integer gain, integer status)
Obtain the current EM gain value.
SIDXCameraBufferCountSet(integer SIDXcamera, integer count, integer status)
Set the minimum number of sensor images to buffer during Acquire.
SIDXCameraEMGainGetUnit(integer SIDXcamera, string unit, integer status)
Obtain the unit of the EM gain as a text string.
SIDXCameraOperateSet(integer SIDXcamera, string value, integer status)
Set the current operating mode setting, using a camera-specific text string.
SIDXCameraBinningItemGetCount(integer SIDXcamera, integer count, integer status)
Obtain the total number of available (x,y) binning combinations.
SIDXCameraExternalDelaySet(integer SIDXcamera, double interval, integer status)
Set the time interval in seconds between the end of an exposure and the start of the next exposure re...
SIDXCameraOperateItemGetCount(integer SIDXcamera, integer count, integer status)
Obtain the count of available camera operating modes.
SIDXCameraTemperatureExists(integer SIDXcamera, integer available, integer status)
Determine whether the camera sensor temperature is available.
SIDXCameraAcquireImageGetLimit(integer SIDXcamera, integer maximum_count, integer status)
Obtain the maximum number of images that was set by ImageSetLimit.
SIDXCameraIntensifierGetUnit(integer SIDXcamera, string unit, integer status)
Obtain the intensifier gain unit as a text string.
SIDXCameraReadoutItemGet(integer SIDXcamera, integer index, integer status)
Obtain the current Readout setting.