SIDX 7
Functions
SIDXCamera.h File Reference

File containing SIDX camera usage for reference. More...

#include "SIDXConstants.h"

Go to the source code of this file.

Functions

 SIDXCameraAcquireImageGetLimit (integer SIDXcamera, integer maximum_count, integer status)
 Obtain the maximum number of images that was set by ImageSetLimit. More...
 
 SIDXCameraAcquireImageSetLimit (integer SIDXcamera, integer maximum_count, integer status)
 Set the maximum number of images acquired following each call to SIDXAcquireStart. More...
 
 SIDXCameraAcquireOpen (integer SIDXcamera, integer SIDXacquire, integer status)
 Prepare acquisition. More...
 
 SIDXCameraBinningGet (integer SIDXcamera, integer x, integer y, integer status)
 Obtain the x and y axis binning. More...
 
 SIDXCameraBinningGetType (integer SIDXcamera, integer type, integer status)
 Obtain the type of binning for the camera. More...
 
 SIDXCameraBinningItemGet (integer SIDXcamera, integer index, integer status)
 Obtain the item of the current binning selection within the binning list. More...
 
 SIDXCameraBinningItemGetCount (integer SIDXcamera, integer count, integer status)
 Obtain the total number of available (x,y) binning combinations. More...
 
 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. More...
 
 SIDXCameraBinningItemGetLocal (integer SIDXcamera, integer index, string description, integer status)
 Obtain a text string description of the specified binning setting. More...
 
 SIDXCameraBinningItemSet (integer SIDXcamera, integer index, integer status)
 Set the binning to the specified index within the binning list. More...
 
 SIDXCameraBinningSet (integer SIDXcamera, integer x, integer y, integer status)
 Set the binning as binning x and y factors. More...
 
 SIDXCameraBinningXGetLimit (integer SIDXcamera, integer maximum, integer status)
 Obtain the largest x axis binning ratio. More...
 
 SIDXCameraBinningXGetType (integer SIDXcamera, integer type, integer status)
 Obtain the type of binning selection available for the x axis. More...
 
 SIDXCameraBinningXItemGetCount (integer SIDXcamera, integer count, integer status)
 Obtain the count of available x axis binning settings. More...
 
 SIDXCameraBinningXItemGetEntry (integer SIDXcamera, integer index, integer binning, integer status)
 Obtain the x axis binning ratio for the specified list index. More...
 
 SIDXCameraBinningXItemGetLocal (integer SIDXcamera, integer index, string description, integer status)
 Obtain a text description of the x axis binning ratio for the specified list index. More...
 
 SIDXCameraBinningYGetLimit (integer SIDXcamera, integer maximum, integer status)
 Obtain the maximum y axis binning ratio. More...
 
 SIDXCameraBufferCountGet (integer SIDXcamera, integer count, integer status)
 Obtain the image buffer count setting. More...
 
 SIDXCameraBufferCountSet (integer SIDXcamera, integer count, integer status)
 Set the minimum number of sensor images to buffer during Acquire. More...
 
 SIDXCameraClose (integer SIDXcamera, integer status)
 Close the camera. More...
 
 SIDXCameraCoolingGet (integer SIDXcamera, double temperature, integer status)
 Obtain the image sensor target temperature. More...
 
 SIDXCameraCoolingGetControl (integer SIDXcamera, integer control, integer status)
 Obtain the type of image sensor temperature control and monitoring available. More...
 
 SIDXCameraCoolingGetRange (integer SIDXcamera, double minimum, double maximum, integer status)
 Obtain the minimum and maximum temperature setting. More...
 
 SIDXCameraCoolingGetValue (integer SIDXcamera, double temperature, integer status)
 Obtain the image sensor temperature. More...
 
 SIDXCameraCoolingSet (integer SIDXcamera, double temperature, integer status)
 Set the image sensor target temperature. More...
 
 SIDXCameraEMGainGet (integer SIDXcamera, integer gain, integer status)
 Obtain the current EM gain setting. More...
 
 SIDXCameraEMGainGetLabel (integer SIDXcamera, string label, integer status)
 Obtain the label of the EM gain as a text string. More...
 
 SIDXCameraEMGainGetRange (integer SIDXcamera, integer minimum, integer maximum, integer status)
 Obtain the minimum and maximum EM gain value. More...
 
 SIDXCameraEMGainGetType (integer SIDXcamera, integer type, integer status)
 Obtain the type of EM gain setting. More...
 
 SIDXCameraEMGainGetUnit (integer SIDXcamera, string unit, integer status)
 Obtain the unit of the EM gain as a text string. More...
 
 SIDXCameraEMGainGetValue (integer SIDXcamera, integer gain, integer status)
 Obtain the current EM gain value. More...
 
 SIDXCameraEMGainItemGet (integer SIDXcamera, integer index, integer status)
 Obtain the index of the EM gain within the gain list. More...
 
 SIDXCameraEMGainItemGetCount (integer SIDXcamera, integer count, integer status)
 Obtain the count of available EM gain settings. More...
 
 SIDXCameraEMGainItemGetEntry (integer SIDXcamera, integer index, integer gain, integer status)
 Obtain the EM gain value corresponding to an index within the list. More...
 
 SIDXCameraEMGainItemGetLocal (integer SIDXcamera, integer index, string description, integer status)
 Obtain a text string description of the EM gain value corresponding to the specified index. More...
 
 SIDXCameraEMGainItemSet (integer SIDXcamera, integer index, integer status)
 Set the EM gain to a value corresponding to an index within the list. More...
 
 SIDXCameraEMGainSet (integer SIDXcamera, integer gain, integer status)
 Sets the EM gain. More...
 
 SIDXCameraExposeGet (integer SIDXcamera, double exposure, integer status)
 Obtain the exposure time (duration) setting. More...
 
 SIDXCameraExposeGetRange (integer SIDXcamera, double minimum, double maximum, integer status)
 Obtain the minimum and maximum exposure time duration. More...
 
 SIDXCameraExposeGetValue (integer SIDXcamera, double exposure, integer status)
 Obtain the exposure time (duration) value used by the camera. More...
 
 SIDXCameraExposeSet (integer SIDXcamera, double exposure, integer status)
 Set the exposure time. More...
 
 SIDXCameraExternalDelayGet (integer SIDXcamera, double interval, integer status)
 Obtain the time interval in seconds required by the external device between the end of an exposure and the start of the next exposure. More...
 
 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 required by the external device. More...
 
 SIDXCameraFanControlExists (integer SIDXcamera, integer available, integer status)
 Determine if fan control is available. More...
 
 SIDXCameraFanControlGet (integer SIDXcamera, integer enable, integer status)
 Obtain whether or not fan control is enabled. More...
 
 SIDXCameraFanControlSet (integer SIDXcamera, integer enable, integer status)
 Set the fan control. More...
 
 SIDXCameraGainGet (integer SIDXcamera, double gain, integer status)
 Obtain the current readout analog gain setting. More...
 
 SIDXCameraGainGetLabel (integer SIDXcamera, string label, integer status)
 Obtain the camera analog gain label as a text string. More...
 
 SIDXCameraGainGetRange (integer SIDXcamera, double minimum, double maximum, integer status)
 Obtain the analog gain minimum and maximum value. More...
 
 SIDXCameraGainGetType (integer SIDXcamera, integer type, integer status)
 Obtain the type of analog gain setting. More...
 
 SIDXCameraGainGetUnit (integer SIDXcamera, string unit, integer status)
 Obtain the camera analog gain unit as a text string. More...
 
 SIDXCameraGainGetValue (integer SIDXcamera, double gain, integer status)
 Obtain the current readout analog gain value used by the camera. More...
 
 SIDXCameraGainItemGet (integer SIDXcamera, integer index, integer status)
 Obtain the index of the gain within the gain list. More...
 
 SIDXCameraGainItemGetCount (integer SIDXcamera, integer count, integer status)
 Obtain the count of available gain settings. More...
 
 SIDXCameraGainItemGetEntry (integer SIDXcamera, integer index, double gain, integer status)
 Obtain the gain value corresponding to a specified gain list index. More...
 
 SIDXCameraGainItemGetLocal (integer SIDXcamera, integer index, string description, integer status)
 Obtain a text description of the specified gain list index. More...
 
 SIDXCameraGainItemSet (integer SIDXcamera, integer index, integer status)
 Set the analog gain according to the specified gain list index. More...
 
 SIDXCameraGainSet (integer SIDXcamera, double gain, integer status)
 Set the camera analog gain to the specified value. More...
 
 SIDXCameraGetLastError (integer SIDXcamera, string message)
 The function translates the error code into a text string. More...
 
 SIDXCameraIntensifierGet (integer SIDXcamera, double gain, integer status)
 Obtain the current intensifier setting. More...
 
 SIDXCameraIntensifierGetLabel (integer SIDXcamera, string label, integer status)
 Obtain the label for the intensifier setting. More...
 
 SIDXCameraIntensifierGetRange (integer SIDXcamera, double minimum, double maximum, integer status)
 Obtain the minimum and maximum intensifier value. More...
 
 SIDXCameraIntensifierGetType (integer SIDXcamera, integer type, integer status)
 Obtain the type of intensifier setting. More...
 
 SIDXCameraIntensifierGetUnit (integer SIDXcamera, string unit, integer status)
 Obtain the intensifier gain unit as a text string. More...
 
 SIDXCameraIntensifierGetValue (integer SIDXcamera, double gain, integer status)
 Obtain the current intensifier value. More...
 
 SIDXCameraIntensifierSet (integer SIDXcamera, double gain, integer status)
 Set the intensifier. More...
 
 SIDXCameraOperateGet (integer SIDXcamera, string value, integer status)
 Obtain the current operating mode setting as a camera-specific text string. More...
 
 SIDXCameraOperateItemGet (integer SIDXcamera, integer index, integer status)
 Obtain the current operating mode setting. More...
 
 SIDXCameraOperateItemGetCount (integer SIDXcamera, integer count, integer status)
 Obtain the count of available camera operating modes. More...
 
 SIDXCameraOperateItemGetLocal (integer SIDXcamera, integer index, string description, integer status)
 Obtain a text string description of the operating mode corresponding to the specified index. More...
 
 SIDXCameraOperateItemSet (integer SIDXcamera, integer index, integer status)
 Set the operating mode to the specified index. More...
 
 SIDXCameraOperateSet (integer SIDXcamera, string value, integer status)
 Set the current operating mode setting, using a camera-specific text string. More...
 
 SIDXCameraPollingGet (integer SIDXcamera, double interval, integer status)
 Obtain the service interval (polling interval) setting. More...
 
 SIDXCameraPollingSet (integer SIDXcamera, double interval, integer status)
 Set the service interval during Acquire. More...
 
 SIDXCameraReadoutGet (integer SIDXcamera, string value, integer status)
 Obtain the current Readout setting as a camera-specific value. More...
 
 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. More...
 
 SIDXCameraReadoutItemGet (integer SIDXcamera, integer index, integer status)
 Obtain the current Readout setting. More...
 
 SIDXCameraReadoutItemGetCount (integer SIDXcamera, integer count, integer status)
 Obtain the count of available Readout settings. More...
 
 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 specified index. More...
 
 SIDXCameraReadoutItemGetLocal (integer SIDXcamera, integer index, string description, integer status)
 Obtain a text string description of the Readout corresponding to the specified index. More...
 
 SIDXCameraReadoutItemSet (integer SIDXcamera, integer index, integer status)
 Set the Readout to the specified index. More...
 
 SIDXCameraReadoutSet (integer SIDXcamera, string value, integer status)
 Set the current Readout setting, using a camera-specific value. More...
 
 SIDXCameraROIClear (integer SIDXcamera, integer status)
 Clear the ROI (region of interest), so the entire image is acquired. More...
 
 SIDXCameraROIGet (integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status)
 Obtain the ROI setting. More...
 
 SIDXCameraROIGetValue (integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status)
 Obtain the ROI used. More...
 
 SIDXCameraROISet (integer SIDXcamera, integer x1, integer y1, integer x2, integer y2, integer status)
 Set the ROI (region of interest) for imaging. More...
 
 SIDXCameraRotateClear (integer SIDXcamera, integer status)
 Clear the rotation and mirroring settings, so acquired images are not transformed. More...
 
 SIDXCameraRotateMirrorX (integer SIDXcamera, integer status)
 Mirror the image in x. More...
 
 SIDXCameraRotateMirrorY (integer SIDXcamera, integer status)
 Mirror the image in y. More...
 
 SIDXCameraRotateSet (integer SIDXcamera, integer count, integer status)
 Set the image rotation as a count of 90 degree clockwise rotations. More...
 
 SIDXCameraShutterExists (integer SIDXcamera, integer mode, integer available, integer status)
 Determine whether a given shutter control mode is available. More...
 
 SIDXCameraShutterGet (integer SIDXcamera, integer mode, integer status)
 Obtain the current shutter control setting. More...
 
 SIDXCameraShutterSet (integer SIDXcamera, integer mode, integer status)
 Set the shutter control to the specified value. More...
 
 SIDXCameraTemperatureExists (integer SIDXcamera, integer available, integer status)
 Determine whether the camera sensor temperature is available. More...
 
 SIDXCameraTemperatureGet (integer SIDXcamera, double temperature, integer status)
 Obtain the current measured sensor temperature. More...
 
 SIDXCameraTransferRateGet (integer SIDXcamera, double transfer_rate, integer status)
 Obtain the transfer rate in bytes per second. More...
 
 SIDXCameraTransferRateSet (integer SIDXcamera, double transfer_rate, integer status)
 Set the transfer rate in bytes per second. More...
 
 SIDXCameraTriggerModeExists (integer SIDXcamera, integer mode, integer available, integer status)
 Determine whether a given trigger input control mode is available. More...
 
 SIDXCameraTriggerModeGet (integer SIDXcamera, integer mode, integer status)
 Obtain the current trigger input control setting. More...
 
 SIDXCameraTriggerModeSet (integer SIDXcamera, integer mode, integer status)
 Set the trigger input control to the specified value. More...
 
 SIDXCameraTriggerSignalExists (integer SIDXcamera, integer mode, integer available, integer status)
 Determine whether a given trigger input signal mode is available. More...
 
 SIDXCameraTriggerSignalGet (integer SIDXcamera, integer mode, integer status)
 Obtain the current trigger input signal setting. More...
 
 SIDXCameraTriggerSignalSet (integer SIDXcamera, integer mode, integer status)
 Set the trigger input signal to the specified value. More...
 
 SIDXGeometryChannelGetDepth (integer SIDXcamera, integer depth, integer status)
 Obtain the pixel depth of one channel from the image data. More...
 
 SIDXGeometryImageGetSize (integer SIDXcamera, integer size, integer status)
 Obtain the data size of an image. More...
 
 SIDXGeometryImageGetType (integer SIDXcamera, integer type, integer status)
 Obtain the image type of the source image. More...
 
 SIDXGeometryPixelGetCount (integer SIDXcamera, integer x, integer y, integer status)
 Obtain the x and y pixel count for images. More...
 
 SIDXGeometryPixelSpacingGet (integer SIDXcamera, double x, double y, integer status)
 Obtain the pixel size in x and y. More...
 

