IDS peak 2.10.0 / uEye+ firmware 3.34
IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
Chunks are additional information transferred in the image payload, e.g. exposure time during image capture, image size, etc.The available chunks depend on the respective camera model. For example, ChunkPtpStatus is only supported by GigE Vision cameras. Chunks are organized in blocks, i.e. certain chunks are transferred together and thus cannot be enabled separately.
Chunk block |
Chunk name |
Type |
Refers to |
Name in ChunkSelector |
Description |
|---|---|---|---|---|---|
Auto features |
Enumeration |
Camera |
BalanceWhiteAutoStatus |
Status of the automatic white balance (BalanceWhiteAuto). |
|
Enumeration |
Camera |
BrightnessAutoStatus |
Status of the automatic exposure (ExposureAuto, GainAuto) |
||
Counter |
Enumeration |
Camera |
CounterStatus |
Status of the selected counter (CounterStatus). The counter is selected via ChunkCounterSelector. |
|
Integer |
Camera |
CounterValue |
Value of the selected counter (CounterValue). The counter is selected via ChunkCounterSelector. |
||
Exposure |
Float |
image |
ExposureTime |
Exposure time of the image (ExposureTime) |
|
“ExposureStart” trigger signal |
Integer |
Camera |
ExposureTriggerTimestamp |
Timestamp of the "ExposureStart" trigger signal |
|
Gain |
Float |
image |
Gain |
Image gain (Gain). The desired gain is selected via ChunkGainSelector. |
|
Image information |
Integer |
image |
Height |
Image height (Height) |
|
Integer |
image |
Width |
Image width (Width) |
||
Integer |
image |
OffsetX |
X position of the image (OffsetX) |
||
Integer |
image |
OffsetY |
Y position of the image (OffsetY) |
||
Enumeration |
image |
PixelFormat |
Pixel format of the image (PixelFormat) |
||
PTP |
Enumeration |
Cameras |
PtpStatus |
Status of the PTP clock (PtpStatus) |
|
Sequencer |
Integer |
image |
SequencerSetActive |
Sequencer set index which was used for image acquisition (SequencerSetActive). |
|
Timestamp |
Integer |
image |
Timestamp |
Image timestamp |
|
Status of the line signals |
Integer |
Camera |
LineStatusAll |
Status of all available line signals at the time of the selected latch trigger event (LineStatusAll). The latch trigger event is selected by ChunkLatchTriggerSource. |
For more information, see ChunkDataControl.
Switching on chunks
You can activate chunks via the following nodes:
genericC++ |
|---|
// Activate chunk data in the payload of the image |
|
•By activating chunks, the required memory size for each buffer changes and thus the PayloadSize (see Preparing image acquisition: create buffer). This means the buffers have to be created or recreated afterwards. •If chunks are activated, the access to the properties of the buffer object (Width, Height etc.) is not possible. Alternatively, you can use the corresponding camera nodes in this case. Note, however, that these nodes always display the current settings and not exactly the settings of a previously captured image (frame). |
Querying if a buffer has chunks
genericC++ |
|---|
bool hasChunks = imageBuffer->HasChunks(); |
Entering the chunk values of the image into the XML tree
If a buffer has chunks, then the values can be automatically entered by IDS peak into the XML tree and are available there via the corresponding nodes.
genericC++ |
|---|
nodeMapRemoteDevice->UpdateChunkNodes(imageBuffer); |
Querying a chunk value from the XML tree (e.g. ExposureTime)
genericC++ |
|---|
auto chunkValue = nodemapRemoteDevice->FindNode<peak::core::nodes::FloatNode>("ChunkExposureTime")->Value(); |
Complete example
