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.
Enables the inclusion of the selected chunk data in the payload of the image.
|
With ChunkSelector and ChunkEnable you can control which information should be included in the chunk data. To activate chunk data, you must set ChunkModeActive to "True". |
Name |
ChunkEnable[ChunkSelector] |
Category |
|
Interface |
Boolean |
Access |
Read/Write |
Unit |
- |
Visibility |
Expert |
Values |
True |
Standard |
SFNC |
Availability uEye+ |
|
Availability uEye |
- |
Values description
•True: Enables the selected chunk.
•False: Disables the selected chunk.
|
•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). |
Code example
C++
// For using ChunkEnable set ChunkModeActive to false
// Set ChunkModeActive to false
nodeMapRemoteDevice->FindNode<peak::core::nodes::BooleanNode>("ChunkModeActive")->SetValue(false);
// Before accessing ChunkEnable, make sure ChunkSelector is set correctly
// Set ChunkSelector to "ExposureTriggerTimestamp"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("ChunkSelector")->SetCurrentEntry("ExposureTriggerTimestamp");
// Determine the current status of ChunkEnable
bool value = nodeMapRemoteDevice->FindNode<peak::core::nodes::BooleanNode>("ChunkEnable")->Value();
// Set ChunkEnable to true
nodeMapRemoteDevice->FindNode<peak::core::nodes::BooleanNode>("ChunkEnable")->SetValue(true);
C#
// For using ChunkEnable set ChunkModeActive to false
// Set ChunkModeActive to false
nodeMapRemoteDevice.FindNode<peak.core.nodes.BooleanNode>("ChunkModeActive").SetValue(false);
// Before accessing ChunkEnable, make sure ChunkSelector is set correctly
// Set ChunkSelector to "ExposureTriggerTimestamp"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("ChunkSelector").SetCurrentEntry("ExposureTriggerTimestamp");
// Determine the current status of ChunkEnable
bool value = nodeMapRemoteDevice.FindNode<peak.core.nodes.BooleanNode>("ChunkEnable").Value();
// Set ChunkEnable to true
nodeMapRemoteDevice.FindNode<peak.core.nodes.BooleanNode>("ChunkEnable").SetValue(true);
Python
# For using ChunkEnable set ChunkModeActive to false
# Set ChunkModeActive to false (bool)
nodeMapRemoteDevice.FindNode("ChunkModeActive").SetValue(False)
# Before accessing ChunkEnable, make sure ChunkSelector is set correctly
# Set ChunkSelector to "ExposureTriggerTimestamp" (str)
nodeMapRemoteDevice.FindNode("ChunkSelector").SetCurrentEntry("ExposureTriggerTimestamp")
# Determine the current status of ChunkEnable (bool)
value = nodeMapRemoteDevice.FindNode("ChunkEnable").Value()
# Set ChunkEnable to true (bool)
nodeMapRemoteDevice.FindNode("ChunkEnable").SetValue(True)
