Acquisition Applets for imaWorx CXP-12 Quad#
The functionality of a frame grabber is defined by a specific hardware-related program. This hardware implementation is called applet. For each frame grabber, several applets are available.
By loading an applet onto the frame grabber, you define the functionality of the frame grabber and adapt it to the requirements of your specific application.
The acquisition applets for imaWorx CXP-12 Quad are included in the Framegrabber SDK and also in the pylon Camera Software Suite.
On imaWorx CXP-12 Quad all delivered applets already are on the imaWorx CXP-12 Quad frame grabber, but only one is activated. If you want to activate a different applet on the imaWorx CXP-12 Quad, follow the instructions to Activate the Applet with the Framegrabber SDK or Configuring the Frame Grabber Using pylon.
Requirements#
- Host software: Framegrabber SDK (version 5.9 or higher) or pylon Camera Software Suite (version 6.3 or higher) with hardware-dependent acquisition applets
- Hardware: An imaWorx CXP-12 Quad frame grabber is connected to your system
Limitation
In all applets, buffers larger than 4GB can't be allocated. Even if the applet allows a larger buffer size, you can't allocate buffers larger than 4GB due to limitations in the driver and firmware.
You can calculate the buffer size as follows:
Buffer size = image height * image width * (pixel width / 8).
For RGB images: buffer size = (image height * image width * (pixel width / 8)) * 3 .
Documentation#
The following sections provide links to the acquisition applets documentation:
Area Acquisition Applets#
| GenTL | Fglib |
|---|---|
| Acq_SingleCXP12Area PDF | Acq_SingleCXP12Area PDF |
| Acq_DualCXP12Area PDF | Acq_DualCXP12Area PDF |
| Acq_TripleCXP12Area PDF | Acq_TripleCXP12Area PDF |
| Acq_QuadCXP12Area PDF | Acq_QuadCXP12Area PDF |
Line Acquisition Applets#
| GenTL | Fglib |
|---|---|
| Acq_SingleCXP12Line PDF | Acq_SingleCXP12Line PDF |
| Acq_DualCXP12Line PDF | Acq_DualCXP12Line PDF |
| Acq_TripleCXP12Line PDF | Acq_TripleCXP12Line PDF |
| Acq_QuadCXP12line PDF | Acq_QuadCXP12line PDF |
Frame Grabber Test Applet#
| GenTL | Fglib |
|---|---|
| Frame Grabber Test Applet PDF | Frame Grabber Test Applet PDF |
Area Scan Acquisition Applets#
The following Area Scan Acquisition Applets are available:
- Acq_SingleCXP12Area
- Acq_DualCXP12Area
- Acq_TripleCXP12Area
- Acq_QuadCXP12Area
The denominators "single", "dual", "triple", and "quad" in the name of the applet refer to the maximum number of cameras you can connect. For more information, see Choosing the Right Area Scan Acquisition Applet.
Choosing the Right Area Scan Acquisition Applet#
You must choose the right applet for your camera setup. Otherwise, the image received from the camera can't be processed or displayed correctly or camera performance may be reduced significantly.
Which applet is the right one depends on the number of cameras, the number of channels per camera, and the desired ROI step size.
The ROI step size depends on the parallelism of the image preprocessing and therefore varies by camera and frame grabber.
| Number of 1-Channel Cameras | Number of 2-Channel Cameras | Number of 4-Channel Cameras | Applet | ROI Step Size [px] | Topology |
|---|---|---|---|---|---|
| 1 | Acq_QuadCXP12Area | x: 8 y: 1 |  | ||
| 2 | Acq_QuadCXP12Area | x: 8 y: 1 |  | ||
| 3 | Acq_QuadCXP12Area | x: 8 y: 1 |  | ||
| 4 | Acq_QuadCXP12Area | x: 8 y: 1 |  | ||
| 1 | Acq_DualCXP12Area | x: 16 y: 1 |  | ||
| 2 | Acq_DualCXP12Area | x: 16 y: 1 |  | ||
| 1 | Acq_SingleCXP12Area | x: 32 y: 1 |  | ||
| 1 | 1 | Acq_TripleCXP12Area | x: 8 y: 1 |  | |
| 2 | 1 | Acq_TripleCXP12Area | x: 8 y: 1 |  |
Specifications Common to All Area Scan Acquisition Applets#
| Max. Image Size [px] | 32k x 64ka |
| Camera Ports | 4 |
| Camera Type | CXP-12 |
| Bit Depth Processing [bit] | 16 (14 for Bayer Demosaicing) |
| Bit Depth Output [bit] | Mono8-16 RGB8-16 RGBa8 BGR8-16 BGRa8 Bayer8-14 YUV422_8 |
| Mirroring | Yes, horizontal and vertical |
| Image Selector | Yes |
| Bayer Color Reconstruction (HQe) | Yes, High Quality Extended (HQe) |
| White Balance | Yes |
| LUT | Full resolution |
| Pixel Format Conversion | RGB or Bayer to mono, Bayer or mono to RGB |
| Bandwidth Total DMA [MB/s] b | 7200 |
Specifications Differing Between Area Scan Acquisition Applets#
| ROI Step Size [px] | Bandwidth: Mean per Camera [MP/s] | Tap Geometry Sorting | |
|---|---|---|---|
| Acq_SingleCXP12Area | x: 32 y: 1 | 4850 | 1X-1Y, 1X-2YE |
| Acq_DualCXP12Area | x: 16 y: 1 | 2400 | 1X-1Y, 1X-2YE |
| Acq_TripleCXP12Area | x: 8 y: 1 | 1200 for the first two cameras 2400 for the third camera | 1X-1Y only |
| Acq_QuadCXP12Area | x: 8 y: 1 | 1200 | 1X-1Y only |
Line Scan Acquisition Applets#
The following Line Scan Acquisition Applets are available:
- Acq_SingleCXP12Line
- Acq_DualCXP12Line
- Acq_TripleCXP12Line
- Acq_QuadCXP12Line
The denominators "single", "dual", "triple", and "quad" in the name of the applet refer to the maximum number of cameras you can connect. For more information, see Choosing the Right Line Scan Acquisition Applet.
Choosing the Right Line Scan Acquisition Applet#
You must choose the right applet for your camera setup. Otherwise, the camera may not work or camera performance may be reduced significantly.
Which applet is the right one depends on the number of cameras, the number of channels per camera, and the desired ROI step size.
The ROI step size depends on the parallelism of the image preprocessing and therefore varies by camera and frame grabber.
| Number of 1-Channel Cameras | Number of 2-Channel Cameras | Number of 4-Channel Cameras | Applet | ROI Step Size [px] | Topology |
|---|---|---|---|---|---|
| 1 | Acq_QuadCXP12Line | x: 4 y: 1 | | ||
| 2 | Acq_QuadCXP12Line | x: 4 y: 1 | | ||
| 3 | Acq_QuadCXP12Line | x: 4 y: 1 | | ||
| 4 | Acq_QuadCXP12Line | x: 4 y: 1 | | ||
| 1 | Acq_DualCXP12Line | x: 16 y: 1 | | ||
| 2 | Acq_DualCXP12Line | x: 16 y: 1 | | ||
| 1 | Acq_SingleCXP12Line | x: 32 y: 1 | | ||
| 1 | 1 | Acq_TripleCXP12Line | x: 16 y: 1 | | |
| 2 | 1 | Acq_TripleCXP12Line | x: 16 y: 1 | |
Specifications Common to All Line Scan Acquisition Applets#
| Max. Image Size [px] | 32k x 8Ma |
| Camera Ports | 4 |
| Camera Type | CXP-12 |
| Bit Depth Processing [bit] | 16 |
| Bit Depth Output [bit] | Mono8-16 RGB8-16 RGBa8 BGR8-16 BGRa8 Bayer8-14 YUV422_8 |
| Mirroring | Yes, horizontal and vertical |
| Tap Geometry Sorting | 1X-1Y only |
| Image Selector | Yes |
| Bayer Color (HQe) | No |
| White Balance | No |
| LUT | Full resolution |
| Pixel Format Conversion | RGB to mono, mono to RGB |
| Bandwidth: Total DMA [MB/s] b | 7200 |
Specifications Differing Between Line Scan Acquisition Applets#
| ROI Step Size [px] | Bandwidth: Mean per Camera [MP/s] | |
|---|---|---|
| Acq_SingleCXP12Line | x: 32 y: 1 | 4850 |
| Acq_DualCXP12Line | x: 16 y: 1 | 2400 |
| Acq_TripleCXP12Line | x: 16 y: 1 | 1200 for the first two cameras 2400 for the third camera |
| Acq_QuadCXP12Line | x: 4 y: 1 | 1200 |
Frame Grabber Test Applet#
This applet is a frame grabber test applet. Its purpose is to test the hardware.
The applet offers the following features:
| Feature | Explanation |
|---|---|
| DMA Performance Test | Tests different image dimensions for varying memory sizes and interrupt rates |
| RAM Test | Checks for errors and processing |
| Check Camera Port Image Acquisition | Checks camera port image acquisition |
| Send Trigger Signals to Camera | Sends trigger signals to camera |
| GPIO Monitoring | Monitors the GPIs and set the GPOs |
| Event Test | Generates a software callback event |
| General Monitoring | Monitors FPGA temperature, power management, PoCXP, etc. |
Using Acquisition Applets#
Using Acquisition Applets with the Framegrabber SDK#
Find here general information about using the applets with the Framegrabber SDK: Acquisition Applets.
Installing Applets#
Before you can use a specific applet on your frame grabber, you must install it on the frame grabber. Instructions for installing the applets are available at Managing Applets (microDiagnostics).
Adding an Applet Manually#
To add an applet you received as *.dll file (and not in form of an installer) to your host file system:
- Get the applet file (*.dll) you have received.
- Copy this file into the following directory: <Framegrabber SDK directory>/Dll/<Frame grabber model>
Now you can use the new applet.
Testing Image Acquisition#
Before you start using an applet in your own software (via API), you might want to test the system set-up or an individual applet (and its parametrization options).
For this purpose, you are provided with the tool microDisplay X that has been installed on your computer as part of the Framegrabber SDK environment. For instructions how to load and test your applet, see Configuring the Applet (microDisplay X).
Saving Applet Configuration#
After you have configured your applet (in microDisplay X or via Framegrabber API), you can save your configuration. For more information, see Other Tasks (microDisplay X).
Using Acquisition Applets with pylon#
If you want to use the applets with pylon, see Configuring the Frame Grabber Using pylon.
-
k Px and M Px in this case refer to a binary format. Examples for binary calculations are:
16M px = 16384k px = 16777216 px
8M px = 8192k px = 8388608 px
64k px = 65536 px
48k px = 49152 px
32k px = 32768 px
-
The actual DMA bandwidth depends on the specific mainboard and chip set of the host computer. ↩↩