IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
The PixelFormat parameter controls the output bit depth and color format.
You find a full description about pixel formats and their data layout in Image color formats (PixelFormat).
The available pixel formats depend on:
•the type of your sensor (monochrome, color, ...)
•the max bit depth of the sensor
•the capabilities of your camera model
•the parameters like ReverseX, ReverxeY, etc.
Pixel formats, that are typically available as output format of the camera:
Type |
8 bit |
10 bit |
12 bit |
10 bit packed |
12 bit packed |
---|---|---|---|---|---|
Monochrome |
Mono8 |
Mono10 |
Mono12 |
Mono10p |
Mono12p |
RAW Bayer |
BayerRG8 BayerGR8 BayerBG8 BayerGB8 |
BayerRG10 BayerGR10 BayerBG10 BayerGB10 |
BayerRG12 BayerGR12 BayerBG12 BayerGB12 |
BayerRG10p BayerGR10p BayerBG10p BayerGB10p |
BayerRG12p BayerGR12p BayerBG12p BayerGB12p |
Color |
RGB8 BGR8 |
|
|
RGB10p32 BGR10p32 |
|
For color cameras: if you choose a PixelFormat of type "Mono" or "Color", the camera automatically enables on-board debayering. |
Configuration
PixelFormat = BayerRG8;
You can include the PixelFormat setting into your image chunks. This way, you know the exact capture parameters for each image, even if they change. See Enabling meta data (chunks). |
PixelFormat properties: Current entry
pixelFormat = PixelFormat.Entry;
PixelFormat properties: Pixel size
Returns the bits per pixel of the current PixelFormat.
bpp = PixelSize.Entry;
PixelFormat properties: Pixel color filter
Returns the color filter of the current PixelFormat.
colorFilter = PixelColorFilter.Entry;
Dependencies to other features: Bandwidth and frame rate
Choosing a PixelFormat with higher PixelSize (bits per pixel), can affect the frame rate range because it can influence the internal timing of the camera.
The PixelFormat has significant influence on DeviceLinkAcquisitionFrameRateLimit because the PixelSize (bits per pixel) can range between 8 bit up to 32 bit (from the camera), see the tables in Image color formats (PixelFormat). Images with same resolution and same frame rate can use up to 4x bandwidth, if you do not carefully choose the PixelFormat.
Dependencies to other features: ReverseX, ReverseY (mirror)
Using a RAW Bayer format in combination with mirror features of the camera (ReverseX, ReverseY) can affect the pixel order and thus the PixelFormat. E.g. a ReverseX mirror (left/right) transformation changes a BayerRG to a BayerGR format.
Fig. 105: Typical change of PixelFormat in combination with ReverseX, ReverseY mirror features
There are some sensors that do not change PixelFormat but rather shift the sensor ROI by one pixel to maintain the PixelFormat. |