IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
Vertical offset in pixels from the origin to the ROI (region of interest). OffsetY can only be greater than "0" if Height < HeightMax.
This information can be output as a chunk via the ChunkSelector. |
Name |
OffsetY |
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 OffsetY set Height to 400
// Set Height to 400
nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("Height")->SetValue(400);
// Determine the current OffsetY
int64_t value = nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("OffsetY")->Value();
// Set OffsetY to 100
nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("OffsetY")->SetValue(100);
C#
// For using OffsetY set Height to 400
// Set Height to 400
nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("Height").SetValue(400);
// Determine the current OffsetY
long value = nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("OffsetY").Value();
// Set OffsetY to 100
nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("OffsetY").SetValue(100);
Python
# For using OffsetY set Height to 400
# Set Height to 400 (int)
nodeMapRemoteDevice.FindNode("Height").SetValue(400)
# Determine the current OffsetY (int)
value = nodeMapRemoteDevice.FindNode("OffsetY").Value()
# Set OffsetY to 100 (int)
nodeMapRemoteDevice.FindNode("OffsetY").SetValue(100)