Bruxton Logo

SIDXROIClear

Syntax

C/C++

int SIDXROIClear(void* camera);

Visual Basic

Function SIDXROIClear (ByVal camera As Long) As Long

IGOR Pro

SIDXROIClear camera, status

ITT IDL

status = SIDXROIClear(camera)

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.

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

Discussion

Use this function to reset the ROI definition in SIDX to the CCD full frame. For Spectral Instruments cameras, the function resets the ROI definition in SIDX to the serial and parallel register size which may be set as half of the CCD dimension for the multiple ports readout. When working with Spectral Instruments camera, it is recommended that you always specify the ROI using SIDXROISet