Detailed Description

File containing SIDX camera usage for reference.

Function Documentation

SIDXCameraAcquireImageGetLimit ( integer  SIDXcamera,
integer  maximum_count,
integer  status 
)

Obtain the maximum number of images that was set by ImageSetLimit.

Parameters
SIDXcameraA handle value that references the open camera context.
maximum_countA variable to receive an integer value representing the maximum number of images to be acquired.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraAcquireImageSetLimit ( integer  SIDXcamera,
integer  maximum_count,
integer  status 
)

Set the maximum number of images acquired following each call to SIDXAcquireStart.

This is a 'soft limit', the camera will acquire at least the specified number of images before stopping, but may acquire more. For most cameras, the camera acquires images continuously, and SIDX enforces the SIDXCameraAcquireImageSetLimit limit value in software when it finds that the camera has acquired at least the specified number of images.

If zero value is set, the camera will continuously acquire images until Acquire Stop or Acquire Abort is called.

Parameters
SIDXcameraA handle value that references the open camera context.
maximum_countAn integer value specifying the maximum number of images to acquire.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraAcquireOpen ( integer  SIDXcamera,
integer  SIDXacquire,
integer  status 
)

Prepare acquisition.

This operation does not start Acquire, Acquire must be started explicitly. After this operation, the camera settings cannot be changed, until Acquire closes.

