Vision Engine

Selects the vision engine used to compute the point cloud.

For guidance on choosing these settings, see Vision Engine.

C++

class Engine

Set the Zivid Vision Engine to use.

The Phase Engine is the fastest choice in terms of both acquisition time and total capture time, and is a good compromise between quality and speed. The Phase Engine is recommended for objects that are diffuse, opaque, and slightly specular, and is suitable for applications in logistics such as parcel induction.

The Stripe Engine is built for exceptional point cloud quality in scenes with highly specular reflective objects. This makes the engine suitable for applications such as factory automation, manufacturing, and bin picking. Additional acquisition and processing time are required for the Stripe Engine.

The Omni Engine is built for exceptional point cloud quality on all scenes, including scenes with extremely specular reflective objects, as well as transparent objects. This makes the Omni Engine suitable for applications such as piece picking. Same as for the Stripe Engine, it trades off speed for quality. The Omni Engine is only available for Zivid 2+ and Zivid 2+R.

The Sage engine is built for use cases that require all points to be correct/accurate with particularly high confidence. This can be very suitable for eliminating problems such as reflection artifacts. This validation comes at the cost of speed, and sometimes reduced number of valid points due to the removal of low-confidence data. The Sage Engine is only available for Zivid 2+R.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator phase

enumerator stripe

enumerator omni

enumerator sage

Public Functions

Engine() = default: Default constructor.

inline explicit constexpr Engine(ValueType value): Constructor.

ValueType value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Engine &other) const: Comparison operator.

inline bool operator!=(const Engine &other) const: Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues(): All valid values of Engine.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Engine"}: The full path for this value.

static constexpr const char *name = {"Engine"}: The name of this value.

static constexpr const char * description = { R"description(Set the Zivid Vision Engineto use.The PhaseEngineis the fastest choice in terms of both acquisition time and total capturetime, and is a good compromise between quality and speed. The PhaseEngineis recommended forobjects that are diffuse, opaque, and slightly specular, and is suitable for applications inlogistics such as parcel induction.The StripeEngineis built for exceptional point cloud quality in scenes with highly specularreflective objects. This makes theenginesuitable for applications such as factory automation,manufacturing, and bin picking. Additional acquisition andprocessingtime are required forthe Stripe Engine.The OmniEngineis built for exceptional point cloud quality on all scenes, including sceneswith extremely specular reflective objects, as well as transparent objects. This makes the OmniEngine suitable for applications such as piece picking. Same as for the Stripe Engine, it tradesoff speed for quality. The OmniEngineis only available for Zivid 2+ and Zivid 2+R.The Sageengineis built for use cases that require all points to be correct/accurate withparticularly high confidence. This can be very suitable for eliminating problems such asreflection artifacts. This validation comes at the cost of speed, and sometimes reduced numberof valid points due to the removal of low-confidence data. The SageEngineis only availablefor Zivid 2+R.)description" }: The description for this value.

static const Engine phase: phase

static const Engine stripe: stripe

static const Engine omni: omni

static const Engine sage: sage

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Engine::ValueType &value): Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Engine &value): Operator to serialize the value to a stream.

C#

struct EngineCppWrapperType

Python

class Engine: Set the Zivid Vision Engine to use. The Phase Engine is the fastest choice in terms of both acquisition time and total capture time, and is a good compromise between quality and speed. The Phase Engine is recommended for objects that are diffuse, opaque, and slightly specular, and is suitable for applications in logistics such as parcel induction. The Stripe Engine is built for exceptional point cloud quality in scenes with highly specular reflective objects. This makes the engine suitable for applications such as factory automation, manufacturing, and bin picking. Additional acquisition and processing time are required for the Stripe Engine. The Omni Engine is built for exceptional point cloud quality on all scenes, including scenes with extremely specular reflective objects, as well as transparent objects. This makes the Omni Engine suitable for applications such as piece picking. Same as for the Stripe Engine, it trades off speed for quality. The Omni Engine is only available for Zivid 2+ and Zivid 2+R. The Sage engine is built for use cases that require all points to be correct/accurate with particularly high confidence. This can be very suitable for eliminating problems such as reflection artifacts. This validation comes at the cost of speed, and sometimes reduced number of valid points due to the removal of low-confidence data. The Sage Engine is only available for Zivid 2+R.