THORLABS DCC1 45 Series, Руководство пользователя

Страница: 264 / 420

259 SDK (Software development Kit)
© 2010 Thorlabs
7.3.88
is_SetFrameRate
USB 2.0 USB 2.0
Syntax
INT is_SetFrameRate (HIDS hCam, double FPS, double* newFPS)
Description
Using
is_SetFrameRate()
, you can set the sensor frame rate in freerun mode (live mode). Since
this value depends on the sensor timing, the exposure time actually used may slightly deviate from
the value set here. After you have called the function, the actual frame rate is returned through the
newFPS
parameter.
If the frame rate is set too high, it might not be possible to transfer every single frame. In this case,
the effective frame rate may vary from the set value.
For minimum and maximum frame rates as well as other sensor-based dependencies, please refer
to Specifications: Sensors
chapter.
The use of the following functions will affect the frame rate:
is_SetPixelClock()
is_SetOptimalCameraTiming()
is_SetAOI()
(if the image size is changed)
is_SetSubSampling()
is_SetBinning()
Changes made to the window size or the read-out timing (pixel clock frequency) also affect the
defined frame rate . For this reason, you need to call
is_SetFrameRate()
again after such
changes.
Newer driver versions sometimes allow an extended value range for the frame rate setting. We
recommend to query the value range every time and set the frame rate explicitly.
Changes to the frame rate affect the value ranges of the exposure time. After executing
is_SetFrameRate
()
, calling the function is_SetExposureTime() is recommended in order to
keep the defined camera settings.
Input Parameters
hCam Camera handle
FPS Desired frame rate in frames per second (fps)
IS_GET_FRAMERATE Only returns the current frame rate in the
newFPS
parameter.
IS_GET_DEFAULT_FRAMERATE Returns the default frame rate.
newFPS Returns the frame rate actually set.
Return Values
IS_SUCCESS
Function executed successfully
IS_NO_SUCCESS
General error message
402
277
275
219
284
231
251