Parameters
SIDXcameraA handle value that references the open camera context.
SIDXacquireA variable to receive an object that references the acquisition context and is used to aquire images.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningGet ( integer  SIDXcamera,
integer  x,
integer  y,
integer  status 
)

Obtain the x and y axis binning.

Parameters
SIDXcameraA handle value that references the open camera context.
xA variable to receive an integer value representing the x axis binning.
yA variable to receive an integer value representing the y axis binning.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningGetType ( integer  SIDXcamera,
integer  type,
integer  status 
)

Obtain the type of binning for the camera.

If the camera supports independent selection of binning on the x and y axes, the type of binning returned from the function will be 'none'. In that case, use the separate methods for the x and y axes to obtain the settable values.

Parameters
SIDXcameraA handle value that references the open camera context.
typeA variable to receive a value describing the type of binning supported for the camera. The binning type may be none or list. The binning type is never integer or real.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningItemGet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Obtain the item of the current binning selection within the binning list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexA variable to receive an integer representing the index of the current binning within the list.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningItemGetCount ( integer  SIDXcamera,
integer  count,
integer  status 
)

Obtain the total number of available (x,y) binning combinations.

This operation returns a nonzero value only for cameras that support setting the x and y bininng together as a unit. For cameras that support setting the x and y binning independently, the camera reports zero (x,y) binning combinations.

Parameters
SIDXcameraA handle value that references the open camera context.
countA variable to receive an integer count representing the number of (x,y) binning combinations. This value is zero if the camera supports setting the x and y axis binning independently.
statusNon-zero if the function failed, zero if it succeeded.
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.

Parameters
SIDXcameraA handle value that references the open camera context.
indexThe integer index of the binning selection within the list of available binning choices.
xA variable to receive an integer value representing the x axis binning.
yA variable to receive an integer value representing the y axis binning.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningItemGetLocal ( integer  SIDXcamera,
integer  index,
string  description,
integer  status 
)

Obtain a text string description of the specified binning setting.

Parameters
SIDXcameraA handle value that references the open camera context.
indexThe integer index of the binning selection within the list of available binning choices.
descriptionA variable to receive a text string description of the specified binning list entry.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningItemSet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Set the binning to the specified index within the binning list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexThe integer index of the binning selection within the list of available binning choices.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningSet ( integer  SIDXcamera,
integer  x,
integer  y,
integer  status 
)

Set the binning as binning x and y factors.

The specific x and y binning combination must be supported by the camera.

Parameters
SIDXcameraA handle value that references the open camera context.
xAn integer value that specifies the x axis binning. For example, a value of 2 specifies 2:1 x axis binning, that is, each 2 x axis sensor pixels (columns) are binned and read out as 1 x axis column.
yAn integer value that specifes the y axis binning. For example, a value of 4 specifies 4:1 y axis binning, that is, each 4 y axis sensor pixels (rows) are binned and read out as 1 y axis row.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningXGetLimit ( integer  SIDXcamera,
integer  maximum,
integer  status 
)

Obtain the largest x axis binning ratio.

Use BinningSet to set a value within the limits for the x coordinate.

