Spinnaker_GrabImage_WithTimeout


Captures images from a Flir camera using Spinnaker interface; returns Nil if no frame comes in the specified time.

Syntax

C++
Python
 
def Spinnaker_GrabImage_WithTimeout(
	state: Spinnaker_State,
	/,
	*,
	inDeviceSerialNumber: str | None = None,
	inTimeout: int = 100,
	inBufferCount: int | None = 10,
	inPixelFormat: SpinnakerPixelFormat | None = None,
	inBayerConverter: SpinnakerBayerConverter = SpinnakerBayerConverter.AVLConverter,
	inExposureAuto: SpinnakerAutoSettings | None = None,
	inExposureTime: float | None = None,
	inFrameRateEnable: bool | None = None,
	inFrameRate: float | None = None,
	inGainAuto: SpinnakerAutoSettings | None = None,
	inGain: float | None = None
)
-> (
	outResult: bool,
	outImage: Image | None,
	outFrameID: int | None,
	outTimestamp: int | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState Spinnaker_State
Input value inDeviceSerialNumber str | None None Source device serial number
Input value inTimeout int 10 - 100 Maximum time to wait for frame in milliseconds
Input value inBufferCount int | None 1 - 10 Number of image buffers
Input value inPixelFormat SpinnakerPixelFormat | None None Image pixel format
Input value inBayerConverter SpinnakerBayerConverter SpinnakerBayerConverter.AVLConverter Image bayer converter. Used only with Bayer pixel format
Input value inExposureAuto SpinnakerAutoSettings | None None Sets the automatic exposure mode
Input value inExposureTime float | None 6.0D - None Exposure time in microseconds
Input value inFrameRateEnable bool | None None If enabled, inFrameRate can be used to manually control the frame rate
Input value inFrameRate float | None 1.0D - None Frame rate in Hertz
Input value inGainAuto SpinnakerAutoSettings | None None Sets the automatic gain mode
Input value inGain float | None 0.0D - None Controls the amplification of the video signal in dB
Output value outImage Image | None Captured frame
Output value outFrameID int | None Captured frame ID
Output value outTimestamp int | None 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.