Is_Setpixelclock - THORLABS DCU223x Operation Manual And Sdk

DCx Cameras

4.5.46 is_SetPixelClock

USB 2.0
Syntax
INT is_SetPixelClock (HIDS hCam, INT Clock)
Description
Attention
This function is obsolete and should not be used anymore. We recommend to use the
function instead (see also
is_SetPixelClock() sets the frequency used to read out image data from the sensor (pixel clock frequency).
Due to an excessive pixel clock for USB cameras, images may get lost during the transfer. If you change the pixel
clock on-the-fly, the current image capturing process will be aborted.
Note
Some sensors allow a higher pixel clock setting when if binning or subsampling is activated. If you set a higher
pixel clock and then reduce the binning/subsampling factors again, the driver will automatically select the highest
possible pixel clock for the new settings.
Attention
Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After
executing is_SetPixelClock(), calling the following functions is recommended in order to keep the defined
camera settings:
is_SetFrameRate()
is_Exposure()
216
If you are using the DCx Camera's flash function:
Input parameters
hCam
Clock
IS_GET_PIXEL_CLOCK
IS_GET_DEFAULT_PIXEL_CLK
IS_GET_PIXEL_CLOCK_INC
Return values
When used with
IS_GET_PIXEL_CLOCK
When used with
IS_GET_DEFAULT_PIXEL_CLK
IS_CANT_COMMUNICATE_WITH_DRIVER
IS_CANT_OPEN_DEVICE
IS_INVALID_CAMERA_TYPE
IS_INVALID_CAMERA_HANDLE
IS_INVALID_MODE
IS_INVALID_PARAMETER
IS_IO_REQUEST_FAILED
444
USB 2.0
Obsolete functions ).
379
329
is_IO()
280
Camera handle
Pixel clock frequency to be set (in MHz)
Returns the current pixel clock
Returns the default pixel clock
Returns the pixel clock increment
Current setting
Default setting
Communication with the driver failed because no driver
has been loaded.
An attempt to initialize or select the camera failed (no
camera connected or initialization error).
The camera type defined in the .ini file does not match
the current camera model.
Invalid camera handle
Camera is in standby mode, function not allowed
One of the submitted parameters is outside the valid
range or is not supported for this sensor or is not
available in this mode.
An IO request from the uc480 driver failed. Possibly the
versions of the uc480_api.dll (API) and the driver file
is_PixelClock()
© 2013 Thorlabs GmbH
294