Bruxton Logo

SIDXROISet

Syntax

C/C++

int SIDXROISet(void* camera, int x1, int y1, int x2, int y2);

Visual Basic

Function SIDXROISet (ByVal camera As Long, ByVal x1 As Long, ByVal y1 As Long, ByVal x2 As Long, ByVal y2 As Long) As Long

IGOR Pro

SIDXROISet camera, x1, y1, x2, y2, status

ITT IDL

status = SIDXROISet(camera, x1, y1, x2, y2)

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.
x1
The x coordinate of the top-left corner of an ROI, starting from 0.
y1
The y coordinate of the top-left corner of an ROI, starting from 0.
x2
The x coordinate of the bottom-right corner of an ROI, starting from 0.
y2
The y coordinate of the bottom-right corner of an ROI, starting from 0.

The return value is non-zero if the function failed, zero if it succeeded.

Discussion

The ROI dimension is the dimension before binning. Use this function to specify additional ROIs. Each time the function is called and returns successfully, a new ROI is added in the sequence. Depending on the type of the camera, the acquired frame size may be equal or less than the ROI dimension specified in the function to meet the camera binning process requirement. Please use function SIDXAcquisitionGetSize to obtain the actual frame dimension acquired.

For Spectral Instruments cameras, see Camera notes for Spectral Instruments for more details in setting ROI.