Spinnaker_GrabImage


Captures images from a Flir camera using Spinnaker interface.

Syntax

C++
Python
 
def Spinnaker_GrabImage(
	state: Spinnaker_State,
	outImage: Image,
	/,
	*,
	inDeviceSerialNumber: str | None = None,
	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,
	outFrameID: int,
	outTimestamp: int
)

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 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 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.