BitFlow_GrabImage


Captures a frame using BitFlow frame grabber.

Syntax

C++
Python
 
def BitFlow_GrabImage(
	state: BitFlow_BaseState,
	inBoardNumber: int,
	inCameraFileName: str,
	outImage: Image,
	/,
	*,
	inInputQueueSize: int = 4,
	inTriggerMode: BitFlowTriggerMode = BitFlowTriggerMode.CiTrigFreeRun,
	inTriggerAssignments: BitFlowTrigAssignments = BitFlowTrigAssignments.Off,
	inTriggerAPolarity: BitFlowTrigPolarity = BitFlowTrigPolarity.Off,
	inTriggerBPolarity: BitFlowTrigPolarity = BitFlowTrigPolarity.Off
)
-> (
	outResult: bool,
	outFrameID: int
)

Parameters

Name Type Range Default Description
Input will be modified ioState BitFlow_BaseState
Input value inBoardNumber int Index of board
Input value inCameraFileName str Camera file
Input value inInputQueueSize int 1 - 200 4 Number of incoming frames that can be buffered before the application is able to process them
Input value inTriggerMode BitFlowTriggerMode BitFlowTriggerMode.CiTrigFreeRun Trigger mode of the current camera
Input value inTriggerAssignments BitFlowTrigAssignments BitFlowTrigAssignments.Off Assign trigger to acquisition engine
Input value inTriggerAPolarity BitFlowTrigPolarity BitFlowTrigPolarity.Off Polarity for trigger B
Input value inTriggerBPolarity BitFlowTrigPolarity BitFlowTrigPolarity.Off Polarity for trigger A
Output value outImage Image Captured frame
Output value outFrameID int Captured frame ID

Multithreaded environment

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