Parameters
SIDXcameraA handle value that references the open camera context.
maximumA variable to receive an integer value representing the maximum x axis binning ratio. This value is 1 or greater.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningXGetType ( integer  SIDXcamera,
integer  type,
integer  status 
)

Obtain the type of binning selection available for the x axis.

The x axis binning type is 'none' if the x and y axis binning interacts and must be set together. If the x axis binning value can be obtained independently, the x axis binning type is not 'none'.

Parameters
SIDXcameraA handle value that references the open camera context.
typeA variable to receive a value describing the type of binning available. The x axis binning type may be none, list, or integer. The x axis binning type is never a real.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningXItemGetCount ( integer  SIDXcamera,
integer  count,
integer  status 
)

Obtain the count of available x axis binning settings.

This method is valid only if the x axis binning type is a list.

Parameters
SIDXcameraA handle value that references the open camera context.
countA variable to receive an integer count representing the number of available x axis binning settings.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningXItemGetEntry ( integer  SIDXcamera,
integer  index,
integer  binning,
integer  status 
)

Obtain the x axis binning ratio for the specified list index.

This method is valid only if the x axis binning type is a list. Use BinningSet to set the entry value returned for the x coordinate.

Parameters
SIDXcameraA handle value that references the open camera context.
indexThe integer index of the x axis binning selection within the list of available x axis binning choices.
binningA variable to receive an integer representing the binning ratio. This value is 1 or greater.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningXItemGetLocal ( integer  SIDXcamera,
integer  index,
string  description,
integer  status 
)

Obtain a text description of the x axis binning ratio for the specified list index.

This method is valid only if the x axis binning type is a list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexThe integer index of the x axis binning selection within the list of available x axis binning choices.
descriptionA variable to receive a text string description the binning ratio.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBinningYGetLimit ( integer  SIDXcamera,
integer  maximum,
integer  status 
)

Obtain the maximum y axis binning ratio.

The y axis binning ratio can be determined independently of the x axis binning ratio only if the x axis binning type is not 'none'. If the y axis binning ratio can be determined independently, the y axis binning value range is always 1 to the maximum value. Use BinningSet to set a value within the limits for the y coordinate.

Parameters
SIDXcameraA handle value that references the open camera context.
maximumA variable to receive an integer value representing the maximum y axis binning ratio. This value is 1 or greater.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBufferCountGet ( integer  SIDXcamera,
integer  count,
integer  status 
)

Obtain the image buffer count setting.

The actual image buffer count may differ from the setting.

Parameters
SIDXcameraA handle value that references the open camera context.
countA variable to receive an integer value representing the image buffer count setting, as a number of sensor images.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraBufferCountSet ( integer  SIDXcamera,
integer  count,
integer  status 
)

Set the minimum number of sensor images to buffer during Acquire.

SIDX sets the default sensor image count value to 50.

Parameters
SIDXcameraA handle value that references the open camera context.
countAn integer value specifying the minimum image buffer size, in units of sensor images.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraClose ( integer  SIDXcamera,
integer  status 
)

Close the camera.

After this call, the camera is no longer valid.

Parameters
SIDXcameraA handle value that references the open camera context.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraCoolingGet ( integer  SIDXcamera,
double  temperature,
integer  status 
)

Obtain the image sensor target temperature.

Parameters
SIDXcameraA handle value that references the open camera context.
temperatureA variable to receive a real (floating-point) value representing the image sensor target temperature setting, in degrees Celsius.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraCoolingGetControl ( integer  SIDXcamera,
integer  control,
integer  status 
)

Obtain the type of image sensor temperature control and monitoring available.

Parameters
SIDXcameraA handle value that references the open camera context.
controlA variable to receive a value describing the image sensor temperature control type.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraCoolingGetRange ( integer  SIDXcamera,
double  minimum,
double  maximum,
integer  status 
)

Obtain the minimum and maximum temperature setting.

This is not the limits of the sensor temperature, it is the limits of the temperature to which the sensor temperature control can be set.

Parameters
SIDXcameraA handle value that references the open camera context.
minimumA variable to receive a real (floating point) value representing the minimum limit in degrees Celsius.
maximumA variable to receive a real (floating point) value representing the maximum limit in degrees Celsius.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraCoolingGetValue ( integer  SIDXcamera,
double  temperature,
integer  status 
)

Obtain the image sensor temperature.

Parameters
SIDXcameraA handle value that references the open camera context.
temperatureA variable to receive a real (floating-point) value representing the image sensor temperature in degrees Celsius.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraCoolingSet ( integer  SIDXcamera,
double  temperature,
integer  status 
)

Set the image sensor target temperature.

SIDX uses a value valid for the camera that is closest to the setting. Use 'get value' to determine the actual value that is set.

Parameters
SIDXcameraA handle value that references the open camera context.
temperatureA real (floating-point) value that specifies the target temperature in degrees Celsius.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainGet ( integer  SIDXcamera,
integer  gain,
integer  status 
)

Obtain the current EM gain setting.

For most cameras with EM gain, the EM gain value is nominal, not an actual gain. The greater the EM gain value, the greater the corresponding gain.

Parameters
SIDXcameraA handle value that references the open camera context.
gainA variable to receive an integer value representing the current EM gain setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainGetLabel ( integer  SIDXcamera,
string  label,
integer  status 
)

Obtain the label of the EM gain as a text string.

Parameters
SIDXcameraA handle value that references the open camera context.
labelA variable to receive a text string representing the EM gain label.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainGetRange ( integer  SIDXcamera,
integer  minimum,
integer  maximum,
integer  status 
)

Obtain the minimum and maximum EM gain value.

Parameters
SIDXcameraA handle value that references the open camera context.
minimumA variable to receive an integer value representing the minimum limit.
maximumA variable to receive an integer value representing the maximum limit.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainGetType ( integer  SIDXcamera,
integer  type,
integer  status 
)

Obtain the type of EM gain setting.

The EM gain setting type is one of none, integer, or list.

Parameters
SIDXcameraA handle value that references the open camera context.
typeA variable to receive a value describing the type of EM gain available. The EM gain setting type is one of none, integer, or list. The EM gain setting type is never real, but this could change in the future.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainGetUnit ( integer  SIDXcamera,
string  unit,
integer  status 
)

Obtain the unit of the EM gain as a text string.

Parameters
SIDXcameraA handle value that references the open camera context.
unitA variable to receive a text string representing the EM gain unit. If the EM gain is dimensionless, this text string may be blank.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainGetValue ( integer  SIDXcamera,
integer  gain,
integer  status 
)

Obtain the current EM gain value.

