Back to FabImage Library website

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

Thorlabs_ConfigureCamera


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Sets various camera's parameters before starting acquisition.

Syntax

void fil::Thorlabs_ConfigureCamera
(
	Thorlabs_State& ioState,
	ftl::Optional<const ftl::String&> inDeviceID,
	ftl::Optional<const fil::Box&> inRoi,
	int inXBin,
	int inYBin,
	fil::ThorlabsReadoutSpeed::Type inReadoutSpeed,
	fil::ThorlabsTaps::Type inTaps,
	bool inTapBalance
)

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
 inRoi Optional<const Box&> NIL Region of interest, Auto = full frame
Input value
 inXBin int 1 - 1 Horizontal binning factor
Input value
 inYBin int 1 - 1 Vertical binning factor
Input value
 inReadoutSpeed ThorlabsReadoutSpeed::Type Speed of camera's sensor readout clock
Input value
 inTaps ThorlabsTaps::Type Number of taps (simultaneous camera sensor readout operations per clock cycle)
Input value
 inTapBalance bool Whether internal tap balancing is enabled

Multithreaded environment

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