Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Camera Support » Basler » Pylon_StartAcquisition

Pylon_StartAcquisition


Module: ThirdParty

Initializes and starts image acquisition in a camera.

Name Type Range Description
Input value inDeviceID String* Serial number, model name, user defined name or full name of camera device to be opened
Input value inOutputQueueSize Integer 1 - 200 Capacity of output frames queue
Input value inPixelFormat PylonImageFormat* Image pixel format
Input value inFrameRate Real* 0.1 - 400.0 Requested camera frame rate in frames per second
Input value inAoi Box* Required fragment of image to stream. To reset AOI set Box(0,0,0,0).
Input value inExposureTime Real* 0.0 - Camera frame exposition time
Input value inGain Real* 0.0 - Analog gain of source image in device raw unit
Input value inBlackLevel Real* 0.0 - Black level of source image
Input value inTriggerEnabled Bool* Configure trigger enable
Input value inTriggerSource PylonTriggerSource* Source of acquisition trigger
Input value inTriggerActivation PylonTriggerActivation* Circumstances defining when the trigger is activated

Remarks

This filter is intended for establishing connection with a Basler camera device using Pylon interface, to initialize image streaming. It is only needed when explicit image acquisition start is required in the initial phase of a program. For example, it can be used to prepare a camera, running in triggered mode, to be able to capture trigger signals before the first invoke of Pylon_GrabImage or to start multiple cameras in sync before the acquisition phase.

The use of this filter is not obligatory. Pylon_GrabImage or Pylon_GrabImage_WithTimeout] filters will initialize and start image acquisition upon their first invoke. When this filter is used, the inPixelFormat parameter of subsequent Pylon_GrabImage and Pylon_GrabImage_WithTimeout] filters has no effect.

This filter has no effect when invoked for the second time and when invoked after image grabbing filters.

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 Pylon SDK software with camera dedicated drivers.

Pylon SDK can be downloaded from the following website: https://www2.baslerweb.com/en/downloads/software-downloads/#type=pylonsoftware;language=all;version=7.4.0 (registration may be required).

Recommended Pylon SDK version for Aurora Vision Studio usage is 7.4.0.

Other SDK versions from the same family (for example 7.4.1) can be compatible with Aurora Vision Studio but correct operation is not guaranteed.

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 specified on device casing, for example "12345678".
  • User defined name - user defined device name.
  • Friendly name - human readable name of the device.
  • Device full name - full name identifying the device.
  • Model name - model name of the device.
  • Ip Address - camera IP address. Only for GigEVision cameras.
Camera parameters

Setting inAoi parameter to 'Auto' will select maximum possible camera frame size.

All the other 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 configuration tool "Pylon Viewer" available with Pylon SDK or Pylon_SetXXXParameter filters. Refer to Pylon documentation to find information about parameters and how to create user parameters sets.

Parallel execution

This filter cannot be placed in multiple Workers.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
RuntimeError Not implemented

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • Pylon_GrabImage – Captures an image stream from a camera using Pylon library.
  • Pylon_GrabImage_WithTimeout – Captures an image stream from a camera using Pylon library; returns Nil if no frame comes in the specified time.