For most cameras with EM gain, the EM gain value is nominal, not an actual gain. The greater the EM gain value, the greater the corresponding gain.

Parameters
SIDXcameraA handle value that references the open camera context.
gainA variable to receive an integer value representing the current EM gain value.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainItemGet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Obtain the index of the EM gain within the gain list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexA variable to receive an integer value representing the current EM gain index within the list.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainItemGetCount ( integer  SIDXcamera,
integer  count,
integer  status 
)

Obtain the count of available EM gain settings.

This operation is valid only if the EM gain type is a list.

Parameters
SIDXcameraA handle value that references the open camera context.
countA variable to receive an integer value representing the count of available EM gain settings.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainItemGetEntry ( integer  SIDXcamera,
integer  index,
integer  gain,
integer  status 
)

Obtain the EM gain value corresponding to an index within the list.

This operation is valid only if the EM gain type is a list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the EM gain selection within the list of available EM gain values. The first entry in the list has index zero.
gainA variable to receive an integer value representing the EM gain value corresponding to the index within the list.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainItemGetLocal ( integer  SIDXcamera,
integer  index,
string  description,
integer  status 
)

Obtain a text string description of the EM gain value corresponding to the specified index.

This operation is valid only if the EM gain type is a list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the EM gain selection within the list of available EM gain values. The first entry in the list has index zero.
descriptionA variable to receive a text string description of the gain value.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainItemSet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Set the EM gain to a value corresponding to an index within the list.

This operation is valid only if the EM gain type is a list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the EM gain selection within the list of available EM gain values. The first entry in the list has index zero.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraEMGainSet ( integer  SIDXcamera,
integer  gain,
integer  status 
)

Sets the EM gain.

Parameters
SIDXcameraA handle value that references the open camera context.
gainAn integer value specifying the camera EM gain value to use. This EM gain value must be valid for the camera. The EM gain value is not the actual gain. For example, an EM gain of 4 is a higher gain than an EM gain of 2, but the actual amplification ratio of the two settings may or may not be 4:2.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraExposeGet ( integer  SIDXcamera,
double  exposure,
integer  status 
)

Obtain the exposure time (duration) setting.

Parameters
SIDXcameraA handle value that references the open camera context.
exposureA variable to receive a real (floating-point) value representing the current exposure duration setting, expressed in seconds.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraExposeGetRange ( integer  SIDXcamera,
double  minimum,
double  maximum,
integer  status 
)

Obtain the minimum and maximum exposure time duration.

Note that the limits of the exposure time can change based on camera settings.

Parameters
SIDXcameraA handle value that references the open camera context.
minimumA variable to receive a real (floating point) value representing the minimum limit, expressed in seconds.
maximumA variable to receive a real (floating point) value representing the maximum limit, expressed in seconds.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraExposeGetValue ( integer  SIDXcamera,
double  exposure,
integer  status 
)

Obtain the exposure time (duration) value used by the camera.

Parameters
SIDXcameraA handle value that references the open camera context.
exposureA variable to receive a real (floating-point) value representing the current exposure time duration used by the camera, expressed in seconds.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraExposeSet ( integer  SIDXcamera,
double  exposure,
integer  status 
)

Set the exposure time.

If the exposure time is set to a value less than the minimum, or greater than the maximum, the exposure time used will be limited to the exposure time minimum or maximum value.

Parameters
SIDXcameraA handle value that references the open camera context.
exposureA real (floating-point) value containing the exposure duration, in seconds. This value must be greater than zero.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraExternalDelayGet ( integer  SIDXcamera,
double  interval,
integer  status 
)

Obtain the time interval in seconds required by the external device between the end of an exposure and the start of the next exposure.

This is the minimum delay, the actual delay may be longer, depending on the camera.

Parameters
SIDXcameraA handle value that references the open camera context.
intervalA variable to receive a real (floating-point) value specifying external time interval delay in seconds.
statusNon-zero if the function failed, zero if it succeeded.
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 required by the external device.

If the external delay is not set, the default is zero.

Parameters
SIDXcameraA handle value that references the open camera context.
intervalA real (floating-point) value specifying the external time interval delay in seconds.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraFanControlExists ( integer  SIDXcamera,
integer  available,
integer  status 
)

Determine if fan control is available.

Parameters
SIDXcameraA handle value that references the open camera context.
availableA variable to receive a boolean value, true if computer-based fan control is available, false if not.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraFanControlGet ( integer  SIDXcamera,
integer  enable,
integer  status 
)

Obtain whether or not fan control is enabled.

This operation will report an error if the camera does not have computer-based fan control.

Parameters
SIDXcameraA handle value that references the open camera context.
enableA variable to receive a boolean value, true to enable the fan, false to disable the fan.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraFanControlSet ( integer  SIDXcamera,
integer  enable,
integer  status 
)

Set the fan control.

This operation will report an error if the camera does not have computerbased fan control. If the fan control is enabled, the fan may turn on for cooling. If the fan control is disabled, the fan is prevented from turning on.

Parameters
SIDXcameraA handle value that references the open camera context.
enableA variable to receive a boolean value, true to enable the fan, false to disable the fan.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainGet ( integer  SIDXcamera,
double  gain,
integer  status 
)

Obtain the current readout analog gain setting.

Parameters
SIDXcameraA handle value that references the open camera context.
gainA variable to receive a real (floating-point) value representing the analog gain setting. This setting is always greater than zero. If the camera does not have an analog gain setting, this value is 1.0.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainGetLabel ( integer  SIDXcamera,
string  label,
integer  status 
)

Obtain the camera analog gain label as a text string.

The label is independent of the gain value, for example, it might be the string "Gain".

Parameters
SIDXcameraA handle value that references the open camera context.
labelA variable to receive a text string representing the label for the analog gain.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainGetRange ( integer  SIDXcamera,
double  minimum,
double  maximum,
integer  status 
)

Obtain the analog gain minimum and maximum value.

Parameters
SIDXcameraA handle value that references the open camera context.
minimumA variable to receive a real (floating point) value representing the minimum limit.
maximumA variable to receive a real (floating point) value representing the maximum limit.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainGetType ( integer  SIDXcamera,
integer  type,
integer  status 
)

Obtain the type of analog gain setting.

Parameters
SIDXcameraA handle value that references the open camera context.
typeA variable to receive a value describing the type of analog gain available. The type is one of none, list, or real. The type is never integer.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainGetUnit ( integer  SIDXcamera,
string  unit,
integer  status 
)

Obtain the camera analog gain unit as a text string.

The unit is independent of the gain value.

