uEye Camera Manual Version 4.92
 |
 |
UI-3013XC |
UI-3013XC |
Syntax
INT is_Focus (HIDS hCam, UINT nCommand, void *pParam, UINT nSizeOfParam)
Description
For the UI-3013XC, the zones of the focus measure window are static and cannot be moved or re-sized. With the zones, you define the image area to be focused for the camera. The settings of the focus measure window can only be used in snapshot mode. In live mode the camera always focuses on the image center.
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.
 |
According to the sensor manufacturer, there is no guarantee that a focal point set manually will lead to a reproducible focal distance. A focal value determined with one model will not necessarily result in the same focal point for a different model. |
Input parameters
hCam |
Camera handle |
||||||||
|
|||||||||
pParam |
Pointer to a function parameter, whose function depends on nCommand. |
||||||||
nSizeOfParam |
Size (in bytes) of the memory area to which pParam refers. |
||||||||
Return values
IS_CANT_COMMUNICATE_WITH_DRIVER |
Communication with the driver failed because no driver has been loaded. |
IS_CANT_OPEN_DEVICE |
An attempt to initialize or select the camera failed (no camera connected or initialization error). |
IS_INVALID_CAPTURE_MODE |
The function can not be executed in the current camera operating mode (free run, trigger or standby). |
IS_INVALID_CAMERA_HANDLE |
Invalid camera handle |
IS_INVALID_PARAMETER |
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. |
IS_IO_REQUEST_FAILED |
An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match. |
IS_NO_SUCCESS |
General error message |
IS_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
IS_SUCCESS |
Function executed successfully |
// Set preset
int nPreset = FOC_ZONE_AOI_PRESET_BOTTOM_LEFT;
is_Focus(hCam, FOC_CMD_SET_AUTOFOCUS_ZONE_AOI_PRESET, &nPreset, sizeof(nPreset));
// Query preset
int nPreset;
is_Focus(hCam, FOC_CMD_GET_AUTOFOCUS_ZONE_AOI_PRESET, &nPreset, sizeof(nPreset));
// Can the focus measure window freely defined?
int nSupported;
is_Focus(hCam, FOC_CMD_GET_AUTOFOCUS_ZONE_ARBITRARY_AOI_SUPPORTED, &nSupported, sizeof(nSupported));
if (nSupported == 1)
{
…
}
Suggestion for improvement? Send us your short
Feedback on this chapter.
Thank you very much!
For technical questions please contact your local distributor or use the support form on our website.
