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. |
Enabling chunk mode
You must enable chunk mode to transfer additional image information:
ChunkModeActive = True;
If you have enabled chunk mode, all data blocks for which ChunkEnable is enabled are transferred as additional image information together with the image.
Defining the time of chunk creation
Use ChunkLatchTriggerSource to define the time at which the data for the chunks is collected.
ChunkLatchTriggerSource = ExposureStart;
Selecting chunks
Use ChunkSelector to select the additional image information you need, e.g.
ChunkSelector = PixelFormat;
ChunkEnable = True;
pixelformat = ChunkPixelFormat.Entry;
If you query information for certain chunks, it is necessary to specify additional properties. For example, to get the gain for "DigitalRed" in ChunkGain, you must select the value via ChunkGainSelector.
ChunkModeActive = True;
ChunkSelector = Gain;
ChunkEnable = True;
ChunkGainSelector = DigitalRed;
digitalred = ChunkGain.Entry;
Additional information
Camera operation |
•Image brightness (Exposure, Gain) |
---|---|
Camera feature reference |
|
IDS peak topics |