You are here: Start » Filter Reference » Camera Support » Basler » Pylon_GrabImage
Captures an image stream from a camera using Pylon library.
|inDeviceID||String*||Serial number, model name, user defined name or full name of camera device to be opened|
|inOutputQueueSize||Integer||1 - 200||Capacity of output frames queue|
|inPixelFormat||PylonImageFormat*||Image pixel format|
|inFrameRate||Real*||0.1 - 400.0||Requested camera frame rate in frames per second|
|inAoi||Box*||Required fragment of image to stream. To reset AOI set Box(0,0,0,0).|
|inExposureTime||Real*||0.0 -||Camera frame exposition time|
|inGain||Real*||0.0 -||Analog gain of source image in device raw unit|
|inBlackLevel||Real*||0.0 -||Black level of source image|
|inTriggerEnabled||Bool*||Configure trigger enable|
|inTriggerSource||PylonTriggerSource*||Source of acquisition trigger|
|inTriggerActivation||PylonTriggerActivation*||Circumstances defining when the trigger is activated|
|outFrameID||Long||Captured frame ID|
|outTimestamp||Long||Captured frame timestamp|
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://www.baslerweb.com/ (registration may be required).
Recommended Pylon SDK version for Aurora Vision Studio usage is 7.1.
Other SDK versions from the same family (for example 7.1.1) can be compatible with Aurora Vision Studio but correct operation is not guaranteed.
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.
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.
- IEEE 1394 Camera Devices - The value of block ID is always -1.
- GigE Camera Devices - The sequence number starts with 1 and wraps at 65535. The value 0 has a special meaning and indicates that this feature is not supported by the camera.
- USB Camera Devices - The sequence number starts with 0 and uses the full 64 Bit range.
A block ID of value -1 indicates that the Block ID is invalid and must not be used.
In case of GigE-Vision this describes when the image exposure was started. Cameras that do not support this feature return zero. If supported this may be used to determine which ROIs were acquired simultaneously.
In case of FireWire this value describes the cycle time when the first packet arrives.
This filter is available on Basic Complexity Level.
This filter is member of Pylon_GrabImage filter group.
- Pylon_GrabImage_WithTimeout – Captures an image stream from a camera using Pylon library; returns Nil if no frame comes in the specified time.
- Pylon_StartAcquisition – Initializes and starts image acquisition in a camera.