Back to FabImage Library website

You are here: Start » Function Reference » Camera Support » Thorlabs » Thorlabs_GrabImage_WithTimeout

Thorlabs_GrabImage_WithTimeout


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Captures an image from a Thorlabs device.

Syntax

bool fil::Thorlabs_GrabImage_WithTimeout
(
	Thorlabs_State& ioState,
	ftl::Optional<const ftl::String&> inDeviceID,
	int inTimeout,
	ftl::Optional<int> inInputQueueSize,
	ftl::Optional<int> inExposureTime,
	ftl::Optional<int> inGain,
	ftl::Conditional<fil::Image>& outImage,
	int& outFrameID
)

Parameters

Name Type Range Default Description
Input will be modified
 ioState Thorlabs_State& Object used to maintain state of the function.
Input value
 inDeviceID Optional<const String&> NIL Camera serial number or name, Auto = first camera
Input value
 inTimeout int Maximum time to wait for frame in milliseconds
Input value
 inInputQueueSize Optional<int> 0 - NIL Sets size of image queue (on acquisition start, default = 8)
Input value
 inExposureTime Optional<int> 1 - 50000 Sets the target exposure time in microseconds
Input value
 inGain Optional<int> 0 - 1023 120 Sets gain
Output value
 outImage Conditional<Image>& Captured image
Output value
 outFrameID int& Captured frame ID

Remarks

Camera driver software

This filter is intended to cooperate with camera using its vendor Thorlabs SDK. To be able to connect to camera it is required to install Thorlabs SDK software with camera dedicated drivers. Currently FabImage Studio uses Thorlabs SDK version 2.9.1.

Thorlabs SDK can be downloaded from the following website: https://www.thorlabs.com/software_pages/ViewSoftwarePage.cfm?Code=ThorCam

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.

See Also