THORLABS DCU223x User Manual

© 2013 Thorlabs GmbH
4 Programming (SDK)
267
4.3.59 is_ImageFormat
USB 2.0
USB 3.0
USB 2.0
USB 3.0
Syntax
INT is_ImageFormat (HIDS hCam,
UINT nCommand,
void *pParam,
UINT nSizeOfParam)
Description
Using is_ImageFormat(), you can query a list of possible image sizes and set a new image format if supported
by your DCx Camera model. This is useful for sensors that do not support a free selection of the area of interest or
image format. Using the AOI, binning/subsampling or scaling functions, the driver sets the selected image format to
achieve the best possible image quality. For a complete list of available image formats see table "Image formats"
below.
The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the
selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a
variable of the UINT type. The size of the memory area to which pParam refers is specified in the nSizeOfParam
input parameter.
Input parameters
hCam
Camera handle
nCommand
IMGFRMT_CMD_GET_LIST
Returns a list of all image formats supported by the
sensor.
More details
You can query the number of entries in the list with
IMGFRMT_CMD_GET_NUM_ENTRIES.
pParam: Pointer to list of type IMAGE_FORMAT_LIST
. The list must be preallocated as specified below.
nSizeOfParam: Size of the list
Size of (IMAGE_FORMAT_LIST + (number of list entries
- 1) *
Size of (IMAGE_FORMAT_INFO))
IMGFRMT_CMD_GET_NUM_ENTRIES
Returns the number of entries in the list.
More details
pParam: Pointer to variable of type UINT returning the
number of list entries.
nSizeOfParam: 4
IMGFRMT_CMD_SET_FORMAT
Sets the desired image format.
More details
pParam: Pointer to variable of type UINT passing the
format ID of the desired image format.
nSizeOfParam: 4
IMGFRMT_CMD_GET_ARBITRARY_AOI_SUPPORTED
Returns if the sensor supports a free selection of the area
of interest (AOI).
More details
pParam: Pointer to variable of type UINT indicating if
free AOI selection is supported:
0 = No free AOI supported
1 = Free AOI supported
nSizeOfParam: 4
pParam
Pointer to a function parameter, whose function depends
on nCommand.
269
268
268

THORLABS DCU223x Specifications

General

Brand	THORLABS
Model	DCU223x
Category	Security Camera
Language	English