Parameters
SIDXcameraA handle value that references the open camera context.
unitA variable to receive a text string representing the unit for the analog gain. If the gain is dimensionless, this string may be empty.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainGetValue ( integer  SIDXcamera,
double  gain,
integer  status 
)

Obtain the current readout analog gain value used by the camera.

Parameters
SIDXcameraA handle value that references the open camera context.
gainA variable to receive a real (floating-point) value representing the analog gain value. This value is always greater than zero. If the camera does not have an analog gain setting, this value is 1.0.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainItemGet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Obtain the index of the gain within the gain list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexA variable to receive an integer value representing the index of the gain within the list of analog gains.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainItemGetCount ( integer  SIDXcamera,
integer  count,
integer  status 
)

Obtain the count of available gain settings.

This operation is valid only if the gain type is list.

Parameters
SIDXcameraA handle value that references the open camera context.
countA variable to receive an integer representing the count of available gain settings.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainItemGetEntry ( integer  SIDXcamera,
integer  index,
double  gain,
integer  status 
)

Obtain the gain value corresponding to a specified gain list index.

This operation is valid only if the gain type is list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the gain selection within the list of available gain values. The first entry in the list has index zero.
gainA variable to receive a real (floating-point) value representing the gain. This value is always greater than zero.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainItemGetLocal ( integer  SIDXcamera,
integer  index,
string  description,
integer  status 
)

Obtain a text description of the specified gain list index.

This operation is valid only if the gain type is list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the gain selection within the list of available gain values. The first entry in the list has index zero.
descriptionA variable to receive a text string description of the gain.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainItemSet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Set the analog gain according to the specified gain list index.

This operation is valid only if the gain type is list.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the gain selection within the list of available gain values. The first entry in the list has index zero.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGainSet ( integer  SIDXcamera,
double  gain,
integer  status 
)

Set the camera analog gain to the specified value.

Parameters
SIDXcameraA handle value that references the open camera context.
gainA real (floating-point) value specifying the camera analog gain value to use. This analog gain value must be valid for the camera.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraGetLastError ( integer  SIDXcamera,
string  message 
)

The function translates the error code into a text string.

Parameters
SIDXcameraA handle value that references the open camera context.
messageA text string to receive the text associated with the last error occurred.
SIDXCameraIntensifierGet ( integer  SIDXcamera,
double  gain,
integer  status 
)

Obtain the current intensifier setting.

Parameters
SIDXcameraA handle value that references the open camera context.
gainA variable to receive a real (floating-point) value representing the intensifier gain setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraIntensifierGetLabel ( integer  SIDXcamera,
string  label,
integer  status 
)

Obtain the label for the intensifier setting.

Parameters
SIDXcameraA handle value that references the open camera context.
labelA variable to receive a text string representing the intensifier setting label.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraIntensifierGetRange ( integer  SIDXcamera,
double  minimum,
double  maximum,
integer  status 
)

Obtain the minimum and maximum intensifier value.

Parameters
SIDXcameraA handle value that references the open camera context.
minimumA variable to receive a real (floating point) value representing the minimum limit.
maximumA variable to receive a real (floating point) value representing the maximum limit.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraIntensifierGetType ( integer  SIDXcamera,
integer  type,
integer  status 
)

Obtain the type of intensifier setting.

Parameters
SIDXcameraA handle value that references the open camera context.
typeA variable to receive a value describing the type of intensifier gain setting. The intensifier gain type is none or real. The intensifier gain type is never list or integer.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraIntensifierGetUnit ( integer  SIDXcamera,
string  unit,
integer  status 
)

Obtain the intensifier gain unit as a text string.

Parameters
SIDXcameraA handle value that references the open camera context.
unitA variable to receive a text string representing the intensifier gain unit. The intensifier gain may be dimensionless, in which case this text string may be blank.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraIntensifierGetValue ( integer  SIDXcamera,
double  gain,
integer  status 
)

Obtain the current intensifier value.

Parameters
SIDXcameraA handle value that references the open camera context.
gainA variable to receive a real (floating-point) value representing the intensifier gain value.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraIntensifierSet ( integer  SIDXcamera,
double  gain,
integer  status 
)

Set the intensifier.

Parameters
SIDXcameraA handle value that references the open camera context.
gainA real (floating-point) value specifying the intensifier gain. The value must be a valid intensifier gain setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraOperateGet ( integer  SIDXcamera,
string  value,
integer  status 
)

Obtain the current operating mode setting as a camera-specific text string.

Parameters
SIDXcameraA handle value that references the open camera context.
valueA variable to receive a text string value representing the operating mode setting. It is possible to restore the camera to the same setting later by setting the camera to this value.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraOperateItemGet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Obtain the current operating mode setting.

Parameters
SIDXcameraA handle value that references the open camera context.
indexA variable to receive an integer index representing the operating mode setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraOperateItemGetCount ( integer  SIDXcamera,
integer  count,
integer  status 
)

Obtain the count of available camera operating modes.

The result is one (1) if the camera offers only one Operate mode, that is, no choice of Operate mode.

Parameters
SIDXcameraA handle value that references the open camera context.
countA variable to receive an integer value representing the count of available operating mode settings.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraOperateItemGetLocal ( integer  SIDXcamera,
integer  index,
string  description,
integer  status 
)

Obtain a text string description of the operating mode corresponding to the specified index.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the operating mode selection within the list of available operating mode values. The first entry has index zero.
descriptionA variable to receive a text string description of the operating mode.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraOperateItemSet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Set the operating mode to the specified index.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the operating mode. The first operating mode has the index value zero (0, integer status);
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraOperateSet ( integer  SIDXcamera,
string  value,
integer  status 
)

Set the current operating mode setting, using a camera-specific text string.

When the caller sets the operation mode, all other parameters are reset to their default values. For example, the readout mode will be reset to the value that represents the slowest readout rate for the highest pixel depth.

Parameters
SIDXcameraA handle value that references the open camera context.
valueThe text string operating mode value to set. The value operating mode must be valid for the camera. The value is camera-specific.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraPollingGet ( integer  SIDXcamera,
double  interval,
integer  status 
)

Obtain the service interval (polling interval) setting.

Parameters
SIDXcameraA handle value that references the open camera context.
intervalA variable to receive a real (floating-point) value representing the service interval setting, in seconds.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraPollingSet ( integer  SIDXcamera,
double  interval,
integer  status 
)

Set the service interval during Acquire.

The service interval is the maximum time between calls to the Acquire 'GetStatus' operation. The longer the service interval, the larger the buffer needed to hold images during Acquire. In some cases, the actual maximum service interval may differ significantly from the setting. SIDX sets the default polling value to 1 second.

