FlyCapture_GrabImage


Captures images from a Flir camera.

Syntax

C++
Python
 
def FlyCapture_GrabImage(
	state: FlyCapture_State,
	outImage: Image,
	/,
	*,
	inDeviceSerialNumber: int | None = None,
	inAoi: Box | None = None,
	inShutter: float | None = None,
	inGain: float | None = None,
	inExposure: float | None = None,
	inFrameRate: float | None = None,
	inTriggerMode: FlirTriggerMode = FlirTriggerMode.TriggerOff,
	inColorMode: FlirColorMode = FlirColorMode.Color
)
-> outResult: bool

Parameters

Name Type Range Default Description
Input will be modified ioState FlyCapture_State
Input value inDeviceSerialNumber int | None None Source device serial number
Input value inAoi Box | None None Required fragment of image to stream
Input value inShutter float | None 0.0 - None Shutter time
Input value inGain float | None 0.0 - None Image analog gain value
Input value inExposure float | None None Exposure time
Input value inFrameRate float | None 0.1 - None Requested camera frame rate
Input value inTriggerMode FlirTriggerMode FlirTriggerMode.TriggerOff Camera trigger mode and source control
Input value inColorMode FlirColorMode FlirColorMode.Color Requested grayscale or color mode of output image
Output value outImage Image Output image

Multithreaded environment

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