Is_Imageformat - THORLABS DCU223x Operation Manual And Sdk

4.3.59 is_ImageFormat

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
below.
269
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
nCommand
IMGFRMT_CMD_GET_LIST
IMGFRMT_CMD_GET_NUM_ENTRIES
IMGFRMT_CMD_SET_FORMAT
IMGFRMT_CMD_GET_ARBITRARY_AOI_SUPPORTED Returns if the sensor supports a free selection of the area
pParam
© 2013 Thorlabs GmbH
USB 2.0
USB 3.0
Camera handle
Returns a list of all image formats supported by the
sensor.
You can query the number of entries in the list with
IMGFRMT_CMD_GET_NUM_ENTRIES.
pParam: Pointer to list of type
nSizeOfParam: Size of the list
Size of (IMAGE_FORMAT_LIST + (number of list entries
- 1) *
Size of (IMAGE_FORMAT_INFO))
Returns the number of entries in the list.
pParam: Pointer to variable of type UINT returning the
number of list entries.
nSizeOfParam: 4
Sets the desired image format.
pParam: Pointer to variable of type UINT passing the
format ID
nSizeOfParam: 4
of interest (AOI).
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
Pointer to a function parameter, whose function depends
on nCommand.
More details
. The list must be preallocated as specified below.
268
More details
More details
of the desired image format.
268
More details
4 Programming (SDK)
table "Image formats"
IMAGE_FORMAT_LIST
267