Parameters
SIDXcameraA handle value that references the open camera context.
intervalA real (floating-point) value specifying the service interval, in seconds.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraReadoutGet ( integer  SIDXcamera,
string  value,
integer  status 
)

Obtain the current Readout setting as a camera-specific value.

Parameters
SIDXcameraA handle value that references the open camera context.
valueA variable to receive a text string value representing the setting. The value is camera-specific, the same value may represent a different setting on different cameras. However, the value should be consistent, so it should be possible restore the camera to the same setting later by setting the camera to this value.
statusNon-zero if the function failed, zero if it succeeded.
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.

Parameters
SIDXcameraA handle value that references the open camera context.
pixel_rateA variable to receive a real (floating-point) value representing the nominal pixel readout rate of images acquired using the readout, measured in Hz. For example, if the pixel readout rate is 10MHz, this value is 10 million (1.0e+7)
pixel_depthA variable to receive an integer value representing the pixel depth of images acquired using the readout, measured in bits.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraReadoutItemGet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Obtain the current Readout setting.

Parameters
SIDXcameraA handle value that references the open camera context.
indexA variable to receive an integer index representing the Readout setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraReadoutItemGetCount ( integer  SIDXcamera,
integer  count,
integer  status 
)

Obtain the count of available Readout settings.

The result is one (1) if the camera offers only one Readout, that is, no choice of Readout. If the camera offers a choice of Readout, then ReadoutItem zero (0) generally produces the highest-quality images, and the highest-numbered Readout generally produces images at the highest speed.

Parameters
SIDXcameraA handle value that references the open camera context.
countA variable to receive an integer value representing the count of available Readout settings.
statusNon-zero if the function failed, zero if it succeeded.
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 specified index.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the Readout selection within the list of available Readout values. The first entry has index zero.
pixel_rateA variable to receive a real (floating-point) value representing the nominal pixel readout rate of images acquired using the readout, measured in Hz. For example, if the pixel readout rate is 10MHz, this value is 10 million (1.0e+7)
pixel_depthA variable to receive an integer value representing the pixel depth of images acquired using the readout, measured in bits.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraReadoutItemGetLocal ( integer  SIDXcamera,
integer  index,
string  description,
integer  status 
)

Obtain a text string description of the Readout corresponding to the specified index.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the Readout selection within the list of available Readout values. The first entry has index zero.
descriptionA variable to receive a text string description of the Readout.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraReadoutItemSet ( integer  SIDXcamera,
integer  index,
integer  status 
)

Set the Readout to the specified index.

Parameters
SIDXcameraA handle value that references the open camera context.
indexAn integer index of the Readout. The first Readout has the index value zero (0, integer status);
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraReadoutSet ( integer  SIDXcamera,
string  value,
integer  status 
)

Set the current Readout setting, using a camera-specific value.

The available Readout modes are dependent on the Operate mode that is set. The default Readout mode is the one that provides the slowest readout rate for the highest pixel depth.

Parameters
SIDXcameraA handle value that references the open camera context.
valueThe text string value to set. The Readout setting value must be valid for the camera. The value is camera-specific.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraROIClear ( integer  SIDXcamera,
integer  status 
)

Clear the ROI (region of interest), so the entire image is acquired.

Parameters
SIDXcameraA handle value that references the open camera context.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraROIGet ( integer  SIDXcamera,
integer  x1,
integer  y1,
integer  x2,
integer  y2,
integer  status 
)

Obtain the ROI setting.

Parameters
SIDXcameraA handle value that references the open camera context.
x1A variable to receive an integer value representing the x1 value, that is, the left side of the region in pixel index. The value zero represents the left most pixel.
y1A variable to receive an integer value representing the y1 value, that is, the top of the region in pixel index. The value zero represents the top most pixel.
x2A variable to receive an integer value representing the x2 value, that is, the right side of the region in pixel index. The value zero represents the left most pixel.
y2A variable to receive an integer value representing the y2 value, that is, the bottom of the region in pixel index. The value zero represents the top most pixel.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraROIGetValue ( integer  SIDXcamera,
integer  x1,
integer  y1,
integer  x2,
integer  y2,
integer  status 
)

Obtain the ROI used.

The ROI used may be larger than the ROI setting, if the camera imposes restrictions on the ROI. For example, if the camera requires that the ROI x position and x width be multiples of 4, an ROI that begins at x position 5 will be adjusted to begin at 4.

Parameters
SIDXcameraA handle value that references the open camera context.
x1A variable to receive an integer value representing the x1 value, that is, the left side of the region.
y1A variable to receive an integer value representing the y1 value, that is, the top of the region.
x2A variable to receive an integer value representing the x2 value, that is, the right side of the region.
y2A variable to receive an integer value representing the y2 value, that is, the bottom of the region.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraROISet ( integer  SIDXcamera,
integer  x1,
integer  y1,
integer  x2,
integer  y2,
integer  status 
)

Set the ROI (region of interest) for imaging.

The ROI is specified in sensor coordinates, not binned coordinates. For example, if a 1000x1000 sensor is binned 4x4 to yield a 250x250 image, the ROI is interpreted in the 1000x1000 sensor coordinates, not the 250x250 binned coordinates.

Parameters
SIDXcameraA handle value that references the open camera context.
x1An integer value specifying the left-side x coordinate. The x coordinate is measured from left to right.
y1An integer value specifying the y coordinate. The y coordinate is measured from top to bottom.
x2An integer value specifying the right-side x coordinate. The x coordinate is measured from left to right. The region width in pixels is x2-x1, so the region excludes the x2 column.
y2An integer value specifying the bottom y coordinate. The y coordinate is measured from top to bottom. The region height in pixels is y2-y1, so the region excludes the y2 row.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraRotateClear ( integer  SIDXcamera,
integer  status 
)

Clear the rotation and mirroring settings, so acquired images are not transformed.

Parameters
SIDXcameraA handle value that references the open camera context.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraRotateMirrorX ( integer  SIDXcamera,
integer  status 
)

Mirror the image in x.

Calls to this method are cumulative, so two successive calls result in no mirroring. The mirroring and rotation calls operate in sequence. Calling RotateSet followed RotateMirrorX rotates the image, then mirrors the image. Calling RotateMirrorX then RotateSet mirrors the image, then rotates the image.

Parameters
SIDXcameraA handle value that references the open camera context.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraRotateMirrorY ( integer  SIDXcamera,
integer  status 
)

Mirror the image in y.

Calls to this method are cumulative, so two successive calls result in no mirroring. The mirroring and rotation calls operate in sequence. Calling RotateSet followed RotateMirrorY rotates the image, then mirrors the image. Calling RotateMirrorY then RotateSet mirrors the image, then rotates the image.

