User`s guide

FUNCTIONS

SDK SECTION 11

Page 201

SetCropMode

unsigned int WINAPI SetCropMode (int active, int cropHeight, int reserved)

Description

This function effectively reduces the height of the CCD by excluding some rows to

achieve higher frame rates. This is currently only available on Newton cameras when the

selected read mode is Full Vertical Binning. The cropHeight is the number of active rows

measured from the bottom of the CCD.

Note: it is important to ensure that no light falls on the excluded region otherwise the

acquired data will be corrupted.

Parameters

int active: 1 - Crop mode is ON

0 – Crop mode is OFF

int cropHeight: The selected crop height. This value must be between 1 and the CCD

height

int reserved: This value should be set to 0.

Return

unsigned int

DRV_SUCCESS

DRV_NOT_INITIAILIZED

DRV_ACQUIRING

DRV_P1INVALID

DRV_P2INVALID

DRV_P3INVALID

DRV_NOT_SUPPORTED

Parameters set.

System not initialized.

Acquisition in progress.

Active parameter is not zero or one.

Cropheight parameter is less than one or greater than

the CCD height.

Reserved parameter is not equal to zero.

Either the camera is not a Newton or the read mode is

not Full Vertical Binning.