You are here: Start » Function Reference » Camera Support » STC » STC_GrabImage

STC_GrabImage

Header:	ThirdPartySdk.h
Namespace:	fil
Module:	ThirdParty

Captures a frame using an Omron device.

Syntax

bool fil::STC_GrabImage
(
	Omron_State& ioState,
	ftl::Optional<const ftl::String&> inDeviceID,
	int inInputQueueSize,
	ftl::Optional<fil::OmronPixelFormat::Type> inPixelFormat,
	ftl::Optional<const fil::Box&> inRoi,
	ftl::Optional<fil::OmronAcquisitionMode::Type> inAcquisitionMode,
	ftl::Optional<int> inAcquisitionFrameCount,
	ftl::Optional<double> inFrameRate,
	ftl::Optional<bool> inExposureAuto,
	ftl::Optional<double> inExposureTime,
	ftl::Optional<bool> inGainAuto,
	ftl::Optional<double> inGain,
	ftl::Optional<double> inGamma,
	ftl::Optional<double> inBlackLevel,
	ftl::Optional<bool> inTriggerEnable,
	ftl::Optional<fil::OmronTriggerSource::Type> inTriggerSource,
	ftl::Optional<fil::OmronTriggerActivation::Type> inTriggerActivation,
	ftl::Optional<double> inTriggerDelay,
	fil::Image& outImage,
	ftl::int64& outFrameID,
	ftl::int64& outTimestamp
)

Parameters

Name	Type	Range	Default	Description
ioState	Omron_State&			Object used to maintain state of the function.
inDeviceID	Optional<const String&>		NIL	Device identifying number
inInputQueueSize	int	1 - 200	4	Capacity of output frames queue
inPixelFormat	Optional<OmronPixelFormat::Type>		NIL	Format of the pixels provided by the device
inRoi	Optional<const Box&>		NIL	Region of interest
inAcquisitionMode	Optional<OmronAcquisitionMode::Type>		NIL	Acquisition mode of the device
inAcquisitionFrameCount	Optional<int>		NIL	Number of frames to acquire in MultiFrame Acquisition mode
inFrameRate	Optional<double>		NIL	Acquisition rate in Hertz at which the frames are captured
inExposureAuto	Optional<bool>		NIL	Enables or disables the automatic exposure time control
inExposureTime	Optional<double>		NIL	Exposure time in microseconds
inGainAuto	Optional<bool>		NIL	Enables or disables the automatic gain control
inGain	Optional<double>		NIL	Gain as an absolute physical value
inGamma	Optional<double>		NIL	Gamma correction of pixel intensity
inBlackLevel	Optional<double>		NIL	Black level as an absolute physical value
inTriggerEnable	Optional<bool>		NIL	Controls if the selected trigger is active
inTriggerSource	Optional<OmronTriggerSource::Type>		NIL	Source of the acquisition trigger
inTriggerActivation	Optional<OmronTriggerActivation::Type>		NIL	Activation mode of the trigger
inTriggerDelay	Optional<double>		NIL	Delay in microseconds to apply after the trigger reception before activating it
outImage	Image&			Captured frame
outFrameID	int64&			Captured frame ID
outTimestamp	int64&			Captured frame timestamp

Remarks

Camera driver software

This filter is intended to cooperate with a camera using its vendor SDK. To be able to connect to a camera, it is required to install Sentech SDK Package software with camera dedicated drivers.

Sentech SDK Package can be downloaded from the following website: https://sentech.co.jp/en/data/software/ (registration may be required).

Add DLL path to system environment variable may be required.

Recommended Sentech SDK Package version for FabImage Studio usage is 1.1.2 Update 3.

Camera identification

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

inDeviceID field can be used to pick one of multiple cameras connected to computer. DeviceID can be set to:

Serial Number - should be printed on the device housing.
Device ID - unique device identifier that can be viewed in StViewer utility.
Device User ID - user-programmable device identifier that can be set in StViewer utility.

Camera parameters

All parameters exposed by camera filters are optional, setting them to 'Auto' leaves related parameter unchanged in camera (device default or user set configuration).

To change other, more advanced camera parameters, use specific filters.