IDS peak 2.8.0 / uEye+ firmware 3.33

Zoom window out
Larger text | Smaller text
Hide page header
Show expanding text
Print topic
Send mail feedback
Copy topic URL

Navigation: C: Programming with IDS peak > How to program

Chunks (metadata)

Chunks are additional information transferred together with the image (e.g. exposure time during image acquisition, size of the image, etc.

Information	Selector	Chunk name	Type
Exposure time	ExposureTime	ChunkExposureTime	Float
Image width	Width	ChunkWidth	Integer
Image height	Height	ChunkHeight	Integer
Pixel format	PixelFormat	ChunkPixelFormat	Enumeration
Gain	Gain	ChunkGain	Float
Status of the automatic exposure	BrightnessAutoStatus	ChunkBrightnessAutoStatus	Enumeration
Status of the automatic white balance	BalanceWhiteAutoStatus	ChunkBalanceWhiteAutoStatus	Enumeration
X position	OffsetX	ChunkOffsetX	Integer
Y position	OffsetY	ChunkOffsetY	Integer
Timestamp	Timestamp	ChunkTimestamp	Integer
Timestamp for the start of the exposure	ExposureTriggerTimestamp	ChunkExposureTriggerTimestamp	Integer
Status of all available line signals	LineStatusAll	ChunkLineStatusAll	Integer
Value of the counter	CounterValue	ChunkCounterValue	Integer
Status of the counter	CounterStatus	ChunkCounterStatus	Enumeration
Index of the sequencer set if sequencer mode is active	SequencerSetActive	ChunkSequencerSetActive	Integer
Status of the PTP clock	PtpStatus	ChunkPtpStatus	Enumeration

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 nodemapRemoteDevice->FindNode<peak::core::nodes::BooleanNode>("ChunkModeActive")->SetValue(true); // Enable exposure time chunk nodemapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("ChunkSelector")->SetCurrentEntry("ExposureTime"); nodemapRemoteDevice->FindNode<peak::core::nodes::BooleanNode>("ChunkEnable")->SetValue(true);

hint_info

•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

Please enable JavaScript to view this site.

IDS peak 2.8.0 / uEye+ firmware 3.33