Start » Filter Reference » Camera Support » STC » STC_GrabImage

STC_GrabImage


Module: ThirdParty

Captures a frame using an Omron device.

Name Type Range Description
Input value
inDeviceID String* Device identifying number
Input value
inInputQueueSize Integer 1 - 200 Capacity of output frames queue
Input value
inPixelFormat OmronPixelFormat* Format of the pixels provided by the device
Input value
inRoi Box* Region of interest
Input value
inAcquisitionMode OmronAcquisitionMode* Acquisition mode of the device
Input value
inAcquisitionFrameCount Integer* Number of frames to acquire in MultiFrame Acquisition mode
Input value
inFrameRate Double* Acquisition rate in Hertz at which the frames are captured
Input value
inExposureAuto Bool* Enables or disables the automatic exposure time control
Input value
inExposureTime Double* Exposure time in microseconds
Input value
inGainAuto Bool* Enables or disables the automatic gain control
Input value
inGain Double* Gain as an absolute physical value
Input value
inGamma Double* Gamma correction of pixel intensity
Input value
inBlackLevel Double* Black level as an absolute physical value
Input value
inTriggerEnable Bool* Controls if the selected trigger is active
Input value
inTriggerSource OmronTriggerSource* Source of the acquisition trigger
Input value
inTriggerActivation OmronTriggerActivation* Activation mode of the trigger
Input value
inTriggerDelay Double* Delay in microseconds to apply after the trigger reception before activating it
Output value
outImage Image Captured frame
Output value
outFrameID Long Captured frame ID
Output value
outTimestamp Long 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 Aurora Vision 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.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of STC_GrabImage filter group.

See Also