![]() |
![]() |
---|---|
USB 2.0 GigE |
USB 2.0 GigE |
Syntax
INT is_SetExposureTime (HIDS hCam, double EXP, double* newEXP)
Description
This function is obsolete and should not be used anymore. We recommend to use the is_Exposure() function instead. |
Using is_SetExposureTime(), you can set the exposure time (in milliseconds). Since this value depends on the sensor timing, the exposure time actually used may slightly deviate from the value set here. The actual exposure time is returned by the newEXP parameter.
In free-running mode (is_CaptureVideo()), any modification of the exposure time will only become effective when the next image but one is captured. In trigger mode (is_SetExternalTrigger()), the modification will be applied to the next image.
For minimum and maximum exposure times as well as other sensor-based dependencies, please refer to the "Camera and sensor data" chapter in the uEye manual.
Note on new driver versions Newer driver versions sometimes allow an extended value range for the exposure time setting. We recommend to query the value range every time and set the exposure time explicitly. |
Note on settings with influence on exposure time
The use of the following functions will affect the exposure time:
•is_PixelClock()
•is_SetOptimalCameraTiming()
•is_SetFrameRate() (if the new image duration is shorter that the exposure time)
•is_AOI() (if the image size is changed)
•is_SetSubSampling()
•is_SetBinning()
Changes made to the window size, the frame rate or the read-out timing (pixel clock frequency) also affect the defined exposure time. For this reason, you need to call is_SetExposureTime() again after such changes.
Note on exposure time increment
The increments for setting the exposure time (IS_GET_EXPOSURE_INCREMENT) depend on the sensor's current timing settings (pixel clock, frame rate). The smallest increment always corresponds to the duration of one pixel row, which is the time it takes the sensor to read out one pixel row.
Some sensors allow setting the exposure time with a finer increment (IS_GET_EXPOSURE_FINE_INCREMENT). This function is currently only supported by the sensors of the UI-124x/UI-324x/UI-524x and UI-125x/UI-325x/UI-525x models.
Note on rounding errors
When calculating a new exposure time based on the ..._INCREMENT parameter, please note that calculations with floating point values in the PC will always be subject to rounding errors. Therefore, an addition or subtraction of an n*INCREMENT value might not always produce the exact desired result. In this case, the uEye API rounds down the floating point value and sets the exposure time to the next lower value.
You can avoid this behavior by additionally adding or subtracting the value INCREMENT/2.f (half intervall) when calculating with n*INCREMENT. This ensures that the desired value will be set even after rounding.
Input parameters
hCam |
Camera handle |
EXP |
New desired exposure time For EXP=0.0, the exposure time is 1/frame rate. |
IS_GET_EXPOSURE_TIME |
Returns the current exposure time in the newEXP parameter. |
IS_GET_DEFAULT_EXPOSURE |
Returns the default exposure time. |
IS_SET_ENABLE_AUTO_SHUTTER |
Enables the auto exposure function (see also is_SetAutoParameter()). |
IS_GET_EXPOSURE_MIN_VALUE |
Returns the minimum available exposure time. |
IS_GET_EXPOSURE_MAX_VALUE |
Returns the maximum available exposure time. |
IS_GET_EXPOSURE_INCREMENT |
Returns the increment you can use to change the image exposure time. |
IS_GET_EXPOSURE_FINE_INCREMENT |
Returns a finer exposure time increment for some sensors. |
newEXP |
When setting a new exposure time via EXP: Returns the exposure time actually set (may deviate from desired exposure time) When passing other parameters via EXP: |
Return values
IS_SUCCESS |
Function executed successfully |
IS_NO_SUCCESS |
General error message |
IS_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
Related functions
•is_SetFrameRate()
•is_Exposure()
•is_PixelClock()
•is_SetOptimalCameraTiming()
•is_SetAutoParameter()