Back to Aurora Vision Studio website

You are here: Start » Filter Reference » GigE Vision » GigEVision_StartAcquisition

GigEVision_StartAcquisition


Module: Genicam

Initializes and starts image acquisition in a device.

Applications

Typically used for establishing camera connectivity before the first trigger event. Especially important for multiple-camera systems.
Name Type Range Description
Input value inAddress GevAddress GigE Vision Device identifying address (IP, MAC or Serial Number)
Input value inPixelFormat GevPixelFormat Requested Pixel Format in GenICam pixel naming convention
Input value inInputQueueSize Integer 1 - 400 Number of incoming frames that can be buffered before the application is able to process them

Description

This filter is intended for establishing connection with a GigE Vision® compliant, single stream video transmitter and to initialize image streaming. It is only needed when explicit image acquisition start is required in the initial phase of a program or when explicitly stopping and starting the image acquisition during a program lifetime. For example, it can be used to prepare a camera, running in a triggered mode, to be able to capture trigger signals before the first invoke of GigEVision_GrabImage or to start multiple cameras in sync before the acquisition phase.

The use of this filter is not obligatory. GigEVision_GrabImage or GigEVision_GrabImage_WithTimeout filters will initialize and start image acquisition upon their first invoke. When this filter is used, the inPixelFormat and inInputQueueSize parameters of subsequent GigEVision_GrabImage and GigEVision_GrabImage_WithTimeout filters has no effect.

This filter has no effect when invoked for the second time and when invoked after image grabbing filters unless acquisition has been explicitly stopped using GigEVision_StopAcquisition.

Device address (inAddress port) is a textual definition of either IP, MAC or serial number. Use Device Manager (click "..." button in filter properties) to select appropriate address of connected device. For information on address type meaning and selecting device address see Device manager section in user manual.

This filter will interpret the value of inAddress port only during the first iteration of its parent Task, when the connection to the device is established. During the next iterations the filter will use previously established connection and subsequent changes in the device address will be ignored.

Pixel format is a textual name of image pixel (color) format. The format name must correspond to one of the format names supported by the connected device or an error will be raised at program runtime. Use the Device Manager (click the "..." button in Filter Properties) to select a format name from the list of formats supported by the connected device. For information on selecting pixel formats see the Device manager section in the User Manual.

For general information about working with GigE Vision devices, please refer to the following article.

To learn more about camera acquisition thread works please go to this article.

Hints

  • Use this filter BEFORE the main task (the main loop) of your application.
  • Interactively select a camera available in your network by defining the inAddress input.
  • Choose inPixelFormat from those supported by your camera.

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • Application Notes - set of documents about connecting devices or establishing communication with Aurora Vision Studio.