IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
Horizontal offset in pixels from the origin to the ROI (region of interest). OffsetX can only be greater than "0" if Width < WidthMax.
This information can be output as a chunk via the ChunkSelector. |
Name |
OffsetX |
Category |
|
Interface |
Integer |
Access |
Read/Write |
Unit |
px |
Visibility |
Beginner |
Values |
≥ 0 |
Standard |
SFNC |
Availability uEye+ |
|
Availability uEye |
|
Depending on the camera model the access might change to read-only during an acquisition. |
Can only be changed if SequencerMode is "Off". |
Note for uEye cameras (UI models) From IDS peak 2.8 on, fast moving of the ROI is used automatically if the camera model supports this feature and HotpixelCorrectionMode = "Off". The image acquisition is not stopped when the ROI is moved fast. This means that further images with the old ROI position can be transferred after command call if they are still in the buffer. |
Code example
C++
// For using OffsetX set Width to 600
// Set Width to 600
nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("Width")->SetValue(600);
// Determine the current OffsetX
int64_t value = nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("OffsetX")->Value();
// Set OffsetX to 100
nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("OffsetX")->SetValue(100);
C#
// For using OffsetX set Width to 600
// Set Width to 600
nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("Width").SetValue(600);
// Determine the current OffsetX
long value = nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("OffsetX").Value();
// Set OffsetX to 100
nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("OffsetX").SetValue(100);
Python
# For using OffsetX set Width to 600
# Set Width to 600 (int)
nodeMapRemoteDevice.FindNode("Width").SetValue(600)
# Determine the current OffsetX (int)
value = nodeMapRemoteDevice.FindNode("OffsetX").Value()
# Set OffsetX to 100 (int)
nodeMapRemoteDevice.FindNode("OffsetX").SetValue(100)