Pylon_GrabImage


Captures an image stream from a camera using Pylon library.

Syntax

C++
Python
 
def Pylon_GrabImage(
	state: Pylon_State,
	outImage: Image,
	/,
	*,
	inDeviceID: str | None = None,
	inOutputQueueSize: int = 3,
	inPixelFormat: PylonImageFormat | None = None,
	inFrameRate: float | None = None,
	inAoi: Box | None = None,
	inExposureTime: float | None = None,
	inGain: float | None = None,
	inBlackLevel: float | None = None,
	inTriggerEnabled: bool | None = None,
	inTriggerSource: PylonTriggerSource | None = None,
	inTriggerActivation: PylonTriggerActivation | None = None
)
-> (
	outResult: bool,
	outFrameID: int,
	outTimestamp: int
)

Parameters

Name Type Range Default Description
Input will be modified ioState Pylon_State
Input value inDeviceID str | None None Serial number, model name, user defined name or full name of camera device to be opened
Input value inOutputQueueSize int 1 - 200 3 Capacity of output frames queue
Input value inPixelFormat PylonImageFormat | None None Image pixel format
Input value inFrameRate float | None 0.1 - 400.0 None Requested camera frame rate in frames per second
Input value inAoi Box | None None Required fragment of image to stream. To reset AOI set Box(0,0,0,0).
Input value inExposureTime float | None 0.0 - None Camera frame exposition time
Input value inGain float | None 0.0 - None Analog gain of source image in device raw unit
Input value inBlackLevel float | None 0.0 - None Black level of source image
Input value inTriggerEnabled bool | None None Configure trigger enable
Input value inTriggerSource PylonTriggerSource | None None Source of acquisition trigger
Input value inTriggerActivation PylonTriggerActivation | None None Circumstances defining when the trigger is activated
Output value outImage Image Captured frame
Output value outFrameID int Captured frame ID
Output value outTimestamp int Captured frame timestamp

Multithreaded environment

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