IDS peak 2.20.0 / uEye+ firmware 3.80

IDS Peak comfortSDK, genericSDK, AFL, ICL, and IPL developer manuals are external documents.
Please contact us if you need these manuals.

Specifies the unit used when transmitting (calibrated) distance data.

Values description

•Millimeter: Distance values are in millimeters.

Code example

C++

// Determine the current entry of Scan3dDistanceUnit
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("Scan3dDistanceUnit")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of Scan3dDistanceUnit
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("Scan3dDistanceUnit")->Entries();
std::vector<std::shared_ptr<peak::core::nodes::EnumerationEntryNode>> availableEntries;
for(const auto & entry : allEntries)
{
  if ((entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotAvailable)
          && (entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotImplemented))
  {
      availableEntries.emplace_back(entry);
  }
}
// Set Scan3dDistanceUnit to "Millimeter"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("Scan3dDistanceUnit")->SetCurrentEntry("Millimeter");

C#

// Determine the current entry of Scan3dDistanceUnit
string value = nodeMapRemoteDevice.FindNode<IDSImaging.Peak.API.Core.Nodes.EnumerationNode>("Scan3dDistanceUnit").CurrentEntry().SymbolicValue();
// Get a list of all available entries of Scan3dDistanceUnit
allEntries = nodeMapRemoteDevice.FindNode<IDSImaging.Peak.API.Core.Nodes.EnumerationNode>("Scan3dDistanceUnit").Entries();
List<string> availableEntries = new List<string>();
for(int i = 0; i < allEntries.Count(); ++i)
{
  if ((allEntries[i].AccessStatus() != IDSImaging.Peak.API.Core.Nodes.NodeAccessStatus.NotAvailable)
          && (allEntries[i].AccessStatus() != IDSImaging.Peak.API.Core.Nodes.NodeAccessStatus.NotImplemented))
  {
      availableEntries.Add(allEntries[i].SymbolicValue());
  }
}
// Set Scan3dDistanceUnit to "Millimeter"
nodeMapRemoteDevice.FindNode<IDSImaging.Peak.API.Core.Nodes.EnumerationNode>("Scan3dDistanceUnit").SetCurrentEntry("Millimeter");

Python

# Determine the current entry of Scan3dDistanceUnit (str)
value = nodeMapRemoteDevice.FindNode("Scan3dDistanceUnit").CurrentEntry().SymbolicValue()
# Get a list of all available entries of Scan3dDistanceUnit
allEntries = nodeMapRemoteDevice.FindNode("Scan3dDistanceUnit").Entries()
availableEntries = []
for entry in allEntries:
  if (entry.AccessStatus() != ids_peak.NodeAccessStatus_NotAvailable
          and entry.AccessStatus() != ids_peak.NodeAccessStatus_NotImplemented):
      availableEntries.append(entry.SymbolicValue())
 
# Set Scan3dDistanceUnit to "Millimeter" (str)
nodeMapRemoteDevice.FindNode("Scan3dDistanceUnit").SetCurrentEntry("Millimeter")