is_SetOptimalCameraTiming

USB 2.0

USB 3.0

GigE

–

Syntax

INT is_SetOptimalCameraTiming (HIDS hCam, INT Mode, INT Timeout,
INT* pMaxPxlClk, double* pMaxFrameRate)

Description

Using is_SetOptimalCameraTiming(), you can determine the highest possible pixel clock frequency for the current configuration. This function sets the pixel clock for which no transfer errors will occur during the Timeout period. Moreover, it returns the highest frame rate available for this pixel clock frequency.

is_SetOptimalCameraTiming() can only be executed in free-run mode (is_CaptureVideo()). If the return value is ≠ IS_SUCCESS, no clock setting will be made.

Achtung

The function should be executed in a separate thread and run in the background to allow for the computational load caused by additional color conversions, etc. Otherwise, it will not able to return the optimum values.

Achtung

Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing is_SetOptimalCameraTiming(), calling the following functions is recommended in order to keep the defined camera settings:

•is_SetFrameRate()

•is_Exposure()

•If you are using the uEye's flash function: is_IO()

Achtung

When you are using a USB uEye XS camera model, the pixel clock is selected automatically based on the resolution. You cannot change this setting. You can query the pixel clock, however, by using is_PixelClock().

Input parameters

hCam

Camera handle

IS_BEST_PCLK_RUN_ONCE

The function makes one attempt to determine the optimum pixel clock and returns immediately.

Timeout
[4000...20000]

Sets the period (in milliseconds) during which no transfer error may occur. The adjustable range is between 4 and 20 seconds. The higher the value you set for this parameter, the more stable the determined pixel clock value will be. This, in turn, increases the runtime of the function correspondingly.

pMaxPxlClk

Returns the maximum pixel clock frequency (in MHz).

pMaxFrameRate

Returns the maximum frame rate (in fps).

Return values

IS_AUTO_EXPOSURE_RUNNING	This setting cannot be changed while automatic exposure time control is enabled.
IS_INVALID_IMAGE_SIZE	Invalid image size This value is returned if e.g. the function is called with active binning or subsampling
IS_INVALID_MODE	Camera is in standby mode, function not allowed
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_NOT_SUPPORTED	The camera model used here does not support this function or setting.
IS_TRIGGER_ACTIVATED	The function cannot be used because the camera is waiting for a trigger signal.

Related functions

•is_PixelClock()

•is_SetFrameRate()

•is_SetAutoParameter()

•is_CaptureVideo()

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.

Home > C: Programming > Function descriptions >	History back Previous chapter Next chapter Print
is_SetOptimalCameraTiming