You are here: Start » Filter Reference » Flir Spinnaker » Spinnaker_GrabImage_WithTimeout

Spinnaker_GrabImage_WithTimeout

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

Name	Type	Range	Description
inDeviceSerialNumber	String *		Source device serial number
inTimeout	Integer	10 -	Maximum time to wait for frame in milliseconds
inBufferCount	Integer *	1 -	Number of image buffers
inPixelFormat	SpinnakerPixelFormat *		Image pixel format
inBayerConverter	SpinnakerBayerConverter		Image bayer converter. Used only with Bayer pixel format
inExposureAuto	SpinnakerAutoSettings *		Sets the automatic exposure mode
inExposureTime	Double *		Exposure time in microseconds
inFrameRateEnable	Bool *		If enabled, inFrameRate can be used to manually control the frame rate
inFrameRate	Double *		Frame rate in Hertz
inGainAuto	SpinnakerAutoSettings *		Sets the automatic gain mode
inGain	Double *		Controls the amplification of the video signal in dB
outImage	Image ?		Captured frame
outFrameID	Long ?		Captured frame ID
outTimestamp	Long ?		Captured frame timestamp

Description

This filter is intended for establishing connection with general camera device using Spinnaker SDK, for streaming images out of it in continuous mode.

This filter will wait for next valid frame not more that selected timeout value (on inTimeout port) in milliseconds. After timeout occurs a Nil value is returned on outImage port instead of image.

Similarly to outImage, outputs outFrameID and outTimestamp will return Nil on timeout condition.

Remarks

Camera driver software

This filter is intended to cooperate with camera using its vendor Spinnaker SDK. To be able to connect to camera it is required to install Spinnaker SDK software with camera dedicated drivers. Currently Adaptive Vision Studio uses Spinnaker version v1.20.0.15.

Spinnaker SDK can be downloaded from the following website: https://www.flir.com/support/browse/camera-cores--components/machine-vision-cameras/sdks (registration may be required).

During installation you should select "Application Development". Visual Studio Version should be also changed to "Visual Studio 2015".

Camera identification

When there is only one camera connected to computer, inDeviceSerialNumber field can be set to Auto. In this situation first available camera will be found and connected.

inDeviceSerialNumber can be used to pick one of multiple cameras connected to computer. Set this field to device serial number (for example "1234567", should be available on device casing as "s/n: 1234567").

Camera parameters

Most of parameters exposed by camera filters are optional, setting them to 'Auto' leaves related parameters for default configuration by camera driver.

To change other and more advanced camera parameters use configuration tool "SpinView" available with Spinnaker SDK. Refer to SDK documentation to find information about parameters and how to save parameters into memory channels.

It is also possible to adjust more advanced parameters using Spinnaker_SetParameter filters. The parameters name should be obtained from SpinView application or from Spinnaker SDK.

Multithreaded environment

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

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of Spinnaker_GrabImage filter group.