Parameters
SIDXcameraA handle value that references the open camera context.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraRotateSet ( integer  SIDXcamera,
integer  count,
integer  status 
)

Set the image rotation as a count of 90 degree clockwise rotations.

For example, a 90 degree clockwise rotation is 1, a 90 degree counter-clockwise rotation is -1, and a 360 degree rotation is 4. Rotations are cumulative, so successive calls add. For example, four calls each with a rotation count of 1 produce a rotation count of 4.

Parameters
SIDXcameraA handle value that references the open camera context.
countAn integer value specifying the image rotation as a signed count of 90 degree clockwise rotations.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraShutterExists ( integer  SIDXcamera,
integer  mode,
integer  available,
integer  status 
)

Determine whether a given shutter control mode is available.

Parameters
SIDXcameraA handle value that references the open camera context.
modeA value describing the shutter control mode value to test.
availableA variable to receive a boolean value, true if the shutter control mode is available, false if the shutter control mode is not available.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraShutterGet ( integer  SIDXcamera,
integer  mode,
integer  status 
)

Obtain the current shutter control setting.

Parameters
SIDXcameraA handle value that references the open camera context.
modeA variable to receive a value describing the current shutter control setting mode.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraShutterSet ( integer  SIDXcamera,
integer  mode,
integer  status 
)

Set the shutter control to the specified value.

Parameters
SIDXcameraA handle value that references the open camera context.
modeA value describing the shutter control mode to use.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTemperatureExists ( integer  SIDXcamera,
integer  available,
integer  status 
)

Determine whether the camera sensor temperature is available.

Parameters
SIDXcameraA handle value that references the open camera context.
availableA variable to receive a boolean value, true if the sensor temperature is available, false if the sensor temperature is not available.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTemperatureGet ( integer  SIDXcamera,
double  temperature,
integer  status 
)

Obtain the current measured sensor temperature.

Parameters
SIDXcameraA handle value that references the open camera context.
temperatureA variable to receive a real (floating-point) value representing the temperature of the sensor, in degree Celsius.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTransferRateGet ( integer  SIDXcamera,
double  transfer_rate,
integer  status 
)

Obtain the transfer rate in bytes per second.

Parameters
SIDXcameraA handle value that references the open camera context.
transfer_rateA variable to receive a real (floating-point) value specifying the tranfer rate in bytes per second.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTransferRateSet ( integer  SIDXcamera,
double  transfer_rate,
integer  status 
)

Set the transfer rate in bytes per second.

This parameter is used to calculate the time required to transfer an image from the camera to the computer. If the value is not set, the default transfer rate is zero (0).

Parameters
SIDXcameraA handle value that references the open camera context.
transfer_rateA real (floating-point) value specifying the transfer rate in bytes per second.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTriggerModeExists ( integer  SIDXcamera,
integer  mode,
integer  available,
integer  status 
)

Determine whether a given trigger input control mode is available.

Parameters
SIDXcameraA handle value that references the open camera context.
modeThe trigger input control mode to test.
availableA variable to receive a boolean value, true if the trigger input control mode is available, false if the trigger input control mode is not available.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTriggerModeGet ( integer  SIDXcamera,
integer  mode,
integer  status 
)

Obtain the current trigger input control setting.

Parameters
SIDXcameraA handle value that references the open camera context.
modeA variable to receive a value describing the current trigger input control setting mode.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTriggerModeSet ( integer  SIDXcamera,
integer  mode,
integer  status 
)

Set the trigger input control to the specified value.

Parameters
SIDXcameraA handle value that references the open camera context.
modeA value describing the trigger input control value to use.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTriggerSignalExists ( integer  SIDXcamera,
integer  mode,
integer  available,
integer  status 
)

Determine whether a given trigger input signal mode is available.

Parameters
SIDXcameraA handle value that references the open camera context.
modeThe trigger input signal mode to test.
availableA variable to receive a boolean value, true if the trigger input signal mode is available, false if the trigger input signal mode is not available.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTriggerSignalGet ( integer  SIDXcamera,
integer  mode,
integer  status 
)

Obtain the current trigger input signal setting.

Parameters
SIDXcameraA handle value that references the open camera context.
modeA variable to receive a value describing the current trigger input signal setting mode.
statusNon-zero if the function failed, zero if it succeeded.
SIDXCameraTriggerSignalSet ( integer  SIDXcamera,
integer  mode,
integer  status 
)

Set the trigger input signal to the specified value.

Parameters
SIDXcameraA handle value that references the open camera context.
modeA value describing the trigger input signal value to use.
statusNon-zero if the function failed, zero if it succeeded.
SIDXGeometryChannelGetDepth ( integer  SIDXcamera,
integer  depth,
integer  status 
)

Obtain the pixel depth of one channel from the image data.

For grayscale image, there is one channel. For RGB image, there are three channels which represent red, green and blue respectively.

Parameters
SIDXcameraA handle value that references the open camera context.
depthA variable to receive an integer value representing the channel depth in bit.
statusNon-zero if the function failed, zero if it succeeded.
SIDXGeometryImageGetSize ( integer  SIDXcamera,
integer  size,
integer  status 
)

Obtain the data size of an image.

The data size of an image is the size of the data in an image, excluding any padding.

Parameters
SIDXcameraA handle value that references the open camera context.
sizeA variable to receive an integer value representing the size of the data in an image, measured in bytes.
statusNon-zero if the function failed, zero if it succeeded.
SIDXGeometryImageGetType ( integer  SIDXcamera,
integer  type,
integer  status 
)

Obtain the image type of the source image.

Parameters
SIDXcameraA handle value that references the open camera context.
typeA variable to receive a value describing the type of source image.
statusNon-zero if the function failed, zero if it succeeded.
SIDXGeometryPixelGetCount ( integer  SIDXcamera,
integer  x,
integer  y,
integer  status 
)

Obtain the x and y pixel count for images.

Parameters
SIDXcameraA handle value that references the open camera context.
xA variable to receive an integer value representing the pixel count on the x axis.
yA variable to receive an integer value representing the pixel count on the y axis.
statusNon-zero if the function failed, zero if it succeeded.
SIDXGeometryPixelSpacingGet ( integer  SIDXcamera,
double  x,
double  y,
integer  status 
)

Obtain the pixel size in x and y.

Parameters
SIDXcameraA handle value that references the open camera context.
xA variable to receive a real (floating point) value representing the horizontal pixel spacing, measured in meters.
yA variable to receive a real (floating point) value representing the vertical pixel spacing, measured in meters.
statusNon-zero if the function failed, zero if it succeeded.